Files
openttd/src/misc_cmd.cpp
Patric Stout f5fad88723 Change: base autosaves intervals on real time (instead of game time) (#10655)
There are two fundamental issues with autosave:
- When fast-forwarding, it saves way too often
- When paused, it never saves

Both makes no sense. Autosaves are meant to prevent you from
accidentally losing your work. The emphasis on "your" work.

To solve both issues, the autosave now works on real time. You
can select every 10 / 30 / 60 / 120 minutes, which are similar to
what the setting was in game-months.

When you pause, autosaving will stop. Unless you make any change
to the game; then it will continue to make autosaves, even so
the game is paused. Unpausing / pausing resets this mechanism.
2023-04-27 15:21:29 +00:00

386 lines
12 KiB
C++

/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file misc_cmd.cpp Some misc functions that are better fitted in other files, but never got moved there... */
#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 "cheat_type.h"
#include "table/strings.h"
#include "safeguards.h"
/* Make sure we can discard lower 2 bits of 64bit amount when passing it to Cmd[In|De]creaseLoan() */
static_assert((LOAN_INTERVAL & 3) == 0);
/**
* Increase the loan of your company.
* @param tile unused
* @param flags operation to perform
* @param p1 higher half of amount to increase the loan with, multitude of LOAN_INTERVAL. Only used when (p2 & 3) == 2.
* @param 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
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdIncreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
Company *c = Company::Get(_current_company);
if (c->current_loan >= _economy.max_loan) {
SetDParam(0, _economy.max_loan);
return_cmd_error(STR_ERROR_MAXIMUM_PERMITTED_LOAN);
}
Money loan;
switch (p2 & 3) {
default: return CMD_ERROR; // Invalid method
case 0: // Take some extra loan
loan = LOAN_INTERVAL;
break;
case 1: // Take a loan as big as possible
loan = _economy.max_loan - c->current_loan;
break;
case 2: // Take the given amount of loan
loan = ((uint64)p1 << 32) | (p2 & 0xFFFFFFFC);
if (loan < LOAN_INTERVAL || c->current_loan + loan > _economy.max_loan || loan % LOAN_INTERVAL != 0) return CMD_ERROR;
break;
}
/* In case adding the loan triggers the overflow protection of Money,
* we would essentially be losing money as taking and repaying the loan
* immediately would not get us back to the same bank balance anymore. */
if (c->money > Money::max() - loan) return CMD_ERROR;
if (flags & DC_EXEC) {
c->money += loan;
c->current_loan += loan;
InvalidateCompanyWindows(c);
}
return CommandCost(EXPENSES_OTHER);
}
/**
* Decrease the loan of your company.
* @param tile unused
* @param flags operation to perform
* @param p1 higher half of amount to decrease the loan with, multitude of LOAN_INTERVAL. Only used when (p2 & 3) == 2.
* @param 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
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdDecreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
Company *c = Company::Get(_current_company);
if (c->current_loan == 0) return_cmd_error(STR_ERROR_LOAN_ALREADY_REPAYED);
Money loan;
switch (p2 & 3) {
default: return CMD_ERROR; // Invalid method
case 0: // Pay back one step
loan = std::min(c->current_loan, (Money)LOAN_INTERVAL);
break;
case 1: // Pay back as much as possible
loan = std::max(std::min(c->current_loan, c->money), (Money)LOAN_INTERVAL);
loan -= loan % LOAN_INTERVAL;
break;
case 2: // Repay the given amount of loan
loan = ((uint64)p1 << 32) | (p2 & 0xFFFFFFFC);
if (loan % LOAN_INTERVAL != 0 || loan < LOAN_INTERVAL || loan > c->current_loan) return CMD_ERROR; // Invalid amount to loan
break;
}
if (c->money < loan) {
SetDParam(0, loan);
return_cmd_error(STR_ERROR_CURRENCY_REQUIRED);
}
if (flags & DC_EXEC) {
c->money -= loan;
c->current_loan -= loan;
InvalidateCompanyWindows(c);
}
return CommandCost();
}
/**
* In case of an unsafe unpause, we want the
* user to confirm that it might crash.
* @param w unused
* @param confirmed whether the user confirmed their action
*/
static void AskUnsafeUnpauseCallback(Window *w, bool confirmed)
{
if (confirmed) {
DoCommandP(0, PM_PAUSED_ERROR, 0, CMD_PAUSE);
}
}
/**
* 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.
* @param tile unused
* @param flags operation to perform
* @param p1 the pause mode to change
* @param p2 1 pauses, 0 unpauses this mode
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdPause(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
switch (p1) {
case PM_PAUSED_SAVELOAD:
case PM_PAUSED_ERROR:
case PM_PAUSED_NORMAL:
case PM_PAUSED_GAME_SCRIPT:
case PM_PAUSED_LINK_GRAPH:
break;
case PM_PAUSED_JOIN:
case PM_PAUSED_ACTIVE_CLIENTS:
if (!_networking) return CMD_ERROR;
break;
default: return CMD_ERROR;
}
if (flags & DC_EXEC) {
if (p1 == PM_PAUSED_NORMAL && _pause_mode & PM_PAUSED_ERROR) {
ShowQuery(
STR_NEWGRF_UNPAUSE_WARNING_TITLE,
STR_NEWGRF_UNPAUSE_WARNING,
nullptr,
AskUnsafeUnpauseCallback
);
} else {
PauseMode prev_mode = _pause_mode;
if ((p2 & 1) == 0) {
_pause_mode = static_cast<PauseMode>(_pause_mode & (byte)~p1);
_pause_countdown = (p2 >> 1);
} else {
_pause_mode = static_cast<PauseMode>(_pause_mode | (byte)p1);
}
NetworkHandlePauseChange(prev_mode, (PauseMode)p1);
}
SetWindowDirty(WC_STATUS_BAR, 0);
SetWindowDirty(WC_MAIN_TOOLBAR, 0);
}
return CommandCost();
}
/**
* Change the financial flow of your company.
* @param tile unused
* @param flags operation to perform
* @param p1 the amount of money to receive (if positive), or spend (if negative)
* @param p2 unused
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdMoneyCheat(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
if (_networking && !_settings_game.difficulty.money_cheat_in_multiplayer) return CMD_ERROR;
if (flags & DC_EXEC) {
_cheats.money.been_used = true;
SetWindowDirty(WC_CHEATS, 0);
}
return CommandCost(EXPENSES_OTHER, -(int32)p1);
}
/**
* Change the financial flow of your company (admin).
* @param tile unused
* @param flags operation to perform
* @param p1 the amount of money to receive (if positive), or spend (if negative)
* @param p2 unused
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdMoneyCheatAdmin(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
if (flags & DC_EXEC) {
_cheats.money.been_used = true;
SetWindowDirty(WC_CHEATS, 0);
}
return CommandCost(EXPENSES_OTHER, -(int32)p1);
}
/**
* Change the value of a cheat setting.
* @param tile unused
* @param flags operation to perform
* @param p1 the cheat number
* @param p2 the cheat value
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdCheatSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
Cheat *cht = nullptr;
switch ((CheatNumbers) p1) {
case CHT_EXTRA_DYNAMITE:
cht = &_cheats.magic_bulldozer;
break;
case CHT_CROSSINGTUNNELS:
cht = &_cheats.crossing_tunnels;
break;
case CHT_NO_JETCRASH:
cht = &_cheats.no_jetcrash;
break;
case CHT_INFLATION_INCOME:
if (flags & DC_EXEC) {
_extra_cheats.inflation_income.been_used = true;
_economy.inflation_payment = Clamp<uint64>(p2, 1 << 16, MAX_INFLATION);
if (_economy.inflation_payment > _economy.inflation_prices) {
_economy.inflation_prices = _economy.inflation_payment;
_extra_cheats.inflation_cost.been_used = true;
}
RecomputePrices();
SetWindowDirty(WC_CHEATS, 0);
}
return CommandCost();
case CHT_INFLATION_COST:
if (flags & DC_EXEC) {
_extra_cheats.inflation_cost.been_used = true;
_economy.inflation_prices = Clamp<uint64>(p2, 1 << 16, MAX_INFLATION);
if (_economy.inflation_payment > _economy.inflation_prices) {
_economy.inflation_payment = _economy.inflation_prices;
_extra_cheats.inflation_income.been_used = true;
}
RecomputePrices();
SetWindowDirty(WC_CHEATS, 0);
}
return CommandCost();
case CHT_STATION_RATING:
cht = &_extra_cheats.station_rating;
break;
case CHT_TOWN_RATING:
cht = &_extra_cheats.town_rating;
break;
default:
return CMD_ERROR;
}
if (flags & DC_EXEC) {
cht->value = p2;
cht->been_used = true;
SetWindowDirty(WC_CHEATS, 0);
if (p1 == CHT_STATION_RATING) {
extern void UpdateAllStationRatings();
UpdateAllStationRatings();
}
if (p1 == CHT_TOWN_RATING) {
extern void UpdateAllTownRatings();
UpdateAllTownRatings();
}
}
return CommandCost();
}
/**
* Change the bank bank balance of a company by inserting or removing money without affecting the loan.
* @param tile tile to show text effect on (if not 0)
* @param flags operation to perform
* @param p1 the amount of money to receive (if positive), or spend (if negative)
* @param p2 (bit 0-7) - the company ID.
* (bit 8-15) - the expenses type which should register the cost/income @see ExpensesType.
* @param text unused
* @return zero cost or an error
*/
CommandCost CmdChangeBankBalance(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
int32 delta = (int32)p1;
CompanyID company = (CompanyID) GB(p2, 0, 8);
ExpensesType expenses_type = Extract<ExpensesType, 8, 8>(p2);
if (!Company::IsValidID(company)) return CMD_ERROR;
if (expenses_type >= EXPENSES_END) return CMD_ERROR;
if (_current_company != OWNER_DEITY) return CMD_ERROR;
if (flags & DC_EXEC) {
/* Change company bank balance of company. */
Backup<CompanyID> cur_company(_current_company, company, FILE_LINE);
SubtractMoneyFromCompany(CommandCost(expenses_type, -delta));
cur_company.Restore();
if (tile != 0) {
ShowCostOrIncomeAnimation(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, GetTilePixelZ(tile), -delta);
}
}
/* This command doesn't cost anything for deity. */
CommandCost zero_cost(expenses_type, 0);
return zero_cost;
}
/**
* Transfer funds (money) from one company to another.
* To prevent abuse in multiplayer games you can only send money to other
* companies if you have paid off your loan (either explicitly, or implicitly
* given the fact that you have more money than loan).
* @param tile unused
* @param flags operation to perform
* @param p1 the amount of money to transfer; max 20.000.000
* @param p2 the company to transfer the money to
* @param text unused
* @return the cost of this operation or an error
*/
CommandCost CmdGiveMoney(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
{
if (!_settings_game.economy.give_money) return CMD_ERROR;
const Company *c = Company::Get(_current_company);
CommandCost amount(EXPENSES_OTHER, std::min((Money)p1, (Money)20000000LL));
CompanyID dest_company = (CompanyID)p2;
/* You can only transfer funds that is in excess of your loan */
if (c->money - c->current_loan < amount.GetCost() || amount.GetCost() < 0) return CMD_ERROR;
if (!Company::IsValidID(dest_company)) return CMD_ERROR;
if (flags & DC_EXEC) {
/* Add money to company */
Backup<CompanyID> cur_company(_current_company, dest_company, FILE_LINE);
SubtractMoneyFromCompany(CommandCost(EXPENSES_OTHER, -amount.GetCost()));
cur_company.Restore();
}
/* Subtract money from local-company */
return amount;
}