src/newgrf_sound.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file newgrf_sound.h Functions related to NewGRF provided sounds. */
  11
  12 #ifndef NEWGRF_SOUND_H
  13 #define NEWGRF_SOUND_H
  14
  15 #include "sound_type.h"
  16 #include "tile_type.h"
  17 #include "vehicle_type.h"
  18
  19 /** Events at which a sound might be played. */
  20 enum VehicleSoundEvent {
  21         VSE_START         = 1, ///< Vehicle starting, i.e. leaving, the station.
  22         VSE_TUNNEL        = 2, ///< Train entering a tunnel.
  23         VSE_BREAKDOWN     = 3, ///< Vehicle breaking down.
  24         VSE_RUNNING       = 4, ///< Vehicle running normally.
  25         VSE_TOUCHDOWN     = 5, ///< Whenever a plane touches down.
  26         VSE_VISUAL_EFFECT = 6, ///< Vehicle visual effect (steam, diesel smoke or electric spark) is shown.
  27         VSE_RUNNING_16    = 7, ///< Every 16 ticks while the vehicle is running (speed > 0).
  28         VSE_STOPPED_16    = 8, ///< Every 16 ticks while the vehicle is stopped (speed == 0).
  29         VSE_LOAD_UNLOAD   = 9, ///< Whenever cargo payment is made for a vehicle.
  30 };
  31
  32
  33 SoundEntry *AllocateSound(uint num);
  34 void InitializeSoundPool();
  35 bool LoadNewGRFSound(SoundEntry *sound);
  36 SoundID GetNewGRFSoundID(const struct GRFFile *file, SoundID sound_id);
  37 SoundEntry *GetSound(SoundID sound_id);
  38 uint GetNumSounds();
  39 bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event);
  40 void PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile);
  41
  42 #endif /* NEWGRF_SOUND_H */