OpenTTD Source: src/misc_cmd.cpp File Reference

OpenTTD Source 1.11.0-RC1

Functions
misc_cmd.cpp File Reference
`#include "stdafx.h"`
`#include "command_func.h"`
`#include "economy_func.h"`
`#include "cmd_helper.h"`
`#include "window_func.h"`
`#include "textbuf_gui.h"`
`#include "network/network.h"`
`#include "network/network_func.h"`
`#include "strings_func.h"`
`#include "company_func.h"`
`#include "company_gui.h"`
`#include "company_base.h"`
`#include "tile_map.h"`
`#include "texteff.hpp"`
`#include "core/backup_type.hpp"`
`#include "table/strings.h"`
`#include "safeguards.h"`

Go to the source code of this file.

## Functions
CommandCost | CmdIncreaseLoan (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
| Increase the loan of your company. More...
CommandCost | CmdDecreaseLoan (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
| Decrease the loan of your company. More...
static void | AskUnsafeUnpauseCallback (Window *w, bool confirmed)
| In case of an unsafe unpause, we want the user to confirm that it might crash. More...
CommandCost | CmdPause (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
| Pause/Unpause the game (server-only). More...
CommandCost | CmdMoneyCheat (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
| Change the financial flow of your company. More...
CommandCost | CmdChangeBankBalance (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
| Change the bank bank balance of a company by inserting or removing money without affecting the loan. More...

## Detailed Description

Some misc functions that are better fitted in other files, but never got moved there...

Definition in file misc_cmd.cpp.

## Function Documentation

## ◆ AskUnsafeUnpauseCallback()

static void AskUnsafeUnpauseCallback | ( | Window * | w,
|  | bool | confirmed
| ) |  |
| static

In case of an unsafe unpause, we want the user to confirm that it might crash.

Parameters

  w | unused
  confirmed | whether the user confirms his/her action

Definition at line 134 of file misc_cmd.cpp.

References CMD_PAUSE, DoCommandP(), and PM_PAUSED_ERROR.

Referenced by CmdPause().

## ◆ CmdChangeBankBalance()

CommandCost CmdChangeBankBalance | ( | TileIndex | tile,
|  | DoCommandFlag | flags,
|  | uint32 | p1,
|  | uint32 | p2,
|  | const char * | text
| ) |  |

Change the bank bank balance of a company by inserting or removing money without affecting the loan.

Parameters

  tile | tile to show text effect on (if not 0)
  flags | operation to perform
  p1 | the amount of money to receive (if positive), or spend (if negative)
  p2 | (bit 0-7) - the company ID. (bit 8-15) - the expenses type which should register the cost/income

See also
  ExpensesType.

Parameters

  text | unused

Returns
  zero cost or an error

Definition at line 220 of file misc_cmd.cpp.

## ◆ CmdDecreaseLoan()

CommandCost CmdDecreaseLoan | ( | TileIndex | tile,
|  | DoCommandFlag | flags,
|  | uint32 | p1,
|  | uint32 | p2,
|  | const char * | text
| ) |  |

Decrease the loan of your company.

Parameters

  tile | unused
  flags | operation to perform
  p1 | higher half of amount to decrease the loan with, multitude of LOAN_INTERVAL. Only used when (p2 & 3) == 2.
  p2 | (bit 2-31) - lower half of amount (lower 2 bits assumed to be 0) (bit 0-1) - when 0: pays back LOAN_INTERVAL when 1: pays back the maximum loan permitting money (press CTRL), when 2: pays back the amount specified in p1 and p2
  text | unused

Returns
  the cost of this operation or an error

Definition at line 93 of file misc_cmd.cpp.

References _current_company, CMD_ERROR, CompanyProperties::current_loan, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), LOAN_INTERVAL, CompanyProperties::money, and return_cmd_error.

## ◆ CmdIncreaseLoan()

CommandCost CmdIncreaseLoan | ( | TileIndex | tile,
|  | DoCommandFlag | flags,
|  | uint32 | p1,
|  | uint32 | p2,
|  | const char * | text
| ) |  |

Increase the loan of your company.

Parameters

  tile | unused
  flags | operation to perform
  p1 | higher half of amount to increase the loan with, multitude of LOAN_INTERVAL. Only used when (p2 & 3) == 2.
  p2 | (bit 2-31) - lower half of amount (lower 2 bits assumed to be 0) (bit 0-1) - when 0: loans LOAN_INTERVAL when 1: loans the maximum loan permitting money (press CTRL), when 2: loans the amount specified in p1 and p2
  text | unused

Returns
  the cost of this operation or an error

Definition at line 45 of file misc_cmd.cpp.

References _current_company, CompanyProperties::current_loan, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get().

## ◆ CmdMoneyCheat()

CommandCost CmdMoneyCheat | ( | TileIndex | tile,
|  | DoCommandFlag | flags,
|  | uint32 | p1,
|  | uint32 | p2,
|  | const char * | text
| ) |  |

Change the financial flow of your company.

Parameters

  tile | unused
  flags | operation to perform
  p1 | the amount of money to receive (if positive), or spend (if negative)
  p2 | unused
  text | unused

Returns
  the cost of this operation or an error

Definition at line 205 of file misc_cmd.cpp.

References EXPENSES_OTHER.

## ◆ CmdPause()

CommandCost CmdPause | ( | TileIndex | tile,
|  | DoCommandFlag | flags,
|  | uint32 | p1,
|  | uint32 | p2,
|  | const char * | text
| ) |  |

Pause/Unpause the game (server-only).

Set or unset a bit in the pause mode. If pause mode is zero the game is unpaused. A bitset is used instead of a boolean value/counter to have more control over the game when saving/loading, etc.

Parameters

  tile | unused
  flags | operation to perform
  p1 | the pause mode to change
  p2 | 1 pauses, 0 unpauses this mode
  text | unused

Returns
  the cost of this operation or an error

Definition at line 153 of file misc_cmd.cpp.

References _networking, _pause_mode, AskUnsafeUnpauseCallback(), CMD_ERROR, DC_EXEC, PM_PAUSED_ACTIVE_CLIENTS, PM_PAUSED_ERROR, PM_PAUSED_GAME_SCRIPT, PM_PAUSED_JOIN, PM_PAUSED_LINK_GRAPH, PM_PAUSED_NORMAL, PM_PAUSED_SAVELOAD, and ShowQuery().