Files
@ r23483:3733e6b8ff17
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_sound.h - annotation
r23483:3733e6b8ff17
1.9 KiB
text/x-c
Remove: ENABLE_NETWORK switch
This switch has been a pain for years. Often disabling broke
compilation, as no developer compiles OpenTTD without, neither do
any of our official binaries.
Additionaly, it has grown so hugely in our codebase, that it
clearly shows that the current solution was a poor one. 350+
instances of "#ifdef ENABLE_NETWORK" were in the code, of which
only ~30 in the networking code itself. The rest were all around
the code to do the right thing, from GUI to NewGRF.
A more proper solution would be to stub all the functions, and
make sure the rest of the code can simply assume network is
available. This was also partially done, and most variables were
correct if networking was disabled. Despite that, often the #ifdefs
were still used.
With the recent removal of DOS, there is also no platform anymore
which we support where networking isn't working out-of-the-box.
All in all, it is time to remove the ENABLE_NETWORK switch. No
replacement is planned, but if you feel we really need this option,
we welcome any Pull Request which implements this in a way that
doesn't crawl through the code like this diff shows we used to.
This switch has been a pain for years. Often disabling broke
compilation, as no developer compiles OpenTTD without, neither do
any of our official binaries.
Additionaly, it has grown so hugely in our codebase, that it
clearly shows that the current solution was a poor one. 350+
instances of "#ifdef ENABLE_NETWORK" were in the code, of which
only ~30 in the networking code itself. The rest were all around
the code to do the right thing, from GUI to NewGRF.
A more proper solution would be to stub all the functions, and
make sure the rest of the code can simply assume network is
available. This was also partially done, and most variables were
correct if networking was disabled. Despite that, often the #ifdefs
were still used.
With the recent removal of DOS, there is also no platform anymore
which we support where networking isn't working out-of-the-box.
All in all, it is time to remove the ENABLE_NETWORK switch. No
replacement is planned, but if you feel we really need this option,
we welcome any Pull Request which implements this in a way that
doesn't crawl through the code like this diff shows we used to.
r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6348:a905c3e6d8fa r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r8157:cf41aa22cd09 r8787:4e60a460f8ef r14248:a9050881acd7 r8157:cf41aa22cd09 r16495:bcf8d2e54445 r6248:b940b09d7ab8 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r16495:bcf8d2e54445 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r19164:fb28ade150af r6247:96e840dbefcc r19015:cc992f00083d r22317:3ed40f22eff9 r11936:9ec1ad99161c r6247:96e840dbefcc r5475:3f5cd13d1b63 r17814:499b13bfc1b6 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 | /* $Id$ */
/*
* 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/>.
*/
/** @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"
#include "vehicle_type.h"
/** Events at which a sound might be played. */
enum VehicleSoundEvent {
VSE_START = 1, ///< Vehicle starting, i.e. leaving, the station.
VSE_TUNNEL = 2, ///< Train entering a tunnel.
VSE_BREAKDOWN = 3, ///< Vehicle breaking down.
VSE_RUNNING = 4, ///< Vehicle running normally.
VSE_TOUCHDOWN = 5, ///< Whenever a plane touches down.
VSE_VISUAL_EFFECT = 6, ///< Vehicle visual effect (steam, diesel smoke or electric spark) is shown.
VSE_RUNNING_16 = 7, ///< Every 16 ticks while the vehicle is running (speed > 0).
VSE_STOPPED_16 = 8, ///< Every 16 ticks while the vehicle is stopped (speed == 0).
VSE_LOAD_UNLOAD = 9, ///< Whenever cargo payment is made for a vehicle.
};
SoundEntry *AllocateSound(uint num);
void InitializeSoundPool();
bool LoadNewGRFSound(SoundEntry *sound);
SoundID GetNewGRFSoundID(const struct GRFFile *file, SoundID sound_id);
SoundEntry *GetSound(SoundID sound_id);
uint GetNumSounds();
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event);
void PlayTileSound(const struct GRFFile *file, SoundID sound_id, TileIndex tile);
#endif /* NEWGRF_SOUND_H */
|