OpenTTD Source  20241108-master-g80f628063a
signs_cmd.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef SIGNS_CMD_H
11 #define SIGNS_CMD_H
12 
13 #include "command_type.h"
14 #include "signs_type.h"
15 
16 std::tuple<CommandCost, SignID> CmdPlaceSign(DoCommandFlag flags, TileIndex tile, const std::string &text);
17 CommandCost CmdRenameSign(DoCommandFlag flags, SignID sign_id, const std::string &text);
18 
19 DEF_CMD_TRAIT(CMD_PLACE_SIGN, CmdPlaceSign, CMD_DEITY, CMDT_OTHER_MANAGEMENT)
20 DEF_CMD_TRAIT(CMD_RENAME_SIGN, CmdRenameSign, CMD_DEITY, CMDT_OTHER_MANAGEMENT)
21 
22 void CcPlaceSign(Commands cmd, const CommandCost &result, SignID new_sign);
23 
24 #endif /* SIGNS_CMD_H */
CommandCost
Common return value for all commands.
Definition: command_type.h:23
command_type.h
Types related to commands.
CMDT_OTHER_MANAGEMENT
@ CMDT_OTHER_MANAGEMENT
Renaming stuff, changing company colours, placing signs, etc.
Definition: command_type.h:419
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:374
Commands
Commands
List of commands.
Definition: command_type.h:187
CMD_PLACE_SIGN
@ CMD_PLACE_SIGN
place a sign
Definition: command_type.h:271
CMD_RENAME_SIGN
@ CMD_RENAME_SIGN
rename a sign
Definition: command_type.h:272
CMD_DEITY
@ CMD_DEITY
the command may be executed by COMPANY_DEITY
Definition: command_type.h:405
CmdPlaceSign
std::tuple< CommandCost, SignID > CmdPlaceSign(DoCommandFlag flags, TileIndex tile, const std::string &text)
Place a sign at the given coordinates.
Definition: signs_cmd.cpp:35
CcPlaceSign
void CcPlaceSign(Commands cmd, const CommandCost &result, SignID new_sign)
Callback function that is called after a sign is placed.
Definition: signs_cmd.cpp:108
CmdRenameSign
CommandCost CmdRenameSign(DoCommandFlag flags, SignID sign_id, const std::string &text)
Rename a sign.
Definition: signs_cmd.cpp:72
signs_type.h
Types related to signs.
SignID
uint16_t SignID
The type of the IDs of signs.
Definition: signs_type.h:14