cheat_gui.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 <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "command_func.h"
#include "cheat_type.h"
#include "company_base.h"
#include "company_func.h"
#include "saveload/saveload.h"
#include "vehicle_base.h"
#include "textbuf_gui.h"
#include "window_gui.h"
#include "string_func.h"
#include "strings_func.h"
#include "window_func.h"
#include "rail_gui.h"
#include "settings_gui.h"
#include "company_gui.h"
#include "linkgraph/linkgraphschedule.h"
#include "map_func.h"
#include "tile_map.h"
#include "newgrf.h"
#include "error.h"
#include "misc_cmd.h"
#include "core/geometry_func.hpp"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
 
#include "widgets/cheat_widget.h"
 
#include "table/sprites.h"
 
#include "safeguards.h"
 
 
static int32_t _money_cheat_amount = 10000000;
 
static int32_t ClickMoneyCheat(int32_t, int32_t change_direction)
{
  Command<CMD_MONEY_CHEAT>::Post(Money(_money_cheat_amount) * change_direction);
  return _money_cheat_amount;
}
 
static int32_t ClickChangeCompanyCheat(int32_t new_value, int32_t change_direction)
{
  while ((uint)new_value < Company::GetPoolSize()) {
    if (Company::IsValidID((CompanyID)new_value)) {
      SetLocalCompany((CompanyID)new_value);
      return _local_company;
    }
    new_value += change_direction;
  }
 
  return _local_company;
}
 
static int32_t ClickSetProdCheat(int32_t new_value, int32_t)
{
  _cheats.setup_prod.value = (new_value != 0);
  InvalidateWindowClassesData(WC_INDUSTRY_VIEW);
  return _cheats.setup_prod.value;
}
 
extern void CalendarEnginesMonthlyLoop();
 
static int32_t ClickChangeDateCheat(int32_t new_value, int32_t)
{
  /* Don't allow changing to an invalid year, or the current year. */
  auto new_year = Clamp(TimerGameCalendar::Year(new_value), CalendarTime::MIN_YEAR, CalendarTime::MAX_YEAR);
  if (new_year == TimerGameCalendar::year) return TimerGameCalendar::year.base();
 
  TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(TimerGameCalendar::date);
  TimerGameCalendar::Date new_calendar_date = TimerGameCalendar::ConvertYMDToDate(new_year, ymd.month, ymd.day);
 
  TimerGameCalendar::SetDate(new_calendar_date, TimerGameCalendar::date_fract);
 
  /* If not using wallclock units, we keep economy date in sync with calendar date and must change it also. */
  if (!TimerGameEconomy::UsingWallclockUnits()) {
    /* Keep economy and calendar dates synced. */
    TimerGameEconomy::Date new_economy_date = new_calendar_date.base();
 
    /* Shift cached dates before we change the date. */
    for (auto v : Vehicle::Iterate()) v->ShiftDates(new_economy_date - TimerGameEconomy::date);
    LinkGraphSchedule::instance.ShiftDates(new_economy_date - TimerGameEconomy::date);
 
    /* Now it's safe to actually change the date. */
    TimerGameEconomy::SetDate(new_economy_date, TimerGameEconomy::date_fract);
  }
 
  CalendarEnginesMonthlyLoop();
  SetWindowDirty(WC_STATUS_BAR, 0);
  InvalidateWindowClassesData(WC_BUILD_STATION, 0);
  InvalidateWindowClassesData(WC_BUS_STATION, 0);
  InvalidateWindowClassesData(WC_TRUCK_STATION, 0);
  InvalidateWindowClassesData(WC_BUILD_OBJECT, 0);
  InvalidateWindowClassesData(WC_FINANCES, 0);
  ResetSignalVariant();
  return TimerGameCalendar::year.base();
}
 
static int32_t ClickChangeMaxHlCheat(int32_t new_value, int32_t)
{
  new_value = Clamp(new_value, MIN_MAP_HEIGHT_LIMIT, MAX_MAP_HEIGHT_LIMIT);
 
  /* Check if at least one mountain on the map is higher than the new value.
   * If yes, disallow the change. */
  for (const auto t : Map::Iterate()) {
    if ((int32_t)TileHeight(t) > new_value) {
      ShowErrorMessage(STR_CONFIG_SETTING_TOO_HIGH_MOUNTAIN, INVALID_STRING_ID, WL_ERROR);
      /* Return old, unchanged value */
      return _settings_game.construction.map_height_limit;
    }
  }
 
  /* Execute the change and reload GRF Data */
  _settings_game.construction.map_height_limit = new_value;
  ReloadNewGRFData();
 
  /* The smallmap uses an index from heightlevels to colours. Trigger rebuilding it. */
  InvalidateWindowClassesData(WC_SMALLMAP, 2);
 
  return _settings_game.construction.map_height_limit;
}
 
enum CheatNumbers {
  CHT_MONEY,           
  CHT_CHANGE_COMPANY,  
  CHT_EXTRA_DYNAMITE,  
  CHT_CROSSINGTUNNELS, 
  CHT_NO_JETCRASH,     
  CHT_SETUP_PROD,      
  CHT_STATION_RATING,  
  CHT_EDIT_MAX_HL,     
  CHT_CHANGE_DATE,     
 
  CHT_NUM_CHEATS,      
};
 
typedef int32_t CheckButtonClick(int32_t new_value, int32_t change_direction);
 
struct CheatEntry {
  VarType type;          
  StringID str;          
  void *variable;        
  bool *been_used;       
  CheckButtonClick *proc;
};
 
static const CheatEntry _cheats_ui[] = {
  {SLE_INT32, STR_CHEAT_MONEY,           &_money_cheat_amount,                          &_cheats.money.been_used,            &ClickMoneyCheat         },
  {SLE_UINT8, STR_CHEAT_CHANGE_COMPANY,  &_local_company,                               &_cheats.switch_company.been_used,   &ClickChangeCompanyCheat },
  {SLE_BOOL,  STR_CHEAT_EXTRA_DYNAMITE,  &_cheats.magic_bulldozer.value,                &_cheats.magic_bulldozer.been_used,  nullptr                  },
  {SLE_BOOL,  STR_CHEAT_CROSSINGTUNNELS, &_cheats.crossing_tunnels.value,               &_cheats.crossing_tunnels.been_used, nullptr                  },
  {SLE_BOOL,  STR_CHEAT_NO_JETCRASH,     &_cheats.no_jetcrash.value,                    &_cheats.no_jetcrash.been_used,      nullptr                  },
  {SLE_BOOL,  STR_CHEAT_SETUP_PROD,      &_cheats.setup_prod.value,                     &_cheats.setup_prod.been_used,       &ClickSetProdCheat       },
  {SLE_BOOL,  STR_CHEAT_STATION_RATING,  &_cheats.station_rating.value,                 &_cheats.station_rating.been_used,   nullptr                  },
  {SLE_UINT8, STR_CHEAT_EDIT_MAX_HL,     &_settings_game.construction.map_height_limit, &_cheats.edit_max_hl.been_used,      &ClickChangeMaxHlCheat   },
  {SLE_INT32, STR_CHEAT_CHANGE_DATE,     &TimerGameCalendar::year,                      &_cheats.change_date.been_used,      &ClickChangeDateCheat    },
};
 
static_assert(CHT_NUM_CHEATS == lengthof(_cheats_ui));
 
static constexpr NWidgetPart _nested_cheat_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CHEATS, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_SHADEBOX, COLOUR_GREY),
    NWidget(WWT_STICKYBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY, WID_C_PANEL), EndContainer(),
};
 
struct CheatWindow : Window {
  int clicked;
  int clicked_widget;
  uint line_height;
  Dimension icon;     
 
  CheatWindow(WindowDesc &desc) : Window(desc)
  {
    this->InitNested();
  }
 
  void OnInit() override
  {
    this->icon = GetSpriteSize(SPR_COMPANY_ICON);
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    if (widget != WID_C_PANEL) return;
 
    const Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
    int y = ir.top;
 
    bool rtl = _current_text_dir == TD_RTL;
    uint button_left = rtl ? ir.right - SETTING_BUTTON_WIDTH : ir.left;
    uint text_left   = ir.left + (rtl ? 0 : WidgetDimensions::scaled.hsep_wide + SETTING_BUTTON_WIDTH);
    uint text_right  = ir.right - (rtl ? WidgetDimensions::scaled.hsep_wide + SETTING_BUTTON_WIDTH : 0);
 
    int text_y_offset = (this->line_height - GetCharacterHeight(FS_NORMAL)) / 2;
    int button_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
    int icon_y_offset = (this->line_height - this->icon.height) / 2;
 
    for (int i = 0; i != lengthof(_cheats_ui); i++) {
      const CheatEntry *ce = &_cheats_ui[i];
 
      switch (ce->type) {
        case SLE_BOOL: {
          bool on = (*(bool*)ce->variable);
 
          DrawBoolButton(button_left, y + button_y_offset, on, true);
          SetDParam(0, on ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
          break;
        }
 
        default: {
          int32_t val = (int32_t)ReadValue(ce->variable, ce->type);
 
          /* Draw [<][>] boxes for settings of an integer-type */
          DrawArrowButtons(button_left, y + button_y_offset, COLOUR_YELLOW, clicked - (i * 2), true, true);
 
          switch (ce->str) {
            /* Display date for change date cheat */
            case STR_CHEAT_CHANGE_DATE: SetDParam(0, TimerGameCalendar::date); break;
 
            /* Draw coloured flag for change company cheat */
            case STR_CHEAT_CHANGE_COMPANY: {
              SetDParam(0, val + 1);
              uint offset = WidgetDimensions::scaled.hsep_indent + GetStringBoundingBox(ce->str).width;
              DrawCompanyIcon(_local_company, rtl ? text_right - offset - WidgetDimensions::scaled.hsep_indent : text_left + offset, y + icon_y_offset);
              break;
            }
 
            default: SetDParam(0, val);
          }
          break;
        }
      }
 
      DrawString(text_left, text_right, y + text_y_offset, ce->str);
 
      y += this->line_height;
    }
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    if (widget != WID_C_PANEL) return;
 
    uint width = 0;
    for (const auto &ce : _cheats_ui) {
      switch (ce.type) {
        case SLE_BOOL:
          SetDParam(0, STR_CONFIG_SETTING_ON);
          width = std::max(width, GetStringBoundingBox(ce.str).width);
          SetDParam(0, STR_CONFIG_SETTING_OFF);
          width = std::max(width, GetStringBoundingBox(ce.str).width);
          break;
 
        default:
          switch (ce.str) {
            /* Display date for change date cheat */
            case STR_CHEAT_CHANGE_DATE:
              SetDParam(0, TimerGameCalendar::ConvertYMDToDate(CalendarTime::MAX_YEAR, 11, 31));
              width = std::max(width, GetStringBoundingBox(ce.str).width);
              break;
 
            /* Draw coloured flag for change company cheat */
            case STR_CHEAT_CHANGE_COMPANY:
              SetDParamMaxValue(0, MAX_COMPANIES);
              width = std::max(width, GetStringBoundingBox(ce.str).width + WidgetDimensions::scaled.hsep_wide);
              break;
 
            default:
              SetDParam(0, INT64_MAX);
              width = std::max(width, GetStringBoundingBox(ce.str).width);
              break;
          }
          break;
      }
    }
 
    this->line_height = std::max<uint>(this->icon.height, SETTING_BUTTON_HEIGHT);
    this->line_height = std::max<uint>(this->line_height, GetCharacterHeight(FS_NORMAL)) + WidgetDimensions::scaled.framerect.Vertical();
 
    size.width = width + WidgetDimensions::scaled.hsep_wide * 2 + SETTING_BUTTON_WIDTH;
    size.height = WidgetDimensions::scaled.framerect.Vertical() + this->line_height * lengthof(_cheats_ui);
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    if (widget != WID_C_PANEL) return;
 
    Rect r = this->GetWidget<NWidgetBase>(WID_C_PANEL)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
    uint btn = (pt.y - r.top) / this->line_height;
    int x = pt.x - r.left;
    bool rtl = _current_text_dir == TD_RTL;
    if (rtl) x = r.Width() - 1 - x;
 
    if (btn >= lengthof(_cheats_ui)) return;
 
    const CheatEntry *ce = &_cheats_ui[btn];
    int value = (int32_t)ReadValue(ce->variable, ce->type);
    int oldvalue = value;
 
    if (btn == CHT_CHANGE_DATE && x >= SETTING_BUTTON_WIDTH) {
      /* Click at the date text directly. */
      clicked_widget = CHT_CHANGE_DATE;
      SetDParam(0, value);
      ShowQueryString(STR_JUST_INT, STR_CHEAT_CHANGE_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
      return;
    } else if (btn == CHT_EDIT_MAX_HL && x >= SETTING_BUTTON_WIDTH) {
      clicked_widget = CHT_EDIT_MAX_HL;
      SetDParam(0, value);
      ShowQueryString(STR_JUST_INT, STR_CHEAT_EDIT_MAX_HL_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
      return;
    }
 
    /* Not clicking a button? */
    if (!IsInsideMM(x, 0, SETTING_BUTTON_WIDTH)) return;
 
    *ce->been_used = true;
 
    switch (ce->type) {
      case SLE_BOOL:
        value ^= 1;
        if (ce->proc != nullptr) ce->proc(value, 0);
        break;
 
      default:
        /* Take whatever the function returns */
        value = ce->proc(value + ((x >= SETTING_BUTTON_WIDTH / 2) ? 1 : -1), (x >= SETTING_BUTTON_WIDTH / 2) ? 1 : -1);
 
        /* The first cheat (money), doesn't return a different value. */
        if (value != oldvalue || btn == CHT_MONEY) this->clicked = btn * 2 + 1 + ((x >= SETTING_BUTTON_WIDTH / 2) != rtl ? 1 : 0);
        break;
    }
 
    if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64_t)value);
 
    this->SetTimeout();
 
    this->SetDirty();
  }
 
  void OnTimeout() override
  {
    this->clicked = 0;
    this->SetDirty();
  }
 
  void OnQueryTextFinished(std::optional<std::string> str) override
  {
    /* Was 'cancel' pressed or nothing entered? */
    if (!str.has_value() || str->empty()) return;
 
    const CheatEntry *ce = &_cheats_ui[clicked_widget];
    int oldvalue = (int32_t)ReadValue(ce->variable, ce->type);
    int value = atoi(str->c_str());
    *ce->been_used = true;
    value = ce->proc(value, value - oldvalue);
 
    if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64_t)value);
    this->SetDirty();
  }
 
  IntervalTimer<TimerGameCalendar> daily_interval = {{TimerGameCalendar::MONTH, TimerGameCalendar::Priority::NONE}, [this](auto) {
    this->SetDirty();
  }};
};
 
static WindowDesc _cheats_desc(
  WDP_AUTO, "cheats", 0, 0,
  WC_CHEATS, WC_NONE,
  0,
  _nested_cheat_widgets
);
 
void ShowCheatWindow()
{
  CloseWindowById(WC_CHEATS, 0);
  new CheatWindow(_cheats_desc);
}