Changeset - r17814:499b13bfc1b6
[Not reviewed]
master
0 2 0
frosch - 13 years ago 2011-07-02 11:28:22
frosch@openttd.org
(svn r22615) -Codechange: The return value of PlayTileSound() has no purpose. Remove it and document the rest.
2 files changed with 9 insertions and 4 deletions:
0 comments (0 inline, 0 general)
src/newgrf_sound.cpp
Show inline comments
 
@@ -86,15 +86,20 @@ bool PlayVehicleSound(const Vehicle *v, 
 
	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;
 
}
src/newgrf_sound.h
Show inline comments
 
@@ -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 */
0 comments (0 inline, 0 general)