OpenTTD Source 20261112-master-gbcbec5e63f
misc_cmd.cpp
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "openttd.h"
12#include "command_func.h"
13#include "window_func.h"
14#include "textbuf_gui.h"
15#include "network/network.h"
17#include "strings_func.h"
18#include "company_func.h"
19#include "company_gui.h"
20#include "company_base.h"
21#include "tile_map.h"
22#include "texteff.hpp"
23#include "misc_cmd.h"
25
26#include "table/strings.h"
27
28#include "safeguards.h"
29
40{
42 Money max_loan = c->GetMaxLoan();
43 if (c->current_loan >= max_loan) {
44 return CommandCostWithParam(STR_ERROR_MAXIMUM_PERMITTED_LOAN, max_loan);
45 }
46
47 Money loan;
48 switch (cmd) {
49 default: return CMD_ERROR; // Invalid method
50 case LoanCommand::Interval: // Take some extra loan
51 loan = LOAN_INTERVAL;
52 break;
53 case LoanCommand::Max: // Take a loan as big as possible
54 loan = max_loan - c->current_loan;
55 break;
56 case LoanCommand::Amount: // Take the given amount of loan
57 loan = amount;
58 if (loan < LOAN_INTERVAL || c->current_loan + loan > max_loan || loan % LOAN_INTERVAL != 0) return CMD_ERROR;
59 break;
60 }
61
62 /* In case adding the loan triggers the overflow protection of Money,
63 * we would essentially be losing money as taking and repaying the loan
64 * immediately would not get us back to the same bank balance anymore. */
65 if (c->money > Money::max() - loan) return CMD_ERROR;
66
67 if (flags.Test(DoCommandFlag::Execute)) {
68 c->money += loan;
69 c->current_loan += loan;
71 }
72
74}
75
86{
88
89 if (c->current_loan == 0) return CommandCost(STR_ERROR_LOAN_ALREADY_REPAID);
90
91 Money loan;
92 switch (cmd) {
93 default: return CMD_ERROR; // Invalid method
94 case LoanCommand::Interval: // Pay back one step
95 loan = std::min(c->current_loan, (Money)LOAN_INTERVAL);
96 break;
97 case LoanCommand::Max: // Pay back as much as possible
98 loan = std::max(std::min(c->current_loan, GetAvailableMoneyForCommand()), (Money)LOAN_INTERVAL);
99 loan -= loan % LOAN_INTERVAL;
100 break;
101 case LoanCommand::Amount: // Repay the given amount of loan
102 loan = amount;
103 if (loan % LOAN_INTERVAL != 0 || loan < LOAN_INTERVAL || loan > c->current_loan) return CMD_ERROR; // Invalid amount to loan
104 break;
105 }
106
107 if (GetAvailableMoneyForCommand() < loan) {
108 return CommandCostWithParam(STR_ERROR_CURRENCY_REQUIRED, loan);
109 }
110
111 if (flags.Test(DoCommandFlag::Execute)) {
112 c->money -= loan;
113 c->current_loan -= loan;
115 }
116 return CommandCost();
117}
118
126CommandCost CmdSetCompanyMaxLoan(DoCommandFlags flags, CompanyID company, Money amount)
127{
129 if (amount != COMPANY_MAX_LOAN_DEFAULT) {
130 if (amount < 0 || amount > (Money)MAX_LOAN_LIMIT) return CMD_ERROR;
131 }
132
133 Company *c = Company::GetIfValid(company);
134 if (c == nullptr) return CMD_ERROR;
135
136 if (flags.Test(DoCommandFlag::Execute)) {
137 /* Round the amount down to a multiple of LOAN_INTERVAL. */
138 if (amount != COMPANY_MAX_LOAN_DEFAULT) amount -= (int64_t)amount % LOAN_INTERVAL;
139
140 c->max_loan = amount;
142 }
143 return CommandCost();
144}
145
151static void AskUnsafeUnpauseCallback(Window *, bool confirmed)
152{
153 if (confirmed) {
154 Command<Commands::Pause>::Post(PauseMode::Error, false);
155 }
156}
157
169{
170 switch (mode) {
172 case PauseMode::Error:
176 break;
177
178 case PauseMode::Join:
180 if (!_networking) return CMD_ERROR;
181 break;
182
183 default: return CMD_ERROR;
184 }
185 if (flags.Test(DoCommandFlag::Execute)) {
186 if (mode == PauseMode::Normal && _pause_mode.Test(PauseMode::Error)) {
187 ShowQuery(
188 GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING_TITLE),
189 GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING),
190 nullptr,
192 );
193 } else {
194 PauseModes prev_mode = _pause_mode;
195
196 if (pause) {
197 _pause_mode.Set(mode);
198 } else {
199 _pause_mode.Reset(mode);
200
201 /* If the only remaining reason to be paused is that we saw a command during pause, unpause. */
203 _pause_mode = {};
204 }
205 }
206
207 NetworkHandlePauseChange(prev_mode, mode);
208
209 /* Screensaver should always be inhibited unless we're paused. */
211 }
212
213 SetWindowDirty(WindowClass::Statusbar, 0);
214 SetWindowDirty(WindowClass::MainToolbar, 0);
215 }
216 return CommandCost();
217}
218
225{
226 return CommandCost(ExpensesType::Other, -amount);
227}
228
238CommandCost CmdChangeBankBalance(DoCommandFlags flags, TileIndex tile, Money delta, CompanyID company, ExpensesType expenses_type)
239{
240 if (!Company::IsValidID(company)) return CMD_ERROR;
241 if (expenses_type >= ExpensesType::End) return CMD_ERROR;
243
244 if (flags.Test(DoCommandFlag::Execute)) {
245 /* Change company bank balance of company. */
246 SubtractMoneyFromCompany(company, CommandCost(expenses_type, -delta));
247
248 if (tile != 0) {
249 ShowCostOrIncomeAnimation(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, GetTilePixelZ(tile), -delta);
250 }
251 }
252
253 /* This command doesn't cost anything for deity. */
254 CommandCost zero_cost(expenses_type);
255 return zero_cost;
256}
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
Common return value for all commands.
virtual void SetScreensaverInhibited(bool inhibited)
Prevents the system from going to sleep.
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
CommandCost CommandCostWithParam(StringID str, uint64_t value)
Return an error status, with string and parameter.
Definition command.cpp:415
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
EnumBitSet< DoCommandFlag, uint16_t > DoCommandFlags
Bitset of DoCommandFlag elements.
Definition of stuff that is very close to a company, like the company struct itself.
void InvalidateCompanyWindows(const Company *company)
Mark all finance windows owned by a company as needing a refresh.
static void SubtractMoneyFromCompany(Company *c, const CommandCost &cost)
Deduct costs of a command from the money of a company.
Money GetAvailableMoneyForCommand()
This functions returns the money which can be used to execute a command.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
GUI Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static const int64_t MAX_LOAN_LIMIT
The max amount possible to configure for a max loan of a company.
ExpensesType
Types of expenses.
@ Other
Other expenses.
@ End
End marker.
static const int LOAN_INTERVAL
The "steps" in loan size, in British Pounds!
PauseModes _pause_mode
The current pause mode.
Definition gfx.cpp:46
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
CommandCost CmdChangeBankBalance(DoCommandFlags flags, TileIndex tile, Money delta, CompanyID company, ExpensesType expenses_type)
Change the bank bank balance of a company by inserting or removing money without affecting the loan.
Definition misc_cmd.cpp:238
CommandCost CmdDecreaseLoan(DoCommandFlags flags, LoanCommand cmd, Money amount)
Decrease the loan of your company.
Definition misc_cmd.cpp:85
CommandCost CmdIncreaseLoan(DoCommandFlags flags, LoanCommand cmd, Money amount)
Increase the loan of your company.
Definition misc_cmd.cpp:39
CommandCost CmdMoneyCheat(DoCommandFlags, Money amount)
Change the financial flow of your company.
Definition misc_cmd.cpp:224
CommandCost CmdPause(DoCommandFlags flags, PauseMode mode, bool pause)
Pause/Unpause the game (server-only).
Definition misc_cmd.cpp:168
CommandCost CmdSetCompanyMaxLoan(DoCommandFlags flags, CompanyID company, Money amount)
Sets the max loan amount of your company.
Definition misc_cmd.cpp:126
static void AskUnsafeUnpauseCallback(Window *, bool confirmed)
In case of an unsafe unpause, we want the user to confirm that it might crash.
Definition misc_cmd.cpp:151
Miscellaneous command definitions.
LoanCommand
Different ways to determine the amount to loan/repay.
Definition misc_cmd.h:18
@ Max
Loan/repay the maximum amount permitting money/settings.
Definition misc_cmd.h:20
@ Amount
Loan/repay the given amount.
Definition misc_cmd.h:21
@ Interval
Loan/repay LOAN_INTERVAL.
Definition misc_cmd.h:19
void ShowQuery(EncodedString &&caption, EncodedString &&message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
Display animated income or costs on the map.
Definition misc_gui.cpp:508
void NetworkHandlePauseChange(PauseModes prev_mode, PauseMode changed_mode)
Handle the pause mode change so we send the right messages to the chat.
Definition network.cpp:359
bool _networking
are we in networking mode?
Definition network.cpp:63
Basic functions/variables used all over the place.
Network functions used by other parts of OpenTTD.
Some generic types.
PauseMode
Modes of pausing we've got.
Definition openttd.h:71
@ LinkGraph
A game paused due to the link graph schedule lagging.
Definition openttd.h:78
@ Error
A game paused because a (critical) error.
Definition openttd.h:75
@ GameScript
A game paused by a game script.
Definition openttd.h:77
@ ActiveClients
A game paused for 'min_active_clients'.
Definition openttd.h:76
@ Normal
A game normally paused.
Definition openttd.h:72
@ Join
A game paused for 'pause_on_join'.
Definition openttd.h:74
@ CommandDuringPause
A game paused, and a command executed during the pause; resets on autosave.
Definition openttd.h:79
@ SaveLoad
A game paused for saving/loading.
Definition openttd.h:73
EnumBitSet< PauseMode, uint8_t > PauseModes
Bitset of PauseMode elements.
Definition openttd.h:83
A number of safeguards to prevent using unsafe methods.
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:89
Functions related to OTTD's strings.
Money current_loan
Amount of money borrowed from the bank.
Money max_loan
Max allowed amount of the loan or COMPANY_MAX_LOAN_DEFAULT.
Money money
Money owned by the company.
Money GetMaxLoan() const
Calculate the max allowed loan for this company.
static Company * Get(auto index)
static Company * GetIfValid(auto index)
Data structure for an opened window.
Definition window_gui.h:272
Stuff related to the text buffer GUI.
Functions related to text effects.
Map writing/reading functions for tiles.
int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.h:302
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
Base of all video drivers.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3255
Window functions not directly related to making/drawing windows.