OpenTTD
command_func.h
Go to the documentation of this file.
1 /* $Id: command_func.h 27571 2016-05-22 10:07:48Z frosch $ */
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 
12 #ifndef COMMAND_FUNC_H
13 #define COMMAND_FUNC_H
14 
15 #include "command_type.h"
16 #include "company_type.h"
17 
26 
35 #define return_cmd_error(errcode) return CommandCost(errcode);
36 
37 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text = NULL);
38 CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags);
39 
40 bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback = NULL, const char *text = NULL, bool my_cmd = true);
41 bool DoCommandP(const CommandContainer *container, bool my_cmd = true);
42 
43 CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only);
44 
45 #ifdef ENABLE_NETWORK
46 void NetworkSendCommand(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, CompanyID company);
47 #endif /* ENABLE_NETWORK */
48 
49 extern Money _additional_cash_required;
50 
51 bool IsValidCommand(uint32 cmd);
52 CommandFlags GetCommandFlags(uint32 cmd);
53 const char *GetCommandName(uint32 cmd);
55 bool IsCommandAllowedWhilePaused(uint32 cmd);
56 
63 {
64  DoCommandFlag flags = DC_NONE;
65  if (cmd_flags & CMD_NO_WATER) flags |= DC_NO_WATER;
66  if (cmd_flags & CMD_AUTO) flags |= DC_AUTO;
67  if (cmd_flags & CMD_ALL_TILES) flags |= DC_ALL_TILES;
68  return flags;
69 }
70 
71 /*** All command callbacks that exist ***/
72 
73 /* ai/ai_instance.cpp */
75 
76 /* airport_gui.cpp */
77 CommandCallback CcBuildAirport;
78 
79 /* bridge_gui.cpp */
81 
82 /* dock_gui.cpp */
83 CommandCallback CcBuildDocks;
84 CommandCallback CcPlaySound_SPLAT_WATER;
85 
86 /* depot_gui.cpp */
88 
89 /* game/game_instance.cpp */
91 
92 /* group_gui.cpp */
95 
96 /* industry_gui.cpp */
98 
99 /* main_gui.cpp */
100 CommandCallback CcPlaySound_EXPLOSION;
102 CommandCallback CcTerraform;
103 CommandCallback CcGiveMoney;
104 
105 /* rail_gui.cpp */
106 CommandCallback CcPlaySound_SPLAT_RAIL;
107 CommandCallback CcRailDepot;
108 CommandCallback CcStation;
110 
111 /* road_gui.cpp */
112 CommandCallback CcPlaySound_SPLAT_OTHER;
114 CommandCallback CcRoadDepot;
116 
117 /* train_gui.cpp */
119 
120 /* town_gui.cpp */
121 CommandCallback CcFoundTown;
122 CommandCallback CcFoundRandomTown;
123 
124 /* vehicle_gui.cpp */
127 
128 #endif /* COMMAND_FUNC_H */
void CcPlaceSign(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Callback function that is called after a sign is placed.
Definition: signs_cmd.cpp:118
don&#39;t allow building on structures
Definition: command_type.h:343
set the DC_NO_WATER flag on this command
Definition: command_type.h:391
void NetworkSendCommand(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, CompanyID company)
Prepare a DoCommand to be send over the network.
void CcGame(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
DoCommand callback function for all commands executed by Game Scripts.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:25
void CcCreateGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Opens a &#39;Rename group&#39; window for newly created group.
Definition: group_gui.cpp:987
set the DC_AUTO flag on this command
Definition: command_type.h:388
no flag is set
Definition: command_type.h:341
CommandFlags
Command flags for the command table _command_proc_table.
Definition: command_type.h:384
bool IsCommandAllowedWhilePaused(uint32 cmd)
Returns whether the command is allowed while the game is paused.
Definition: command.cpp:405
void CcRoadStop(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Command callback for building road stops.
Definition: road_gui.cpp:199
Common return value for all commands.
Definition: command_type.h:25
Types related to commands.
void CcAI(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
DoCommand callback function for all commands executed by AIs.
void CcBuildWagon(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Callback for building wagons.
Definition: train_gui.cpp:31
void CcCloneVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
This is the Callback method after the cloning attempt of a vehicle.
Definition: depot_gui.cpp:121
bool IsValidCommand(uint32 cmd)
Definition: command.cpp:365
void CcBuildRoadTunnel(const CommandCost &result, TileIndex start_tile, uint32 p1, uint32 p2)
Callback executed after a build road tunnel command has been called.
Definition: road_gui.cpp:96
Structure for buffering the build command when selecting a station to join.
Definition: command_type.h:472
DoCommandFlag
List of flags for a command.
Definition: command_type.h:340
void CcBuildIndustry(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Command callback.
don&#39;t allow building on water
Definition: command_type.h:345
static DoCommandFlag CommandFlagsToDCFlags(CommandFlags cmd_flags)
Extracts the DC flags needed for DoCommand from the flags returned by GetCommandFlags.
Definition: command_func.h:62
allow this command also on MP_VOID tiles
Definition: command_type.h:351
Money GetAvailableMoneyForCommand()
Definition: command.cpp:514
void CcBuildBridge(const CommandCost &result, TileIndex end_tile, uint32 p1, uint32 p2)
Callback executed after a build Bridge CMD has been called.
Definition: bridge_gui.cpp:61
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
void CcBuildPrimaryVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
This is the Callback method after the construction attempt of a primary vehicle.
bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback=NULL, const char *text=NULL, bool my_cmd=true)
Definition: command.cpp:547
CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text=NULL)
Definition: command.cpp:454
void CcStartStopVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
This is the Callback method after attempting to start/stop a vehicle.
Types related to companies.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
void CommandCallback(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Define a callback function for the client, after the command is finished.
Definition: command_type.h:467
void CcAddVehicleNewGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Open rename window after adding a vehicle to a new group via drag and drop.
Definition: group_gui.cpp:1003
void CcBuildRailTunnel(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
Command callback for building a tunnel.
Definition: rail_gui.cpp:275
Owner
Enum for all companies/owners.
Definition: company_type.h:20
CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only)
Definition: command.cpp:623
const char * GetCommandName(uint32 cmd)
Definition: command.cpp:393
allow this command also on MP_VOID tiles
Definition: command_type.h:389
CommandFlags GetCommandFlags(uint32 cmd)
Definition: command.cpp:379