OpenTTD
main_gui.cpp
Go to the documentation of this file.
1 /* $Id: main_gui.cpp 27571 2016-05-22 10:07:48Z 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 "currency.h"
14 #include "spritecache.h"
15 #include "window_gui.h"
16 #include "window_func.h"
17 #include "textbuf_gui.h"
18 #include "viewport_func.h"
19 #include "command_func.h"
20 #include "console_gui.h"
21 #include "progress.h"
22 #include "transparency_gui.h"
23 #include "map_func.h"
24 #include "sound_func.h"
25 #include "transparency.h"
26 #include "strings_func.h"
27 #include "zoom_func.h"
28 #include "company_base.h"
29 #include "company_func.h"
30 #include "toolbar_gui.h"
31 #include "statusbar_gui.h"
33 #include "tilehighlight_func.h"
34 #include "hotkeys.h"
35 
36 #include "saveload/saveload.h"
37 
38 #include "widgets/main_widget.h"
39 
40 #include "network/network.h"
41 #include "network/network_func.h"
42 #include "network/network_gui.h"
43 #include "network/network_base.h"
44 
45 #include "table/sprites.h"
46 #include "table/strings.h"
47 
48 #include "safeguards.h"
49 
50 static int _rename_id = 1;
51 static int _rename_what = -1;
52 
53 void CcGiveMoney(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
54 {
55 #ifdef ENABLE_NETWORK
56  if (result.Failed() || !_settings_game.economy.give_money) return;
57 
58  /* Inform the company of the action of one of its clients (controllers). */
59  char msg[64];
60  SetDParam(0, p2);
61  GetString(msg, STR_COMPANY_NAME, lastof(msg));
62 
63  if (!_network_server) {
64  NetworkClientSendChat(NETWORK_ACTION_GIVE_MONEY, DESTTYPE_TEAM, p2, msg, p1);
65  } else {
66  NetworkServerSendChat(NETWORK_ACTION_GIVE_MONEY, DESTTYPE_TEAM, p2, msg, CLIENT_ID_SERVER, p1);
67  }
68 #endif /* ENABLE_NETWORK */
69 }
70 
71 void HandleOnEditText(const char *str)
72 {
73  switch (_rename_what) {
74 #ifdef ENABLE_NETWORK
75  case 3: { // Give money, you can only give money in excess of loan
77  if (c == NULL) break;
78  Money money = min(c->money - c->current_loan, (Money)(atoi(str) / _currency->rate));
79 
80  uint32 money_c = Clamp(ClampToI32(money), 0, 20000000); // Clamp between 20 million and 0
81 
82  /* Give 'id' the money, and subtract it from ourself */
83  DoCommandP(0, money_c, _rename_id, CMD_GIVE_MONEY | CMD_MSG(STR_ERROR_INSUFFICIENT_FUNDS), CcGiveMoney, str);
84  break;
85  }
86 #endif /* ENABLE_NETWORK */
87  default: NOT_REACHED();
88  }
89 
90  _rename_id = _rename_what = -1;
91 }
92 
103 bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, HighLightStyle mode)
104 {
105  if (w->IsWidgetDisabled(widget)) return false;
106 
107  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
108  w->SetDirty();
109 
110  if (w->IsWidgetLowered(widget)) {
112  return false;
113  }
114 
115  SetObjectToPlace(cursor, PAL_NONE, mode, w->window_class, w->window_number);
116  w->LowerWidget(widget);
117  return true;
118 }
119 
120 
121 void CcPlaySound_EXPLOSION(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
122 {
123  if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_12_EXPLOSION, tile);
124 }
125 
126 #ifdef ENABLE_NETWORK
127 void ShowNetworkGiveMoneyWindow(CompanyID company)
128 {
129  _rename_id = company;
130  _rename_what = 3;
131  ShowQueryString(STR_EMPTY, STR_NETWORK_GIVE_MONEY_CAPTION, 30, NULL, CS_NUMERAL, QSF_NONE);
132 }
133 #endif /* ENABLE_NETWORK */
134 
135 
144 {
145  ViewPort *vp;
146 
147  assert(w != NULL);
148  vp = w->viewport;
149 
150  switch (how) {
151  case ZOOM_NONE:
152  /* On initialisation of the viewport we don't do anything. */
153  break;
154 
155  case ZOOM_IN:
156  if (vp->zoom <= _settings_client.gui.zoom_min) return false;
157  vp->zoom = (ZoomLevel)((int)vp->zoom - 1);
158  vp->virtual_width >>= 1;
159  vp->virtual_height >>= 1;
160 
161  w->viewport->scrollpos_x += vp->virtual_width >> 1;
162  w->viewport->scrollpos_y += vp->virtual_height >> 1;
166  break;
167  case ZOOM_OUT:
168  if (vp->zoom >= _settings_client.gui.zoom_max) return false;
169  vp->zoom = (ZoomLevel)((int)vp->zoom + 1);
170 
171  w->viewport->scrollpos_x -= vp->virtual_width >> 1;
172  w->viewport->scrollpos_y -= vp->virtual_height >> 1;
175 
176  vp->virtual_width <<= 1;
177  vp->virtual_height <<= 1;
179  break;
180  }
181  if (vp != NULL) { // the vp can be null when how == ZOOM_NONE
183  vp->virtual_top = w->viewport->scrollpos_y;
184  }
185  /* Update the windows that have zoom-buttons to perhaps disable their buttons */
186  w->InvalidateData();
187  return true;
188 }
189 
190 void ZoomInOrOutToCursorWindow(bool in, Window *w)
191 {
192  assert(w != NULL);
193 
194  if (_game_mode != GM_MENU) {
195  ViewPort *vp = w->viewport;
196  if ((in && vp->zoom <= _settings_client.gui.zoom_min) || (!in && vp->zoom >= _settings_client.gui.zoom_max)) return;
197 
198  Point pt = GetTileZoomCenterWindow(in, w);
199  if (pt.x != -1) {
200  ScrollWindowTo(pt.x, pt.y, -1, w, true);
201 
203  }
204  }
205 }
206 
207 static const struct NWidgetPart _nested_main_window_widgets[] = {
208  NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_M_VIEWPORT), SetResize(1, 1),
209 };
210 
211 enum {
212  GHK_QUIT,
213  GHK_ABANDON,
214  GHK_CONSOLE,
215  GHK_BOUNDING_BOXES,
216  GHK_DIRTY_BLOCKS,
217  GHK_CENTER,
218  GHK_CENTER_ZOOM,
219  GHK_RESET_OBJECT_TO_PLACE,
220  GHK_DELETE_WINDOWS,
221  GHK_DELETE_NONVITAL_WINDOWS,
222  GHK_REFRESH_SCREEN,
223  GHK_CRASH,
224  GHK_MONEY,
225  GHK_UPDATE_COORDS,
226  GHK_TOGGLE_TRANSPARENCY,
227  GHK_TOGGLE_INVISIBILITY = GHK_TOGGLE_TRANSPARENCY + 9,
228  GHK_TRANSPARENCY_TOOLBAR = GHK_TOGGLE_INVISIBILITY + 8,
229  GHK_TRANSPARANCY,
230  GHK_CHAT,
231  GHK_CHAT_ALL,
232  GHK_CHAT_COMPANY,
233  GHK_CHAT_SERVER,
234 };
235 
237 {
238  uint refresh;
239 
240  static const uint LINKGRAPH_REFRESH_PERIOD = 0xff;
241  static const uint LINKGRAPH_DELAY = 0xf;
242 
243  MainWindow(WindowDesc *desc) : Window(desc)
244  {
245  this->InitNested(0);
246  CLRBITS(this->flags, WF_WHITE_BORDER);
247  ResizeWindow(this, _screen.width, _screen.height);
248 
249  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_M_VIEWPORT);
250  nvp->InitializeViewport(this, TileXY(32, 32), ZOOM_LVL_VIEWPORT);
251 
252  this->viewport->overlay = new LinkGraphOverlay(this, WID_M_VIEWPORT, 0, 0, 3);
253  this->refresh = LINKGRAPH_DELAY;
254  }
255 
256  virtual void OnTick()
257  {
258  if (--this->refresh > 0) return;
259 
260  this->refresh = LINKGRAPH_REFRESH_PERIOD;
261 
262  if (this->viewport->overlay->GetCargoMask() == 0 ||
263  this->viewport->overlay->GetCompanyMask() == 0) {
264  return;
265  }
266 
267  this->viewport->overlay->RebuildCache();
268  this->GetWidget<NWidgetBase>(WID_M_VIEWPORT)->SetDirty(this);
269  }
270 
271  virtual void OnPaint()
272  {
273  this->DrawWidgets();
274  if (_game_mode == GM_MENU) {
275  static const SpriteID title_sprites[] = {SPR_OTTD_O, SPR_OTTD_P, SPR_OTTD_E, SPR_OTTD_N, SPR_OTTD_T, SPR_OTTD_T, SPR_OTTD_D};
276  static const uint LETTER_SPACING = 10;
277  int name_width = (lengthof(title_sprites) - 1) * LETTER_SPACING;
278 
279  for (uint i = 0; i < lengthof(title_sprites); i++) {
280  name_width += GetSpriteSize(title_sprites[i]).width;
281  }
282  int off_x = (this->width - name_width) / 2;
283 
284  for (uint i = 0; i < lengthof(title_sprites); i++) {
285  DrawSprite(title_sprites[i], PAL_NONE, off_x, 50);
286  off_x += GetSpriteSize(title_sprites[i]).width + LETTER_SPACING;
287  }
288  }
289  }
290 
291  virtual EventState OnHotkey(int hotkey)
292  {
293  if (hotkey == GHK_QUIT) {
294  HandleExitGameRequest();
295  return ES_HANDLED;
296  }
297 
298  /* Disable all key shortcuts, except quit shortcuts when
299  * generating the world, otherwise they create threading
300  * problem during the generating, resulting in random
301  * assertions that are hard to trigger and debug */
302  if (HasModalProgress()) return ES_NOT_HANDLED;
303 
304  switch (hotkey) {
305  case GHK_ABANDON:
306  /* No point returning from the main menu to itself */
307  if (_game_mode == GM_MENU) return ES_HANDLED;
309  DoExitSave();
311  } else {
312  AskExitToGameMenu();
313  }
314  return ES_HANDLED;
315 
316  case GHK_CONSOLE:
317  IConsoleSwitch();
318  return ES_HANDLED;
319 
320  case GHK_BOUNDING_BOXES:
322  return ES_HANDLED;
323 
324  case GHK_DIRTY_BLOCKS:
326  return ES_HANDLED;
327  }
328 
329  if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
330 
331  switch (hotkey) {
332  case GHK_CENTER:
333  case GHK_CENTER_ZOOM: {
334  Point pt = GetTileBelowCursor();
335  if (pt.x != -1) {
336  bool instant = (hotkey == GHK_CENTER_ZOOM && this->viewport->zoom != _settings_client.gui.zoom_min);
337  if (hotkey == GHK_CENTER_ZOOM) MaxZoomInOut(ZOOM_IN, this);
338  ScrollMainWindowTo(pt.x, pt.y, -1, instant);
339  }
340  break;
341  }
342 
343  case GHK_RESET_OBJECT_TO_PLACE: ResetObjectToPlace(); break;
344  case GHK_DELETE_WINDOWS: DeleteNonVitalWindows(); break;
345  case GHK_DELETE_NONVITAL_WINDOWS: DeleteAllNonVitalWindows(); break;
346  case GHK_REFRESH_SCREEN: MarkWholeScreenDirty(); break;
347 
348  case GHK_CRASH: // Crash the game
349  *(volatile byte *)0 = 0;
350  break;
351 
352  case GHK_MONEY: // Gimme money
353  /* You can only cheat for money in single player. */
354  if (!_networking) DoCommandP(0, 10000000, 0, CMD_MONEY_CHEAT);
355  break;
356 
357  case GHK_UPDATE_COORDS: // Update the coordinates of all station signs
359  break;
360 
361  case GHK_TOGGLE_TRANSPARENCY:
362  case GHK_TOGGLE_TRANSPARENCY + 1:
363  case GHK_TOGGLE_TRANSPARENCY + 2:
364  case GHK_TOGGLE_TRANSPARENCY + 3:
365  case GHK_TOGGLE_TRANSPARENCY + 4:
366  case GHK_TOGGLE_TRANSPARENCY + 5:
367  case GHK_TOGGLE_TRANSPARENCY + 6:
368  case GHK_TOGGLE_TRANSPARENCY + 7:
369  case GHK_TOGGLE_TRANSPARENCY + 8:
370  /* Transparency toggle hot keys */
371  ToggleTransparency((TransparencyOption)(hotkey - GHK_TOGGLE_TRANSPARENCY));
373  break;
374 
375  case GHK_TOGGLE_INVISIBILITY:
376  case GHK_TOGGLE_INVISIBILITY + 1:
377  case GHK_TOGGLE_INVISIBILITY + 2:
378  case GHK_TOGGLE_INVISIBILITY + 3:
379  case GHK_TOGGLE_INVISIBILITY + 4:
380  case GHK_TOGGLE_INVISIBILITY + 5:
381  case GHK_TOGGLE_INVISIBILITY + 6:
382  case GHK_TOGGLE_INVISIBILITY + 7:
383  /* Invisibility toggle hot keys */
384  ToggleInvisibilityWithTransparency((TransparencyOption)(hotkey - GHK_TOGGLE_INVISIBILITY));
386  break;
387 
388  case GHK_TRANSPARENCY_TOOLBAR:
390  break;
391 
392  case GHK_TRANSPARANCY:
394  break;
395 
396 #ifdef ENABLE_NETWORK
397  case GHK_CHAT: // smart chat; send to team if any, otherwise to all
398  if (_networking) {
400  if (cio == NULL) break;
401 
403  }
404  break;
405 
406  case GHK_CHAT_ALL: // send text message to all clients
408  break;
409 
410  case GHK_CHAT_COMPANY: // send text to all team mates
411  if (_networking) {
413  if (cio == NULL) break;
414 
416  }
417  break;
418 
419  case GHK_CHAT_SERVER: // send text to the server
420  if (_networking && !_network_server) {
422  }
423  break;
424 #endif
425 
426  default: return ES_NOT_HANDLED;
427  }
428  return ES_HANDLED;
429  }
430 
431  virtual void OnScroll(Point delta)
432  {
433  this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
434  this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
437  this->refresh = LINKGRAPH_DELAY;
438  }
439 
440  virtual void OnMouseWheel(int wheel)
441  {
443  ZoomInOrOutToCursorWindow(wheel < 0, this);
444  }
445  }
446 
447  virtual void OnResize()
448  {
449  if (this->viewport != NULL) {
450  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_M_VIEWPORT);
451  nvp->UpdateViewportCoordinates(this);
452  this->refresh = LINKGRAPH_DELAY;
453  }
454  }
455 
461  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
462  {
463  if (!gui_scope) return;
464  /* Forward the message to the appropriate toolbar (ingame or scenario editor) */
465  InvalidateWindowData(WC_MAIN_TOOLBAR, 0, data, true);
466  }
467 
468  static HotkeyList hotkeys;
469 };
470 
471 const uint16 _ghk_quit_keys[] = {'Q' | WKC_CTRL, 'Q' | WKC_META, 0};
472 const uint16 _ghk_abandon_keys[] = {'W' | WKC_CTRL, 'W' | WKC_META, 0};
473 const uint16 _ghk_chat_keys[] = {WKC_RETURN, 'T', 0};
474 const uint16 _ghk_chat_all_keys[] = {WKC_SHIFT | WKC_RETURN, WKC_SHIFT | 'T', 0};
475 const uint16 _ghk_chat_company_keys[] = {WKC_CTRL | WKC_RETURN, WKC_CTRL | 'T', 0};
476 const uint16 _ghk_chat_server_keys[] = {WKC_CTRL | WKC_SHIFT | WKC_RETURN, WKC_CTRL | WKC_SHIFT | 'T', 0};
477 
478 static Hotkey global_hotkeys[] = {
479  Hotkey(_ghk_quit_keys, "quit", GHK_QUIT),
480  Hotkey(_ghk_abandon_keys, "abandon", GHK_ABANDON),
481  Hotkey(WKC_BACKQUOTE, "console", GHK_CONSOLE),
482  Hotkey('B' | WKC_CTRL, "bounding_boxes", GHK_BOUNDING_BOXES),
483  Hotkey('I' | WKC_CTRL, "dirty_blocks", GHK_DIRTY_BLOCKS),
484  Hotkey('C', "center", GHK_CENTER),
485  Hotkey('Z', "center_zoom", GHK_CENTER_ZOOM),
486  Hotkey(WKC_ESC, "reset_object_to_place", GHK_RESET_OBJECT_TO_PLACE),
487  Hotkey(WKC_DELETE, "delete_windows", GHK_DELETE_WINDOWS),
488  Hotkey(WKC_DELETE | WKC_SHIFT, "delete_all_windows", GHK_DELETE_NONVITAL_WINDOWS),
489  Hotkey('R' | WKC_CTRL, "refresh_screen", GHK_REFRESH_SCREEN),
490 #if defined(_DEBUG)
491  Hotkey('0' | WKC_ALT, "crash_game", GHK_CRASH),
492  Hotkey('1' | WKC_ALT, "money", GHK_MONEY),
493  Hotkey('2' | WKC_ALT, "update_coordinates", GHK_UPDATE_COORDS),
494 #endif
495  Hotkey('1' | WKC_CTRL, "transparency_signs", GHK_TOGGLE_TRANSPARENCY),
496  Hotkey('2' | WKC_CTRL, "transparency_trees", GHK_TOGGLE_TRANSPARENCY + 1),
497  Hotkey('3' | WKC_CTRL, "transparency_houses", GHK_TOGGLE_TRANSPARENCY + 2),
498  Hotkey('4' | WKC_CTRL, "transparency_industries", GHK_TOGGLE_TRANSPARENCY + 3),
499  Hotkey('5' | WKC_CTRL, "transparency_buildings", GHK_TOGGLE_TRANSPARENCY + 4),
500  Hotkey('6' | WKC_CTRL, "transparency_bridges", GHK_TOGGLE_TRANSPARENCY + 5),
501  Hotkey('7' | WKC_CTRL, "transparency_structures", GHK_TOGGLE_TRANSPARENCY + 6),
502  Hotkey('8' | WKC_CTRL, "transparency_catenary", GHK_TOGGLE_TRANSPARENCY + 7),
503  Hotkey('9' | WKC_CTRL, "transparency_loading", GHK_TOGGLE_TRANSPARENCY + 8),
504  Hotkey('1' | WKC_CTRL | WKC_SHIFT, "invisibility_signs", GHK_TOGGLE_INVISIBILITY),
505  Hotkey('2' | WKC_CTRL | WKC_SHIFT, "invisibility_trees", GHK_TOGGLE_INVISIBILITY + 1),
506  Hotkey('3' | WKC_CTRL | WKC_SHIFT, "invisibility_houses", GHK_TOGGLE_INVISIBILITY + 2),
507  Hotkey('4' | WKC_CTRL | WKC_SHIFT, "invisibility_industries", GHK_TOGGLE_INVISIBILITY + 3),
508  Hotkey('5' | WKC_CTRL | WKC_SHIFT, "invisibility_buildings", GHK_TOGGLE_INVISIBILITY + 4),
509  Hotkey('6' | WKC_CTRL | WKC_SHIFT, "invisibility_bridges", GHK_TOGGLE_INVISIBILITY + 5),
510  Hotkey('7' | WKC_CTRL | WKC_SHIFT, "invisibility_structures", GHK_TOGGLE_INVISIBILITY + 6),
511  Hotkey('8' | WKC_CTRL | WKC_SHIFT, "invisibility_catenary", GHK_TOGGLE_INVISIBILITY + 7),
512  Hotkey('X' | WKC_CTRL, "transparency_toolbar", GHK_TRANSPARENCY_TOOLBAR),
513  Hotkey('X', "toggle_transparency", GHK_TRANSPARANCY),
514 #ifdef ENABLE_NETWORK
515  Hotkey(_ghk_chat_keys, "chat", GHK_CHAT),
516  Hotkey(_ghk_chat_all_keys, "chat_all", GHK_CHAT_ALL),
517  Hotkey(_ghk_chat_company_keys, "chat_company", GHK_CHAT_COMPANY),
518  Hotkey(_ghk_chat_server_keys, "chat_server", GHK_CHAT_SERVER),
519 #endif
520  HOTKEY_LIST_END
521 };
522 HotkeyList MainWindow::hotkeys("global", global_hotkeys);
523 
524 static WindowDesc _main_window_desc(
525  WDP_MANUAL, NULL, 0, 0,
527  0,
528  _nested_main_window_widgets, lengthof(_nested_main_window_widgets),
529  &MainWindow::hotkeys
530 );
531 
537 bool IsQuitKey(uint16 keycode)
538 {
539  int num = MainWindow::hotkeys.CheckMatch(keycode);
540  return num == GHK_QUIT;
541 }
542 
543 
544 void ShowSelectGameWindow();
545 
550 {
551  for (uint i = 0; i != 16; i++) {
552  const byte *b = GetNonSprite(PALETTE_RECOLOUR_START + i, ST_RECOLOUR);
553 
554  assert(b);
555  memcpy(_colour_gradient[i], b + 0xC6, sizeof(_colour_gradient[i]));
556  }
557 
558  new MainWindow(&_main_window_desc);
559 
560  /* XXX: these are not done */
561  switch (_game_mode) {
562  default: NOT_REACHED();
563  case GM_MENU:
564  ShowSelectGameWindow();
565  break;
566 
567  case GM_NORMAL:
568  case GM_EDITOR:
570  break;
571  }
572 }
573 
578 {
579  AllocateToolbar();
580 
581  /* Status bad only for normal games */
582  if (_game_mode == GM_EDITOR) return;
583 
584  ShowStatusBar();
585 }
586 
592 {
593  _cur_resolution.width = _screen.width;
594  _cur_resolution.height = _screen.height;
595  ScreenSizeChanged();
596  RelocateAllWindows(_screen.width, _screen.height);
598 }