mirror of
https://github.com/OpenTTD/OpenTTD
synced 2026-01-16 00:42:45 +01:00
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.
127 lines
4.0 KiB
C
127 lines
4.0 KiB
C
/* $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 command_func.h Functions related to commands. */
|
|
|
|
#ifndef COMMAND_FUNC_H
|
|
#define COMMAND_FUNC_H
|
|
|
|
#include "command_type.h"
|
|
#include "company_type.h"
|
|
|
|
/**
|
|
* Define a default return value for a failed command.
|
|
*
|
|
* This variable contains a CommandCost object with is declared as "failed".
|
|
* Other functions just need to return this error if there is an error,
|
|
* which doesn't need to specific by a StringID.
|
|
*/
|
|
static const CommandCost CMD_ERROR = CommandCost(INVALID_STRING_ID);
|
|
|
|
/**
|
|
* Returns from a function with a specific StringID as error.
|
|
*
|
|
* This macro is used to return from a function. The parameter contains the
|
|
* StringID which will be returned.
|
|
*
|
|
* @param errcode The StringID to return
|
|
*/
|
|
#define return_cmd_error(errcode) return CommandCost(errcode);
|
|
|
|
CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text = NULL);
|
|
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags);
|
|
|
|
bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback = NULL, const char *text = NULL, bool my_cmd = true);
|
|
bool DoCommandP(const CommandContainer *container, bool my_cmd = true);
|
|
|
|
CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only);
|
|
|
|
void NetworkSendCommand(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, CompanyID company);
|
|
|
|
extern Money _additional_cash_required;
|
|
|
|
bool IsValidCommand(uint32 cmd);
|
|
CommandFlags GetCommandFlags(uint32 cmd);
|
|
const char *GetCommandName(uint32 cmd);
|
|
Money GetAvailableMoneyForCommand();
|
|
bool IsCommandAllowedWhilePaused(uint32 cmd);
|
|
|
|
/**
|
|
* Extracts the DC flags needed for DoCommand from the flags returned by GetCommandFlags
|
|
* @param cmd_flags Flags from GetCommandFlags
|
|
* @return flags for DoCommand
|
|
*/
|
|
static inline DoCommandFlag CommandFlagsToDCFlags(CommandFlags cmd_flags)
|
|
{
|
|
DoCommandFlag flags = DC_NONE;
|
|
if (cmd_flags & CMD_NO_WATER) flags |= DC_NO_WATER;
|
|
if (cmd_flags & CMD_AUTO) flags |= DC_AUTO;
|
|
if (cmd_flags & CMD_ALL_TILES) flags |= DC_ALL_TILES;
|
|
return flags;
|
|
}
|
|
|
|
/*** All command callbacks that exist ***/
|
|
|
|
/* ai/ai_instance.cpp */
|
|
CommandCallback CcAI;
|
|
|
|
/* airport_gui.cpp */
|
|
CommandCallback CcBuildAirport;
|
|
|
|
/* bridge_gui.cpp */
|
|
CommandCallback CcBuildBridge;
|
|
|
|
/* dock_gui.cpp */
|
|
CommandCallback CcBuildDocks;
|
|
CommandCallback CcPlaySound_SPLAT_WATER;
|
|
|
|
/* depot_gui.cpp */
|
|
CommandCallback CcCloneVehicle;
|
|
|
|
/* game/game_instance.cpp */
|
|
CommandCallback CcGame;
|
|
|
|
/* group_gui.cpp */
|
|
CommandCallback CcCreateGroup;
|
|
CommandCallback CcAddVehicleNewGroup;
|
|
|
|
/* industry_gui.cpp */
|
|
CommandCallback CcBuildIndustry;
|
|
|
|
/* main_gui.cpp */
|
|
CommandCallback CcPlaySound_EXPLOSION;
|
|
CommandCallback CcPlaceSign;
|
|
CommandCallback CcTerraform;
|
|
CommandCallback CcGiveMoney;
|
|
|
|
/* rail_gui.cpp */
|
|
CommandCallback CcPlaySound_SPLAT_RAIL;
|
|
CommandCallback CcRailDepot;
|
|
CommandCallback CcStation;
|
|
CommandCallback CcBuildRailTunnel;
|
|
|
|
/* road_gui.cpp */
|
|
CommandCallback CcPlaySound_SPLAT_OTHER;
|
|
CommandCallback CcBuildRoadTunnel;
|
|
CommandCallback CcRoadDepot;
|
|
CommandCallback CcRoadStop;
|
|
|
|
/* train_gui.cpp */
|
|
CommandCallback CcBuildWagon;
|
|
|
|
/* town_gui.cpp */
|
|
CommandCallback CcFoundTown;
|
|
CommandCallback CcFoundRandomTown;
|
|
|
|
/* vehicle_gui.cpp */
|
|
CommandCallback CcBuildPrimaryVehicle;
|
|
CommandCallback CcStartStopVehicle;
|
|
|
|
#endif /* COMMAND_FUNC_H */
|