mirrors
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

(svn r22615) -Codechange: The return value of PlayTileSound() has no purpose. Remove it and document the rest.

This commit is contained in:
frosch 2011-07-02 11:28:22 +00:00
parent ff52f85b9e
commit 4e5534f85e
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/newgrf_sound.cpp
View File

@ -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;
}

2
src/newgrf_sound.h
View File

@ -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 */