summaryrefslogtreecommitdiff
path: root/src/command_func.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-01-18 22:17:15 +0000
committerrubidium <rubidium@openttd.org>2011-01-18 22:17:15 +0000
commit6c9078fd30097b38537a60fbecb9828da69c3517 (patch)
tree6601ea8e21edd22b54d054d94cd9c129f8162458 /src/command_func.h
parentd89095b3ecb9c326e169db33294efac9b818276a (diff)
downloadopenttd-6c9078fd30097b38537a60fbecb9828da69c3517.tar.xz
(svn r21844) -Codechange: move documentation towards the code to make it more likely to be updates [a-c].
Diffstat (limited to 'src/command_func.h')
-rw-r--r--src/command_func.h23
1 files changed, 0 insertions, 23 deletions
diff --git a/src/command_func.h b/src/command_func.h
index 212e71ddf..c741c7924 100644
--- a/src/command_func.h
+++ b/src/command_func.h
@@ -34,47 +34,24 @@ static const CommandCost CMD_ERROR = CommandCost(INVALID_STRING_ID);
*/
#define return_cmd_error(errcode) return CommandCost(errcode);
-/**
- * Execute a command
- */
CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text = NULL);
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags);
-/**
- * Execute a network safe DoCommand function
- */
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);
-/** Internal helper function for DoCommandP. Do not use. */
CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only);
#ifdef ENABLE_NETWORK
-/**
- * Send a command over the network
- */
void NetworkSendCommand(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, CompanyID company);
#endif /* ENABLE_NETWORK */
extern Money _additional_cash_required;
-/**
- * Checks if a integer value belongs to a command.
- */
bool IsValidCommand(uint32 cmd);
-/**
- * Returns the flags from a given command.
- */
byte GetCommandFlags(uint32 cmd);
-/**
- * Returns the name of a given command.
- */
const char *GetCommandName(uint32 cmd);
-/**
- * Returns the current money available which can be used for a command.
- */
Money GetAvailableMoneyForCommand();
-
bool IsCommandAllowedWhilePaused(uint32 cmd);
/**