newgrf_sound.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NEWGRF_SOUND_H
#define NEWGRF_SOUND_H
 
#include "sound_type.h"
#include "tile_type.h"
#include "vehicle_type.h"
 
enum VehicleSoundEvent {
  VSE_START         = 1, 
  VSE_TUNNEL        = 2, 
  VSE_BREAKDOWN     = 3, 
  VSE_RUNNING       = 4, 
  VSE_TOUCHDOWN     = 5, 
  VSE_VISUAL_EFFECT = 6, 
  VSE_RUNNING_16    = 7, 
  VSE_STOPPED_16    = 8, 
  VSE_LOAD_UNLOAD   = 9, 
};
 
 
SoundEntry *AllocateSound(uint num);
void InitializeSoundPool();
bool LoadNewGRFSound(SoundEntry &sound, SoundID sound_id);
SoundID GetNewGRFSoundID(const struct GRFFile *file, SoundID sound_id);
SoundEntry *GetSound(SoundID sound_id);
uint GetNumSounds();
size_t GetSoundPoolAllocatedMemory();
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event, bool force  = false);
void PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile);
 
#endif /* NEWGRF_SOUND_H */