src/misc_cmd.cpp

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