OpenTTD
cheat_gui.cpp
Go to the documentation of this file.
1 /* $Id: cheat_gui.cpp 27178 2015-03-07 18:27:01Z frosch $ */
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 
12 #include "stdafx.h"
13 #include "command_func.h"
14 #include "cheat_type.h"
15 #include "company_base.h"
16 #include "company_func.h"
17 #include "date_func.h"
18 #include "saveload/saveload.h"
19 #include "textbuf_gui.h"
20 #include "window_gui.h"
21 #include "string_func.h"
22 #include "strings_func.h"
23 #include "window_func.h"
24 #include "rail_gui.h"
25 #include "settings_gui.h"
26 #include "company_gui.h"
28 #include "map_func.h"
29 #include "tile_map.h"
30 #include "newgrf.h"
31 #include "error.h"
32 
33 #include "widgets/cheat_widget.h"
34 
35 #include "table/sprites.h"
36 
37 #include "safeguards.h"
38 
39 
45 static int32 _money_cheat_amount = 10000000;
46 
56 static int32 ClickMoneyCheat(int32 p1, int32 p2)
57 {
58  DoCommandP(0, (uint32)(p2 * _money_cheat_amount), 0, CMD_MONEY_CHEAT);
59  return _money_cheat_amount;
60 }
61 
68 static int32 ClickChangeCompanyCheat(int32 p1, int32 p2)
69 {
70  while ((uint)p1 < Company::GetPoolSize()) {
71  if (Company::IsValidID((CompanyID)p1)) {
73  return _local_company;
74  }
75  p1 += p2;
76  }
77 
78  return _local_company;
79 }
80 
87 static int32 ClickSetProdCheat(int32 p1, int32 p2)
88 {
89  _cheats.setup_prod.value = (p1 != 0);
91  return _cheats.setup_prod.value;
92 }
93 
94 extern void EnginesMonthlyLoop();
95 
102 static int32 ClickChangeDateCheat(int32 p1, int32 p2)
103 {
104  YearMonthDay ymd;
105  ConvertDateToYMD(_date, &ymd);
106 
107  p1 = Clamp(p1, MIN_YEAR, MAX_YEAR);
108  if (p1 == _cur_year) return _cur_year;
109 
110  Date new_date = ConvertYMDToDate(p1, ymd.month, ymd.day);
112  SetDate(new_date, _date_fract);
118  return _cur_year;
119 }
120 
128 static int32 ClickChangeMaxHlCheat(int32 p1, int32 p2)
129 {
131 
132  /* Check if at least one mountain on the map is higher than the new value.
133  * If yes, disallow the change. */
134  for (TileIndex t = 0; t < MapSize(); t++) {
135  if ((int32)TileHeight(t) > p1) {
136  ShowErrorMessage(STR_CONFIG_SETTING_TOO_HIGH_MOUNTAIN, INVALID_STRING_ID, WL_ERROR);
137  /* Return old, unchanged value */
139  }
140  }
141 
142  /* Execute the change and reload GRF Data */
145 
146  /* The smallmap uses an index from heightlevels to colours. Trigger rebuilding it. */
148 
150 }
151 
162 
164 };
165 
171 typedef int32 CheckButtonClick(int32 p1, int32 p2);
172 
174 struct CheatEntry {
175  VarType type;
177  void *variable;
178  bool *been_used;
180 };
181 
186 static const CheatEntry _cheats_ui[] = {
187  {SLE_INT32, STR_CHEAT_MONEY, &_money_cheat_amount, &_cheats.money.been_used, &ClickMoneyCheat },
188  {SLE_UINT8, STR_CHEAT_CHANGE_COMPANY, &_local_company, &_cheats.switch_company.been_used, &ClickChangeCompanyCheat },
189  {SLE_BOOL, STR_CHEAT_EXTRA_DYNAMITE, &_cheats.magic_bulldozer.value, &_cheats.magic_bulldozer.been_used, NULL },
190  {SLE_BOOL, STR_CHEAT_CROSSINGTUNNELS, &_cheats.crossing_tunnels.value, &_cheats.crossing_tunnels.been_used, NULL },
191  {SLE_BOOL, STR_CHEAT_NO_JETCRASH, &_cheats.no_jetcrash.value, &_cheats.no_jetcrash.been_used, NULL },
192  {SLE_BOOL, STR_CHEAT_SETUP_PROD, &_cheats.setup_prod.value, &_cheats.setup_prod.been_used, &ClickSetProdCheat },
194  {SLE_INT32, STR_CHEAT_CHANGE_DATE, &_cur_year, &_cheats.change_date.been_used, &ClickChangeDateCheat },
195 };
196 
197 assert_compile(CHT_NUM_CHEATS == lengthof(_cheats_ui));
198 
202  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
203  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CHEATS, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
204  NWidget(WWT_SHADEBOX, COLOUR_GREY),
205  NWidget(WWT_STICKYBOX, COLOUR_GREY),
206  EndContainer(),
207  NWidget(WWT_PANEL, COLOUR_GREY, WID_C_PANEL), SetDataTip(0x0, STR_CHEATS_TOOLTIP), EndContainer(),
208 };
209 
211 struct CheatWindow : Window {
212  int clicked;
213  int header_height;
214  int clicked_widget;
215  uint line_height;
216  int box_width;
217 
218  CheatWindow(WindowDesc *desc) : Window(desc)
219  {
220  this->box_width = GetSpriteSize(SPR_BOX_EMPTY).width;
221  this->InitNested();
222  }
223 
224  virtual void DrawWidget(const Rect &r, int widget) const
225  {
226  if (widget != WID_C_PANEL) return;
227 
228  int y = r.top + WD_FRAMERECT_TOP + this->header_height;
229  DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, y, STR_CHEATS_WARNING, TC_FROMSTRING, SA_CENTER);
230 
231  bool rtl = _current_text_dir == TD_RTL;
232  uint box_left = rtl ? r.right - this->box_width - 5 : r.left + 5;
233  uint button_left = rtl ? r.right - this->box_width - 10 - SETTING_BUTTON_WIDTH : r.left + this->box_width + 10;
234  uint text_left = r.left + (rtl ? WD_FRAMERECT_LEFT : 20 + this->box_width + SETTING_BUTTON_WIDTH);
235  uint text_right = r.right - (rtl ? 20 + this->box_width + SETTING_BUTTON_WIDTH : WD_FRAMERECT_RIGHT);
236 
237  int text_y_offset = (this->line_height - FONT_HEIGHT_NORMAL) / 2;
238  int icon_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
239 
240  for (int i = 0; i != lengthof(_cheats_ui); i++) {
241  const CheatEntry *ce = &_cheats_ui[i];
242 
243  DrawSprite((*ce->been_used) ? SPR_BOX_CHECKED : SPR_BOX_EMPTY, PAL_NONE, box_left, y + icon_y_offset + 2);
244 
245  switch (ce->type) {
246  case SLE_BOOL: {
247  bool on = (*(bool*)ce->variable);
248 
249  DrawBoolButton(button_left, y + icon_y_offset, on, true);
250  SetDParam(0, on ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
251  break;
252  }
253 
254  default: {
255  int32 val = (int32)ReadValue(ce->variable, ce->type);
256  char buf[512];
257 
258  /* Draw [<][>] boxes for settings of an integer-type */
259  DrawArrowButtons(button_left, y + icon_y_offset, COLOUR_YELLOW, clicked - (i * 2), true, true);
260 
261  switch (ce->str) {
262  /* Display date for change date cheat */
263  case STR_CHEAT_CHANGE_DATE: SetDParam(0, _date); break;
264 
265  /* Draw coloured flag for change company cheat */
266  case STR_CHEAT_CHANGE_COMPANY: {
267  SetDParam(0, val + 1);
268  GetString(buf, STR_CHEAT_CHANGE_COMPANY, lastof(buf));
269  uint offset = 10 + GetStringBoundingBox(buf).width;
270  DrawCompanyIcon(_local_company, rtl ? text_right - offset - 10 : text_left + offset, y + icon_y_offset + 2);
271  break;
272  }
273 
274  default: SetDParam(0, val);
275  }
276  break;
277  }
278  }
279 
280  DrawString(text_left, text_right, y + text_y_offset, ce->str);
281 
282  y += this->line_height;
283  }
284  }
285 
286  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
287  {
288  if (widget != WID_C_PANEL) return;
289 
290  uint width = 0;
291  for (int i = 0; i != lengthof(_cheats_ui); i++) {
292  const CheatEntry *ce = &_cheats_ui[i];
293  switch (ce->type) {
294  case SLE_BOOL:
295  SetDParam(0, STR_CONFIG_SETTING_ON);
296  width = max(width, GetStringBoundingBox(ce->str).width);
297  SetDParam(0, STR_CONFIG_SETTING_OFF);
298  width = max(width, GetStringBoundingBox(ce->str).width);
299  break;
300 
301  default:
302  switch (ce->str) {
303  /* Display date for change date cheat */
304  case STR_CHEAT_CHANGE_DATE:
305  SetDParam(0, ConvertYMDToDate(MAX_YEAR, 11, 31));
306  width = max(width, GetStringBoundingBox(ce->str).width);
307  break;
308 
309  /* Draw coloured flag for change company cheat */
310  case STR_CHEAT_CHANGE_COMPANY:
312  width = max(width, GetStringBoundingBox(ce->str).width + 10 + 10);
313  break;
314 
315  default:
316  SetDParam(0, INT64_MAX);
317  width = max(width, GetStringBoundingBox(ce->str).width);
318  break;
319  }
320  break;
321  }
322  }
323 
324  this->line_height = max(GetSpriteSize(SPR_BOX_CHECKED).height, GetSpriteSize(SPR_BOX_EMPTY).height);
325  this->line_height = max<uint>(this->line_height, SETTING_BUTTON_HEIGHT);
326  this->line_height = max<uint>(this->line_height, FONT_HEIGHT_NORMAL) + WD_PAR_VSEP_NORMAL;
327 
328  size->width = width + 20 + this->box_width + SETTING_BUTTON_WIDTH /* stuff on the left */ + 10 /* extra spacing on right */;
329  this->header_height = GetStringHeight(STR_CHEATS_WARNING, size->width - WD_FRAMERECT_LEFT - WD_FRAMERECT_RIGHT) + WD_PAR_VSEP_WIDE;
330  size->height = this->header_height + WD_FRAMERECT_TOP + WD_PAR_VSEP_NORMAL + WD_FRAMERECT_BOTTOM + this->line_height * lengthof(_cheats_ui);
331  }
332 
333  virtual void OnClick(Point pt, int widget, int click_count)
334  {
335  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_C_PANEL);
336  uint btn = (pt.y - wid->pos_y - WD_FRAMERECT_TOP - this->header_height) / this->line_height;
337  int x = pt.x - wid->pos_x;
338  bool rtl = _current_text_dir == TD_RTL;
339  if (rtl) x = wid->current_x - x;
340 
341  if (btn >= lengthof(_cheats_ui)) return;
342 
343  const CheatEntry *ce = &_cheats_ui[btn];
344  int value = (int32)ReadValue(ce->variable, ce->type);
345  int oldvalue = value;
346 
347  if (btn == CHT_CHANGE_DATE && x >= 20 + this->box_width + SETTING_BUTTON_WIDTH) {
348  /* Click at the date text directly. */
349  clicked_widget = CHT_CHANGE_DATE;
350  SetDParam(0, value);
351  ShowQueryString(STR_JUST_INT, STR_CHEAT_CHANGE_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
352  return;
353  } else if (btn == CHT_EDIT_MAX_HL && x >= 20 + this->box_width + SETTING_BUTTON_WIDTH) {
354  clicked_widget = CHT_EDIT_MAX_HL;
355  SetDParam(0, value);
356  ShowQueryString(STR_JUST_INT, STR_CHEAT_EDIT_MAX_HL_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
357  return;
358  }
359 
360  /* Not clicking a button? */
361  if (!IsInsideMM(x, 10 + this->box_width, 10 + this->box_width + SETTING_BUTTON_WIDTH)) return;
362 
363  *ce->been_used = true;
364 
365  switch (ce->type) {
366  case SLE_BOOL:
367  value ^= 1;
368  if (ce->proc != NULL) ce->proc(value, 0);
369  break;
370 
371  default:
372  /* Take whatever the function returns */
373  value = ce->proc(value + ((x >= 20 + SETTING_BUTTON_WIDTH / 2) ? 1 : -1), (x >= 10 + this->box_width + SETTING_BUTTON_WIDTH / 2) ? 1 : -1);
374 
375  /* The first cheat (money), doesn't return a different value. */
376  if (value != oldvalue || btn == CHT_MONEY) this->clicked = btn * 2 + 1 + ((x >= 10 + this->box_width + SETTING_BUTTON_WIDTH / 2) != rtl ? 1 : 0);
377  break;
378  }
379 
380  if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64)value);
381 
382  this->SetTimeout();
383 
384  this->SetDirty();
385  }
386 
387  virtual void OnTimeout()
388  {
389  this->clicked = 0;
390  this->SetDirty();
391  }
392 
393  virtual void OnQueryTextFinished(char *str)
394  {
395  /* Was 'cancel' pressed or nothing entered? */
396  if (str == NULL || StrEmpty(str)) return;
397 
398  const CheatEntry *ce = &_cheats_ui[clicked_widget];
399  int oldvalue = (int32)ReadValue(ce->variable, ce->type);
400  int value = atoi(str);
401  *ce->been_used = true;
402  value = ce->proc(value, value - oldvalue);
403 
404  if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64)value);
405  this->SetDirty();
406  }
407 };
408 
410 static WindowDesc _cheats_desc(
411  WDP_AUTO, "cheats", 0, 0,
413  0,
414  _nested_cheat_widgets, lengthof(_nested_cheat_widgets)
415 );
416 
419 {
422 }