From 246568bbffcd63838dc2e448e2e750ef4965dfb9 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 23 Mar 2014 21:56:48 +0000 Subject: (svn r26425) -Doc: SoundFx enum --- src/sound_type.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src') diff --git a/src/sound_type.h b/src/sound_type.h index 799c7a887..72486dcac 100644 --- a/src/sound_type.h +++ b/src/sound_type.h @@ -24,6 +24,18 @@ struct SoundEntry { byte grf_container_ver; ///< NewGRF container version if the sound is from a NewGRF. }; +/** + * Sound effects from baseset. + * + * This enum contains the sound effects from the sound baseset. + * For hysterical raisins the order of sound effects in the baseset + * is different to the order they are referenced in TTD/NewGRF. + * - The first two sound effects from the baseset are inserted at position 39. + * (see translation table _sound_idx) + * - The order in the enum is the order using in TTD/NewGRF. + * - The naming of the enum values includes the position in the baseset. + * That is, for sound effects 0x02 to 0x28 the naming is off-by-two. + */ enum SoundFx { SND_BEGIN = 0, SND_02_SPLAT_WATER = 0, ///< Water construction. -- cgit v1.2.3-70-g09d2