OpenTTD-patches/src/newgrf_sound.h

/* $Id$ */

/** @file newgrf_sound.h Functions related to NewGRF provided sounds. */

#ifndef NEWGRF_SOUND_H
#define NEWGRF_SOUND_H

#include "sound_type.h"
#include "tile_type.h"

enum VehicleSoundEvent {
	VSE_START        = 1,
	VSE_TUNNEL       = 2,
	VSE_BREAKDOWN    = 3,
	VSE_RUNNING      = 4,
	VSE_TOUCHDOWN    = 5,
	VSE_TRAIN_EFFECT = 6,
	VSE_RUNNING_16   = 7,
	VSE_STOPPED_16   = 8,
	VSE_LOAD_UNLOAD  = 9,
};


SoundEntry *AllocateSound();
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);

#endif /* NEWGRF_SOUND_H */
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00			`/* $Id$ */`

(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description. 2008-05-06 15:11:33 +00:00			`/** @file newgrf_sound.h Functions related to NewGRF provided sounds. */`
(svn r9385) -Cleanup: doxygen changes. Today, we are exploring the letter N. 2007-03-21 03:06:21 +00:00
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00			`#ifndef NEWGRF_SOUND_H`
			`#define NEWGRF_SOUND_H`

(svn r11719) -Codechange: split sound.h in a header with types and one with functions. 2007-12-29 09:24:26 +00:00			`#include "sound_type.h"`
(svn r12495) -Codechange: reduce the dependency on newgrf_station.h (especially because newgrf_station.h includes a lot of stuff). 2008-03-31 06:42:26 +00:00			`#include "tile_type.h"`
(svn r11719) -Codechange: split sound.h in a header with types and one with functions. 2007-12-29 09:24:26 +00:00
(svn r9051) -Codechange: typedef [enum\|struct] Y {} X; -> [enum\|struct] X {}; 2007-03-07 12:11:48 +00:00			`enum VehicleSoundEvent {`
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00			`VSE_START = 1,`
			`VSE_TUNNEL = 2,`
			`VSE_BREAKDOWN = 3,`
			`VSE_RUNNING = 4,`
			`VSE_TOUCHDOWN = 5,`
			`VSE_TRAIN_EFFECT = 6,`
			`VSE_RUNNING_16 = 7,`
			`VSE_STOPPED_16 = 8,`
			`VSE_LOAD_UNLOAD = 9,`
(svn r9051) -Codechange: typedef [enum\|struct] Y {} X; -> [enum\|struct] X {}; 2007-03-07 12:11:48 +00:00			`};`
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00

(svn r16344) -Codechange: s/FileEntry/SoundEntry/ 2009-05-17 19:27:50 +00:00			`SoundEntry *AllocateSound();`
(svn r9050) -Codechange: Foo(void) -> Foo() 2007-03-07 11:47:46 +00:00			`void InitializeSoundPool();`
(svn r16344) -Codechange: s/FileEntry/SoundEntry/ 2009-05-17 19:27:50 +00:00			`SoundEntry *GetSound(SoundID sound_id);`
(svn r9050) -Codechange: Foo(void) -> Foo() 2007-03-07 11:47:46 +00:00			`uint GetNumSounds();`
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00			`bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event);`
(svn r16340) -Codechange: introduce SoundID (uint16) and use that instead of SoundFX, which was used as a byte and uint16 at different places, when the uint16 sound ID is meant. 2009-05-17 17:17:48 +00:00			`bool PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile);`
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported. 2006-09-27 18:17:01 +00:00
			`#endif /* NEWGRF_SOUND_H */`