OpenTTD
cheat_gui.cpp
Go to the documentation of this file.
1 /* $Id: cheat_gui.cpp 26956 2014-10-04 19:52:23Z peter1138 $ */
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) {
130 
131  /* Check if at least one mountain on the map is higher than the new value.
132  * If yes, disallow the change. */
133  for (TileIndex t = 0; t < MapSize(); t++) {
134  if ((int32)TileHeight(t) > p1) {
135  ShowErrorMessage(STR_CONFIG_SETTING_TOO_HIGH_MOUNTAIN, INVALID_STRING_ID, WL_ERROR);
136  /* Return old, unchanged value */
138  }
139  }
140 
141  /* Execute the change and reload GRF Data */
144 
145  /* The smallmap uses an index from heightlevels to colours. Trigger rebuilding it. */
147 
149 }
150 
161 
163 };
164 
170 typedef int32 CheckButtonClick(int32 p1, int32 p2);
171 
173 struct CheatEntry {
174  VarType type;
176  void *variable;
177  bool *been_used;
179 };
180 
185 static const CheatEntry _cheats_ui[] = {
186  {SLE_INT32, STR_CHEAT_MONEY, &_money_cheat_amount, &_cheats.money.been_used, &ClickMoneyCheat },
187  {SLE_UINT8, STR_CHEAT_CHANGE_COMPANY, &_local_company, &_cheats.switch_company.been_used, &ClickChangeCompanyCheat },
188  {SLE_BOOL, STR_CHEAT_EXTRA_DYNAMITE, &_cheats.magic_bulldozer.value, &_cheats.magic_bulldozer.been_used, NULL },
189  {SLE_BOOL, STR_CHEAT_CROSSINGTUNNELS, &_cheats.crossing_tunnels.value, &_cheats.crossing_tunnels.been_used, NULL },
190  {SLE_BOOL, STR_CHEAT_NO_JETCRASH, &_cheats.no_jetcrash.value, &_cheats.no_jetcrash.been_used, NULL },
191  {SLE_BOOL, STR_CHEAT_SETUP_PROD, &_cheats.setup_prod.value, &_cheats.setup_prod.been_used, &ClickSetProdCheat },
193  {SLE_INT32, STR_CHEAT_CHANGE_DATE, &_cur_year, &_cheats.change_date.been_used, &ClickChangeDateCheat },
194 };
195 
196 assert_compile(CHT_NUM_CHEATS == lengthof(_cheats_ui));
197 
201  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
202  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CHEATS, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
203  NWidget(WWT_SHADEBOX, COLOUR_GREY),
204  NWidget(WWT_STICKYBOX, COLOUR_GREY),
205  EndContainer(),
206  NWidget(WWT_PANEL, COLOUR_GREY, WID_C_PANEL), SetDataTip(0x0, STR_CHEATS_TOOLTIP), EndContainer(),
207 };
208 
210 struct CheatWindow : Window {
211  int clicked;
212  int header_height;
213  int clicked_widget;
214  uint line_height;
215  int box_width;
216 
217  CheatWindow(WindowDesc *desc) : Window(desc)
218  {
219  this->box_width = GetSpriteSize(SPR_BOX_EMPTY).width;
220  this->InitNested();
221  }
222 
223  virtual void DrawWidget(const Rect &r, int widget) const
224  {
225  if (widget != WID_C_PANEL) return;
226 
227  int y = r.top + WD_FRAMERECT_TOP + this->header_height;
228  DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, y, STR_CHEATS_WARNING, TC_FROMSTRING, SA_CENTER);
229 
230  bool rtl = _current_text_dir == TD_RTL;
231  uint box_left = rtl ? r.right - this->box_width - 5 : r.left + 5;
232  uint button_left = rtl ? r.right - this->box_width - 10 - SETTING_BUTTON_WIDTH : r.left + this->box_width + 10;
233  uint text_left = r.left + (rtl ? WD_FRAMERECT_LEFT : 20 + this->box_width + SETTING_BUTTON_WIDTH);
234  uint text_right = r.right - (rtl ? 20 + this->box_width + SETTING_BUTTON_WIDTH : WD_FRAMERECT_RIGHT);
235 
236  int text_y_offset = (this->line_height - FONT_HEIGHT_NORMAL) / 2;
237  int icon_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
238 
239  for (int i = 0; i != lengthof(_cheats_ui); i++) {
240  const CheatEntry *ce = &_cheats_ui[i];
241 
242  DrawSprite((*ce->been_used) ? SPR_BOX_CHECKED : SPR_BOX_EMPTY, PAL_NONE, box_left, y + icon_y_offset + 2);
243 
244  switch (ce->type) {
245  case SLE_BOOL: {
246  bool on = (*(bool*)ce->variable);
247 
248  DrawBoolButton(button_left, y + icon_y_offset, on, true);
249  SetDParam(0, on ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
250  break;
251  }
252 
253  default: {
254  int32 val = (int32)ReadValue(ce->variable, ce->type);
255  char buf[512];
256 
257  /* Draw [<][>] boxes for settings of an integer-type */
258  DrawArrowButtons(button_left, y + icon_y_offset, COLOUR_YELLOW, clicked - (i * 2), true, true);
259 
260  switch (ce->str) {
261  /* Display date for change date cheat */
262  case STR_CHEAT_CHANGE_DATE: SetDParam(0, _date); break;
263 
264  /* Draw coloured flag for change company cheat */
265  case STR_CHEAT_CHANGE_COMPANY: {
266  SetDParam(0, val + 1);
267  GetString(buf, STR_CHEAT_CHANGE_COMPANY, lastof(buf));
268  uint offset = 10 + GetStringBoundingBox(buf).width;
269  DrawCompanyIcon(_local_company, rtl ? text_right - offset - 10 : text_left + offset, y + icon_y_offset + 2);
270  break;
271  }
272 
273  default: SetDParam(0, val);
274  }
275  break;
276  }
277  }
278 
279  DrawString(text_left, text_right, y + text_y_offset, ce->str);
280 
281  y += this->line_height;
282  }
283  }
284 
285  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
286  {
287  if (widget != WID_C_PANEL) return;
288 
289  uint width = 0;
290  for (int i = 0; i != lengthof(_cheats_ui); i++) {
291  const CheatEntry *ce = &_cheats_ui[i];
292  switch (ce->type) {
293  case SLE_BOOL:
294  SetDParam(0, STR_CONFIG_SETTING_ON);
295  width = max(width, GetStringBoundingBox(ce->str).width);
296  SetDParam(0, STR_CONFIG_SETTING_OFF);
297  width = max(width, GetStringBoundingBox(ce->str).width);
298  break;
299 
300  default:
301  switch (ce->str) {
302  /* Display date for change date cheat */
303  case STR_CHEAT_CHANGE_DATE:
304  SetDParam(0, ConvertYMDToDate(MAX_YEAR, 11, 31));
305  width = max(width, GetStringBoundingBox(ce->str).width);
306  break;
307 
308  /* Draw coloured flag for change company cheat */
309  case STR_CHEAT_CHANGE_COMPANY:
311  width = max(width, GetStringBoundingBox(ce->str).width + 10 + 10);
312  break;
313 
314  default:
315  SetDParam(0, INT64_MAX);
316  width = max(width, GetStringBoundingBox(ce->str).width);
317  break;
318  }
319  break;
320  }
321  }
322 
323  this->line_height = max(GetSpriteSize(SPR_BOX_CHECKED).height, GetSpriteSize(SPR_BOX_EMPTY).height);
324  this->line_height = max<uint>(this->line_height, SETTING_BUTTON_HEIGHT);
325  this->line_height = max<uint>(this->line_height, FONT_HEIGHT_NORMAL) + WD_PAR_VSEP_NORMAL;
326 
327  size->width = width + 20 + this->box_width + SETTING_BUTTON_WIDTH /* stuff on the left */ + 10 /* extra spacing on right */;
328  this->header_height = GetStringHeight(STR_CHEATS_WARNING, size->width - WD_FRAMERECT_LEFT - WD_FRAMERECT_RIGHT) + WD_PAR_VSEP_WIDE;
329  size->height = this->header_height + WD_FRAMERECT_TOP + WD_PAR_VSEP_NORMAL + WD_FRAMERECT_BOTTOM + this->line_height * lengthof(_cheats_ui);
330  }
331 
332  virtual void OnClick(Point pt, int widget, int click_count)
333  {
334  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_C_PANEL);
335  uint btn = (pt.y - wid->pos_y - WD_FRAMERECT_TOP - this->header_height) / this->line_height;
336  int x = pt.x - wid->pos_x;
337  bool rtl = _current_text_dir == TD_RTL;
338  if (rtl) x = wid->current_x - x;
339 
340  if (btn >= lengthof(_cheats_ui)) return;
341 
342  const CheatEntry *ce = &_cheats_ui[btn];
343  int value = (int32)ReadValue(ce->variable, ce->type);
344  int oldvalue = value;
345 
346  if (btn == CHT_CHANGE_DATE && x >= 20 + this->box_width + SETTING_BUTTON_WIDTH) {
347  /* Click at the date text directly. */
348  clicked_widget = CHT_CHANGE_DATE;
349  SetDParam(0, value);
350  ShowQueryString(STR_JUST_INT, STR_CHEAT_CHANGE_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
351  return;
352  } else if (btn == CHT_EDIT_MAX_HL && x >= 20 + this->box_width + SETTING_BUTTON_WIDTH) {
353  clicked_widget = CHT_EDIT_MAX_HL;
354  SetDParam(0, value);
355  ShowQueryString(STR_JUST_INT, STR_CHEAT_EDIT_MAX_HL_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ACCEPT_UNCHANGED);
356  return;
357  }
358 
359  /* Not clicking a button? */
360  if (!IsInsideMM(x, 10 + this->box_width, 10 + this->box_width + SETTING_BUTTON_WIDTH)) return;
361 
362  *ce->been_used = true;
363 
364  switch (ce->type) {
365  case SLE_BOOL:
366  value ^= 1;
367  if (ce->proc != NULL) ce->proc(value, 0);
368  break;
369 
370  default:
371  /* Take whatever the function returns */
372  value = ce->proc(value + ((x >= 20 + SETTING_BUTTON_WIDTH / 2) ? 1 : -1), (x >= 10 + this->box_width + SETTING_BUTTON_WIDTH / 2) ? 1 : -1);
373 
374  /* The first cheat (money), doesn't return a different value. */
375  if (value != oldvalue || btn == CHT_MONEY) this->clicked = btn * 2 + 1 + ((x >= 10 + this->box_width + SETTING_BUTTON_WIDTH / 2) != rtl ? 1 : 0);
376  break;
377  }
378 
379  if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64)value);
380 
381  this->SetTimeout();
382 
383  this->SetDirty();
384  }
385 
386  virtual void OnTimeout()
387  {
388  this->clicked = 0;
389  this->SetDirty();
390  }
391 
392  virtual void OnQueryTextFinished(char *str)
393  {
394  /* Was 'cancel' pressed or nothing entered? */
395  if (str == NULL || StrEmpty(str)) return;
396 
397  const CheatEntry *ce = &_cheats_ui[clicked_widget];
398  int oldvalue = (int32)ReadValue(ce->variable, ce->type);
399  int value = atoi(str);
400  *ce->been_used = true;
401  value = ce->proc(value, value - oldvalue);
402 
403  if (value != oldvalue) WriteValue(ce->variable, ce->type, (int64)value);
404  this->SetDirty();
405  }
406 };
407 
409 static WindowDesc _cheats_desc(
410  WDP_AUTO, "cheats", 0, 0,
412  0,
413  _nested_cheat_widgets, lengthof(_nested_cheat_widgets)
414 );
415 
418 {
421 }