misc_cmd.cpp

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "openttd.h"
#include "command_func.h"
#include "economy_func.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 "misc_cmd.h"
#include "video/video_driver.hpp"
 
#include "table/strings.h"
 
#include "safeguards.h"

CommandCost CmdIncreaseLoan(DoCommandFlags flags, LoanCommand cmd, Money amount)
{
  Company *c = Company::Get(_current_company);
  Money max_loan = c->GetMaxLoan();
  if (c->current_loan >= max_loan) {
    return CommandCostWithParam(STR_ERROR_MAXIMUM_PERMITTED_LOAN, max_loan);
  }
 
  Money loan;
  switch (cmd) {
    default: return CMD_ERROR; // Invalid method
    case LoanCommand::Interval: // Take some extra loan
      loan = LOAN_INTERVAL;
      break;
    case LoanCommand::Max: // Take a loan as big as possible
      loan = max_loan - c->current_loan;
      break;
    case LoanCommand::Amount: // Take the given amount of loan
      loan = amount;
      if (loan < LOAN_INTERVAL || c->current_loan + loan > 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.Test(DoCommandFlag::Execute)) {
    c->money        += loan;
    c->current_loan += loan;
    InvalidateCompanyWindows(c);
  }
 
  return CommandCost(EXPENSES_OTHER);
}

CommandCost CmdDecreaseLoan(DoCommandFlags flags, LoanCommand cmd, Money amount)
{
  Company *c = Company::Get(_current_company);
 
  if (c->current_loan == 0) return CommandCost(STR_ERROR_LOAN_ALREADY_REPAID);
 
  Money loan;
  switch (cmd) {
    default: return CMD_ERROR; // Invalid method
    case LoanCommand::Interval: // Pay back one step
      loan = std::min(c->current_loan, (Money)LOAN_INTERVAL);
      break;
    case LoanCommand::Max: // Pay back as much as possible
      loan = std::max(std::min(c->current_loan, GetAvailableMoneyForCommand()), (Money)LOAN_INTERVAL);
      loan -= loan % LOAN_INTERVAL;
      break;
    case LoanCommand::Amount: // Repay the given amount of loan
      loan = amount;
      if (loan % LOAN_INTERVAL != 0 || loan < LOAN_INTERVAL || loan > c->current_loan) return CMD_ERROR; // Invalid amount to loan
      break;
  }
 
  if (GetAvailableMoneyForCommand() < loan) {
    return CommandCostWithParam(STR_ERROR_CURRENCY_REQUIRED, loan);
  }
 
  if (flags.Test(DoCommandFlag::Execute)) {
    c->money        -= loan;
    c->current_loan -= loan;
    InvalidateCompanyWindows(c);
  }
  return CommandCost();
}

CommandCost CmdSetCompanyMaxLoan(DoCommandFlags flags, CompanyID company, Money amount)
{
  if (_current_company != OWNER_DEITY) return CMD_ERROR;
  if (amount != COMPANY_MAX_LOAN_DEFAULT) {
    if (amount < 0 || amount > (Money)MAX_LOAN_LIMIT) return CMD_ERROR;
  }
 
  Company *c = Company::GetIfValid(company);
  if (c == nullptr) return CMD_ERROR;
 
  if (flags.Test(DoCommandFlag::Execute)) {
    /* Round the amount down to a multiple of LOAN_INTERVAL. */
    if (amount != COMPANY_MAX_LOAN_DEFAULT) amount -= (int64_t)amount % LOAN_INTERVAL;
 
    c->max_loan = amount;
    InvalidateCompanyWindows(c);
  }
  return CommandCost();
}

static void AskUnsafeUnpauseCallback(Window *, bool confirmed)
{
  if (confirmed) {
    Command<Commands::Pause>::Post(PauseMode::Error, false);
  }
}

CommandCost CmdPause(DoCommandFlags flags, PauseMode mode, bool pause)
{
  switch (mode) {
    case PauseMode::SaveLoad:
    case PauseMode::Error:
    case PauseMode::Normal:
    case PauseMode::GameScript:
    case PauseMode::LinkGraph:
      break;
 
    case PauseMode::Join:
    case PauseMode::ActiveClients:
      if (!_networking) return CMD_ERROR;
      break;
 
    default: return CMD_ERROR;
  }
  if (flags.Test(DoCommandFlag::Execute)) {
    if (mode == PauseMode::Normal && _pause_mode.Test(PauseMode::Error)) {
      ShowQuery(
        GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING_TITLE),
        GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING),
        nullptr,
        AskUnsafeUnpauseCallback
      );
    } else {
      PauseModes prev_mode = _pause_mode;
 
      if (pause) {
        _pause_mode.Set(mode);
      } else {
        _pause_mode.Reset(mode);
 
        /* If the only remaining reason to be paused is that we saw a command during pause, unpause. */
        if (_pause_mode == PauseMode::CommandDuringPause) {
          _pause_mode = {};
        }
      }
 
      NetworkHandlePauseChange(prev_mode, mode);
 
      /* Screensaver should always be inhibited unless we're paused. */
      VideoDriver::GetInstance()->SetScreensaverInhibited(_pause_mode.None());
    }
 
    SetWindowDirty(WC_STATUS_BAR, 0);
    SetWindowDirty(WC_MAIN_TOOLBAR, 0);
  }
  return CommandCost();
}

CommandCost CmdMoneyCheat(DoCommandFlags, Money amount)
{
  return CommandCost(EXPENSES_OTHER, -amount);
}

CommandCost CmdChangeBankBalance(DoCommandFlags flags, TileIndex tile, Money delta, CompanyID company, ExpensesType expenses_type)
{
  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.Test(DoCommandFlag::Execute)) {
    /* Change company bank balance of company. */
    SubtractMoneyFromCompany(company, CommandCost(expenses_type, -delta));
 
    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, (Money)0);
  return zero_cost;
}