src/misc_cmd.cpp

   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
   8 /** @file misc_cmd.cpp Some misc functions that are better fitted in other files, but never got moved there... */
   9
  10 #include "stdafx.h"
  11 #include "command_func.h"
  12 #include "economy_func.h"
  13 #include "cmd_helper.h"
  14 #include "window_func.h"
  15 #include "textbuf_gui.h"
  16 #include "network/network.h"
  17 #include "network/network_func.h"
  18 #include "strings_func.h"
  19 #include "company_func.h"
  20 #include "company_gui.h"
  21 #include "company_base.h"
  22 #include "core/backup_type.hpp"
  23
  24 #include "table/strings.h"
  25
  26 #include "safeguards.h"
  27
  28 /**
  29  * Increase the loan of your company.
  30  * @param tile unused
  31  * @param flags operation to perform
  32  * @param p1 amount to increase the loan with, multitude of LOAN_INTERVAL. Only used when p2 == 2.
  33  * @param p2 when 0: loans LOAN_INTERVAL
  34  *           when 1: loans the maximum loan permitting money (press CTRL),
  35  *           when 2: loans the amount specified in p1
  36  * @param text unused
  37  * @return the cost of this operation or an error
  38  */
  39 CommandCost CmdIncreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
  40 {
  41         Company *c = Company::Get(_current_company);
  42
  43         if (c->current_loan >= _economy.max_loan) {
  44                 SetDParam(0, _economy.max_loan);
  45                 return_cmd_error(STR_ERROR_MAXIMUM_PERMITTED_LOAN);
  46         }
  47
  48         Money loan;
  49         switch (p2) {
  50                 default: return CMD_ERROR; // Invalid method
  51                 case 0: // Take some extra loan
  52                         loan = LOAN_INTERVAL;
  53                         break;
  54                 case 1: // Take a loan as big as possible
  55                         loan = _economy.max_loan - c->current_loan;
  56                         break;
  57                 case 2: // Take the given amount of loan
  58                         if ((int32)p1 < LOAN_INTERVAL || c->current_loan + (int32)p1 > _economy.max_loan || p1 % LOAN_INTERVAL != 0) return CMD_ERROR;
  59                         loan = p1;
  60                         break;
  61         }
  62
  63         /* Overflow protection */
  64         if (c->money + c->current_loan + loan < c->money) return CMD_ERROR;
  65
  66         if (flags & DC_EXEC) {
  67                 c->money        += loan;
  68                 c->current_loan += loan;
  69                 InvalidateCompanyWindows(c);
  70         }
  71
  72         return CommandCost(EXPENSES_OTHER);
  73 }
  74
  75 /**
  76  * Decrease the loan of your company.
  77  * @param tile unused
  78  * @param flags operation to perform
  79  * @param p1 amount to decrease the loan with, multitude of LOAN_INTERVAL. Only used when p2 == 2.
  80  * @param p2 when 0: pays back LOAN_INTERVAL
  81  *           when 1: pays back the maximum loan permitting money (press CTRL),
  82  *           when 2: pays back the amount specified in p1
  83  * @param text unused
  84  * @return the cost of this operation or an error
  85  */
  86 CommandCost CmdDecreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
  87 {
  88         Company *c = Company::Get(_current_company);
  89
  90         if (c->current_loan == 0) return_cmd_error(STR_ERROR_LOAN_ALREADY_REPAYED);
  91
  92         Money loan;
  93         switch (p2) {
  94                 default: return CMD_ERROR; // Invalid method
  95                 case 0: // Pay back one step
  96                         loan = min(c->current_loan, (Money)LOAN_INTERVAL);
  97                         break;
  98                 case 1: // Pay back as much as possible
  99                         loan = max(min(c->current_loan, c->money), (Money)LOAN_INTERVAL);
 100                         loan -= loan % LOAN_INTERVAL;
 101                         break;
 102                 case 2: // Repay the given amount of loan
 103                         if (p1 % LOAN_INTERVAL != 0 || (int32)p1 < LOAN_INTERVAL || p1 > c->current_loan) return CMD_ERROR; // Invalid amount to loan
 104                         loan = p1;
 105                         break;
 106         }
 107
 108         if (c->money < loan) {
 109                 SetDParam(0, loan);
 110                 return_cmd_error(STR_ERROR_CURRENCY_REQUIRED);
 111         }
 112
 113         if (flags & DC_EXEC) {
 114                 c->money        -= loan;
 115                 c->current_loan -= loan;
 116                 InvalidateCompanyWindows(c);
 117         }
 118         return CommandCost();
 119 }
 120
 121 /**
 122  * In case of an unsafe unpause, we want the
 123  * user to confirm that it might crash.
 124  * @param w         unused
 125  * @param confirmed whether the user confirms his/her action
 126  */
 127 static void AskUnsafeUnpauseCallback(Window *w, bool confirmed)
 128 {
 129         if (confirmed) {
 130                 DoCommandP(0, PM_PAUSED_ERROR, 0, CMD_PAUSE);
 131         }
 132 }
 133
 134 /**
 135  * Pause/Unpause the game (server-only).
 136  * Set or unset a bit in the pause mode. If pause mode is zero the game is
 137  * unpaused. A bitset is used instead of a boolean value/counter to have
 138  * more control over the game when saving/loading, etc.
 139  * @param tile unused
 140  * @param flags operation to perform
 141  * @param p1 the pause mode to change
 142  * @param p2 1 pauses, 0 unpauses this mode
 143  * @param text unused
 144  * @return the cost of this operation or an error
 145  */
 146 CommandCost CmdPause(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 147 {
 148         switch (p1) {
 149                 case PM_PAUSED_SAVELOAD:
 150                 case PM_PAUSED_ERROR:
 151                 case PM_PAUSED_NORMAL:
 152                 case PM_PAUSED_GAME_SCRIPT:
 153                         break;
 154
 155                 case PM_PAUSED_JOIN:
 156                 case PM_PAUSED_ACTIVE_CLIENTS:
 157                         if (!_networking) return CMD_ERROR;
 158                         break;
 159
 160                 default: return CMD_ERROR;
 161         }
 162         if (flags & DC_EXEC) {
 163                 if (p1 == PM_PAUSED_NORMAL && _pause_mode & PM_PAUSED_ERROR) {
 164                         ShowQuery(
 165                                 STR_NEWGRF_UNPAUSE_WARNING_TITLE,
 166                                 STR_NEWGRF_UNPAUSE_WARNING,
 167                                 nullptr,
 168                                 AskUnsafeUnpauseCallback
 169                         );
 170                 } else {
 171                         PauseMode prev_mode = _pause_mode;
 172
 173                         if (p2 == 0) {
 174                                 _pause_mode = static_cast<PauseMode>(_pause_mode & (byte)~p1);
 175                         } else {
 176                                 _pause_mode = static_cast<PauseMode>(_pause_mode | (byte)p1);
 177                         }
 178
 179                         NetworkHandlePauseChange(prev_mode, (PauseMode)p1);
 180                 }
 181
 182                 SetWindowDirty(WC_STATUS_BAR, 0);
 183                 SetWindowDirty(WC_MAIN_TOOLBAR, 0);
 184         }
 185         return CommandCost();
 186 }
 187
 188 /**
 189  * Change the financial flow of your company.
 190  * @param tile unused
 191  * @param flags operation to perform
 192  * @param p1 the amount of money to receive (if positive), or spend (if negative)
 193  * @param p2 unused
 194  * @param text unused
 195  * @return the cost of this operation or an error
 196  */
 197 CommandCost CmdMoneyCheat(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 198 {
 199         return CommandCost(EXPENSES_OTHER, -(int32)p1);
 200 }
 201
 202 /**
 203  * Change the bank bank balance of a company by inserting or removing money without affecting the loan.
 204  * @param tile unused
 205  * @param flags operation to perform
 206  * @param p1 the amount of money to receive (if positive), or spend (if negative)
 207  * @param p2 (bit 0-7)  - the company ID.
 208  *           (bit 8-15) - the expenses type which should register the cost/income @see ExpensesType.
 209  * @param text unused
 210  * @return zero cost or an error
 211  */
 212 CommandCost CmdChangeBankBalance(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 213 {
 214         int32 delta = (int32)p1;
 215         CompanyID company = (CompanyID) GB(p2, 0, 8);
 216         ExpensesType expenses_type = Extract<ExpensesType, 8, 8>(p2);
 217
 218         if (!Company::IsValidID(company)) return CMD_ERROR;
 219         if (expenses_type >= EXPENSES_END) return CMD_ERROR;
 220         if (_current_company != OWNER_DEITY) return CMD_ERROR;
 221
 222         if (flags & DC_EXEC) {
 223                 /* Change company bank balance of company. */
 224                 Backup<CompanyID> cur_company(_current_company, company, FILE_LINE);
 225                 SubtractMoneyFromCompany(CommandCost(expenses_type, -delta));
 226                 cur_company.Restore();
 227         }
 228
 229         /* This command doesn't cost anything for deity. */
 230         CommandCost zero_cost(expenses_type, 0);
 231         return zero_cost;
 232 }
 233
 234 /**
 235  * Transfer funds (money) from one company to another.
 236  * To prevent abuse in multiplayer games you can only send money to other
 237  * companies if you have paid off your loan (either explicitly, or implicitly
 238  * given the fact that you have more money than loan).
 239  * @param tile unused
 240  * @param flags operation to perform
 241  * @param p1 the amount of money to transfer; max 20.000.000
 242  * @param p2 the company to transfer the money to
 243  * @param text unused
 244  * @return the cost of this operation or an error
 245  */
 246 CommandCost CmdGiveMoney(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 247 {
 248         if (!_settings_game.economy.give_money) return CMD_ERROR;
 249
 250         const Company *c = Company::Get(_current_company);
 251         CommandCost amount(EXPENSES_OTHER, min((Money)p1, (Money)20000000LL));
 252         CompanyID dest_company = (CompanyID)p2;
 253
 254         /* You can only transfer funds that is in excess of your loan */
 255         if (c->money - c->current_loan < amount.GetCost() || amount.GetCost() < 0) return CMD_ERROR;
 256         if (!_networking || !Company::IsValidID(dest_company)) return CMD_ERROR;
 257
 258         if (flags & DC_EXEC) {
 259                 /* Add money to company */
 260                 Backup<CompanyID> cur_company(_current_company, dest_company, FILE_LINE);
 261                 SubtractMoneyFromCompany(CommandCost(EXPENSES_OTHER, -amount.GetCost()));
 262                 cur_company.Restore();
 263         }
 264
 265         /* Subtract money from local-company */
 266         return amount;
 267 }