1 /* 2 * This file is part of OpenTTD. 3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2. 4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>. 6 */ 7 8 /** @file newgrf_sound.h Functions related to NewGRF provided sounds. */ 9 10 #ifndef NEWGRF_SOUND_H 11 #define NEWGRF_SOUND_H 12 13 #include "sound_type.h" 14 #include "tile_type.h" 15 #include "vehicle_type.h" 16 17 /** Events at which a sound might be played. */ 18 enum VehicleSoundEvent { 19 VSE_START = 1, ///< Vehicle starting, i.e. leaving, the station. 20 VSE_TUNNEL = 2, ///< Train entering a tunnel. 21 VSE_BREAKDOWN = 3, ///< Vehicle breaking down. 22 VSE_RUNNING = 4, ///< Vehicle running normally. 23 VSE_TOUCHDOWN = 5, ///< Whenever a plane touches down. 24 VSE_VISUAL_EFFECT = 6, ///< Vehicle visual effect (steam, diesel smoke or electric spark) is shown. 25 VSE_RUNNING_16 = 7, ///< Every 16 ticks while the vehicle is running (speed > 0). 26 VSE_STOPPED_16 = 8, ///< Every 16 ticks while the vehicle is stopped (speed == 0). 27 VSE_LOAD_UNLOAD = 9, ///< Whenever cargo payment is made for a vehicle. 28 }; 29 30 31 SoundEntry *AllocateSound(uint num); 32 void InitializeSoundPool(); 33 bool LoadNewGRFSound(SoundEntry *sound); 34 SoundID GetNewGRFSoundID(const struct GRFFile *file, SoundID sound_id); 35 SoundEntry *GetSound(SoundID sound_id); 36 uint GetNumSounds(); 37 bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event); 38 void PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile); 39 40 #endif /* NEWGRF_SOUND_H */ 41