From 1c0926693299925a83896a96b903fad90170456c Mon Sep 17 00:00:00 2001 From: frosch Date: Sat, 2 Jul 2011 11:28:22 +0000 Subject: [PATCH] (svn r22615) -Codechange: The return value of PlayTileSound() has no purpose. Remove it and document the rest. --- src/newgrf_sound.cpp | 11 ++++++++--- src/newgrf_sound.h | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/src/newgrf_sound.cpp b/src/newgrf_sound.cpp index e5ab65d90b..6151f4cb33 100644 --- a/src/newgrf_sound.cpp +++ b/src/newgrf_sound.cpp @@ -86,15 +86,20 @@ bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event) return true; } -bool PlayTileSound(const GRFFile *file, SoundID sound_id, TileIndex tile) +/** + * Play a NewGRF sound effect at the location of a specfic tile. + * @param file NewGRF triggering the sound effect. + * @param sound_id Sound effect the NewGRF wants to play. + * @param tile Location of the effect. + */ +void PlayTileSound(const GRFFile *file, SoundID sound_id, TileIndex tile) { if (sound_id >= ORIGINAL_SAMPLE_COUNT) { sound_id -= ORIGINAL_SAMPLE_COUNT; - if (sound_id > file->num_sounds) return false; + if (sound_id > file->num_sounds) return; sound_id += file->sound_offset; } assert(sound_id < GetNumSounds()); SndPlayTileFx(sound_id, tile); - return true; } diff --git a/src/newgrf_sound.h b/src/newgrf_sound.h index 0219951ed5..2f2c034db4 100644 --- a/src/newgrf_sound.h +++ b/src/newgrf_sound.h @@ -35,6 +35,6 @@ void InitializeSoundPool(); SoundEntry *GetSound(SoundID sound_id); uint GetNumSounds(); bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event); -bool PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile); +void PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile); #endif /* NEWGRF_SOUND_H */