OpenTTD
town_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "town.h"
12 #include "viewport_func.h"
13 #include "error.h"
14 #include "gui.h"
15 #include "command_func.h"
16 #include "company_func.h"
17 #include "company_base.h"
18 #include "company_gui.h"
19 #include "network/network.h"
20 #include "string_func.h"
21 #include "strings_func.h"
22 #include "sound_func.h"
23 #include "tilehighlight_func.h"
24 #include "sortlist_type.h"
25 #include "road_cmd.h"
26 #include "landscape.h"
27 #include "querystring_gui.h"
28 #include "window_func.h"
29 #include "townname_func.h"
30 #include "core/geometry_func.hpp"
31 #include "genworld.h"
32 #include "stringfilter_type.h"
33 #include "widgets/dropdown_func.h"
34 #include "town_kdtree.h"
35 
36 #include "widgets/town_widget.h"
37 
38 #include "table/strings.h"
39 
40 #include "safeguards.h"
41 
42 TownKdtree _town_local_authority_kdtree(&Kdtree_TownXYFunc);
43 
45 
46 static const NWidgetPart _nested_town_authority_widgets[] = {
48  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
49  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_TA_CAPTION), SetDataTip(STR_LOCAL_AUTHORITY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
50  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_TA_ZONE_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_LOCAL_AUTHORITY_ZONE, STR_LOCAL_AUTHORITY_ZONE_TOOLTIP),
51  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
52  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
53  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
54  EndContainer(),
55  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TA_RATING_INFO), SetMinimalSize(317, 92), SetResize(1, 1), EndContainer(),
57  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TA_COMMAND_LIST), SetMinimalSize(305, 52), SetResize(1, 0), SetDataTip(0x0, STR_LOCAL_AUTHORITY_ACTIONS_TOOLTIP), SetScrollbar(WID_TA_SCROLLBAR), EndContainer(),
59  EndContainer(),
60  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TA_ACTION_INFO), SetMinimalSize(317, 52), SetResize(1, 0), EndContainer(),
62  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TA_EXECUTE), SetMinimalSize(317, 12), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_LOCAL_AUTHORITY_DO_IT_BUTTON, STR_LOCAL_AUTHORITY_DO_IT_TOOLTIP),
63  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
64  EndContainer()
65 };
66 
69 private:
71  int sel_index;
72  Scrollbar *vscroll;
74 
84  static int GetNthSetBit(uint32 bits, int n)
85  {
86  if (n >= 0) {
87  uint i;
88  FOR_EACH_SET_BIT(i, bits) {
89  n--;
90  if (n < 0) return i;
91  }
92  }
93  return -1;
94  }
95 
96 public:
98  {
99  this->town = Town::Get(window_number);
100  this->InitNested(window_number);
101  this->vscroll = this->GetScrollbar(WID_TA_SCROLLBAR);
102  this->vscroll->SetCapacity((this->GetWidget<NWidgetBase>(WID_TA_COMMAND_LIST)->current_y - WD_FRAMERECT_TOP - WD_FRAMERECT_BOTTOM) / FONT_HEIGHT_NORMAL);
103  }
104 
105  void OnPaint() override
106  {
107  int numact;
108  uint buttons = GetMaskOfTownActions(&numact, _local_company, this->town);
109  if (buttons != displayed_actions_on_previous_painting) this->SetDirty();
110  displayed_actions_on_previous_painting = buttons;
111 
112  this->vscroll->SetCount(numact + 1);
113 
114  if (this->sel_index != -1 && !HasBit(buttons, this->sel_index)) {
115  this->sel_index = -1;
116  }
117 
119  this->SetWidgetDisabledState(WID_TA_EXECUTE, this->sel_index == -1);
120 
121  this->DrawWidgets();
122  if (!this->IsShaded()) this->DrawRatings();
123  }
124 
126  void DrawRatings()
127  {
128  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_TA_RATING_INFO);
129  uint left = nwid->pos_x + WD_FRAMERECT_LEFT;
130  uint right = nwid->pos_x + nwid->current_x - 1 - WD_FRAMERECT_RIGHT;
131 
132  uint y = nwid->pos_y + WD_FRAMERECT_TOP;
133 
134  DrawString(left, right, y, STR_LOCAL_AUTHORITY_COMPANY_RATINGS);
135  y += FONT_HEIGHT_NORMAL;
136 
137  Dimension icon_size = GetSpriteSize(SPR_COMPANY_ICON);
138  int icon_width = icon_size.width;
139  int icon_y_offset = (FONT_HEIGHT_NORMAL - icon_size.height) / 2;
140 
141  Dimension exclusive_size = GetSpriteSize(SPR_EXCLUSIVE_TRANSPORT);
142  int exclusive_width = exclusive_size.width;
143  int exclusive_y_offset = (FONT_HEIGHT_NORMAL - exclusive_size.height) / 2;
144 
145  bool rtl = _current_text_dir == TD_RTL;
146  uint text_left = left + (rtl ? 0 : icon_width + exclusive_width + 4);
147  uint text_right = right - (rtl ? icon_width + exclusive_width + 4 : 0);
148  uint icon_left = rtl ? right - icon_width : left;
149  uint exclusive_left = rtl ? right - icon_width - exclusive_width - 2 : left + icon_width + 2;
150 
151  /* Draw list of companies */
152  for (const Company *c : Company::Iterate()) {
153  if ((HasBit(this->town->have_ratings, c->index) || this->town->exclusivity == c->index)) {
154  DrawCompanyIcon(c->index, icon_left, y + icon_y_offset);
155 
156  SetDParam(0, c->index);
157  SetDParam(1, c->index);
158 
159  int r = this->town->ratings[c->index];
160  StringID str = STR_CARGO_RATING_APPALLING;
161  if (r > RATING_APPALLING) str++;
162  if (r > RATING_VERYPOOR) str++;
163  if (r > RATING_POOR) str++;
164  if (r > RATING_MEDIOCRE) str++;
165  if (r > RATING_GOOD) str++;
166  if (r > RATING_VERYGOOD) str++;
167  if (r > RATING_EXCELLENT) str++;
168 
169  SetDParam(2, str);
170  if (this->town->exclusivity == c->index) {
171  DrawSprite(SPR_EXCLUSIVE_TRANSPORT, COMPANY_SPRITE_COLOUR(c->index), exclusive_left, y + exclusive_y_offset);
172  }
173 
174  DrawString(text_left, text_right, y, STR_LOCAL_AUTHORITY_COMPANY_RATING);
175  y += FONT_HEIGHT_NORMAL;
176  }
177  }
178 
179  y = y + WD_FRAMERECT_BOTTOM - nwid->pos_y; // Compute needed size of the widget.
180  if (y > nwid->current_y) {
181  /* If the company list is too big to fit, mark ourself dirty and draw again. */
182  ResizeWindow(this, 0, y - nwid->current_y, false);
183  }
184  }
185 
186  void SetStringParameters(int widget) const override
187  {
188  if (widget == WID_TA_CAPTION) SetDParam(0, this->window_number);
189  }
190 
191  void DrawWidget(const Rect &r, int widget) const override
192  {
193  switch (widget) {
194  case WID_TA_ACTION_INFO:
195  if (this->sel_index != -1) {
196  SetDParam(0, _price[PR_TOWN_ACTION] * _town_action_costs[this->sel_index] >> 8);
198  STR_LOCAL_AUTHORITY_ACTION_TOOLTIP_SMALL_ADVERTISING + this->sel_index);
199  }
200  break;
201  case WID_TA_COMMAND_LIST: {
202  int numact;
203  uint buttons = GetMaskOfTownActions(&numact, _local_company, this->town);
204  int y = r.top + WD_FRAMERECT_TOP;
205  int pos = this->vscroll->GetPosition();
206 
207  if (--pos < 0) {
208  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_LOCAL_AUTHORITY_ACTIONS_TITLE);
209  y += FONT_HEIGHT_NORMAL;
210  }
211 
212  for (int i = 0; buttons; i++, buttons >>= 1) {
213  if (pos <= -5) break;
214 
215  if ((buttons & 1) && --pos < 0) {
216  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y,
217  STR_LOCAL_AUTHORITY_ACTION_SMALL_ADVERTISING_CAMPAIGN + i, this->sel_index == i ? TC_WHITE : TC_ORANGE);
218  y += FONT_HEIGHT_NORMAL;
219  }
220  }
221  break;
222  }
223  }
224  }
225 
226  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
227  {
228  switch (widget) {
229  case WID_TA_ACTION_INFO: {
230  assert(size->width > padding.width && size->height > padding.height);
231  size->width -= WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
232  size->height -= WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
233  Dimension d = {0, 0};
234  for (int i = 0; i < TACT_COUNT; i++) {
235  SetDParam(0, _price[PR_TOWN_ACTION] * _town_action_costs[i] >> 8);
236  d = maxdim(d, GetStringMultiLineBoundingBox(STR_LOCAL_AUTHORITY_ACTION_TOOLTIP_SMALL_ADVERTISING + i, *size));
237  }
238  *size = maxdim(*size, d);
239  size->width += WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
240  size->height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
241  break;
242  }
243 
244  case WID_TA_COMMAND_LIST:
246  size->width = GetStringBoundingBox(STR_LOCAL_AUTHORITY_ACTIONS_TITLE).width;
247  for (uint i = 0; i < TACT_COUNT; i++ ) {
248  size->width = max(size->width, GetStringBoundingBox(STR_LOCAL_AUTHORITY_ACTION_SMALL_ADVERTISING_CAMPAIGN + i).width);
249  }
250  size->width += WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
251  break;
252 
253  case WID_TA_RATING_INFO:
254  resize->height = FONT_HEIGHT_NORMAL;
256  break;
257  }
258  }
259 
260  void OnClick(Point pt, int widget, int click_count) override
261  {
262  switch (widget) {
263  case WID_TA_ZONE_BUTTON: {
264  bool new_show_state = !this->town->show_zone;
265  TownID index = this->town->index;
266 
267  new_show_state ? _town_local_authority_kdtree.Insert(index) : _town_local_authority_kdtree.Remove(index);
268 
269  this->town->show_zone = new_show_state;
270  this->SetWidgetLoweredState(widget, new_show_state);
272  break;
273  }
274 
275  case WID_TA_COMMAND_LIST: {
277  if (!IsInsideMM(y, 0, 5)) return;
278 
279  y = GetNthSetBit(GetMaskOfTownActions(nullptr, _local_company, this->town), y + this->vscroll->GetPosition() - 1);
280  if (y >= 0) {
281  this->sel_index = y;
282  this->SetDirty();
283  }
284  /* When double-clicking, continue */
285  if (click_count == 1 || y < 0) break;
286  FALLTHROUGH;
287  }
288 
289  case WID_TA_EXECUTE:
290  DoCommandP(this->town->xy, this->window_number, this->sel_index, CMD_DO_TOWN_ACTION | CMD_MSG(STR_ERROR_CAN_T_DO_THIS));
291  break;
292  }
293  }
294 
295  void OnHundredthTick() override
296  {
297  this->SetDirty();
298  }
299 };
300 
301 static WindowDesc _town_authority_desc(
302  WDP_AUTO, "view_town_authority", 317, 222,
304  0,
305  _nested_town_authority_widgets, lengthof(_nested_town_authority_widgets)
306 );
307 
308 static void ShowTownAuthorityWindow(uint town)
309 {
310  AllocateWindowDescFront<TownAuthorityWindow>(&_town_authority_desc, town);
311 }
312 
313 
314 /* Town view window. */
316 private:
318 
319 public:
320  static const int WID_TV_HEIGHT_NORMAL = 150;
321 
323  {
324  this->CreateNestedTree();
325 
326  this->town = Town::Get(window_number);
327  if (this->town->larger_town) this->GetWidget<NWidgetCore>(WID_TV_CAPTION)->widget_data = STR_TOWN_VIEW_CITY_CAPTION;
328 
329  this->FinishInitNested(window_number);
330 
331  this->flags |= WF_DISABLE_VP_SCROLL;
332  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_TV_VIEWPORT);
333  nvp->InitializeViewport(this, this->town->xy, ZOOM_LVL_NEWS);
334 
335  /* disable renaming town in network games if you are not the server */
337  }
338 
339  ~TownViewWindow()
340  {
342  }
343 
344  void SetStringParameters(int widget) const override
345  {
346  if (widget == WID_TV_CAPTION) SetDParam(0, this->town->index);
347  }
348 
349  void OnPaint() override
350  {
351  extern const Town *_viewport_highlight_town;
352  this->SetWidgetLoweredState(WID_TV_CATCHMENT, _viewport_highlight_town == this->town);
353 
354  this->DrawWidgets();
355  }
356 
357  void DrawWidget(const Rect &r, int widget) const override
358  {
359  if (widget != WID_TV_INFO) return;
360 
361  uint y = r.top + WD_FRAMERECT_TOP;
362 
363  SetDParam(0, this->town->cache.population);
364  SetDParam(1, this->town->cache.num_houses);
365  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y, STR_TOWN_VIEW_POPULATION_HOUSES);
366 
367  SetDParam(0, 1 << CT_PASSENGERS);
368  SetDParam(1, this->town->supplied[CT_PASSENGERS].old_act);
369  SetDParam(2, this->town->supplied[CT_PASSENGERS].old_max);
370  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, STR_TOWN_VIEW_CARGO_LAST_MONTH_MAX);
371 
372  SetDParam(0, 1 << CT_MAIL);
373  SetDParam(1, this->town->supplied[CT_MAIL].old_act);
374  SetDParam(2, this->town->supplied[CT_MAIL].old_max);
375  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, STR_TOWN_VIEW_CARGO_LAST_MONTH_MAX);
376 
377  bool first = true;
378  for (int i = TE_BEGIN; i < TE_END; i++) {
379  if (this->town->goal[i] == 0) continue;
380  if (this->town->goal[i] == TOWN_GROWTH_WINTER && (TileHeight(this->town->xy) < LowestSnowLine() || this->town->cache.population <= 90)) continue;
381  if (this->town->goal[i] == TOWN_GROWTH_DESERT && (GetTropicZone(this->town->xy) != TROPICZONE_DESERT || this->town->cache.population <= 60)) continue;
382 
383  if (first) {
384  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH);
385  first = false;
386  }
387 
388  bool rtl = _current_text_dir == TD_RTL;
389  uint cargo_text_left = r.left + WD_FRAMERECT_LEFT + (rtl ? 0 : 20);
390  uint cargo_text_right = r.right - WD_FRAMERECT_RIGHT - (rtl ? 20 : 0);
391 
393  assert(cargo != nullptr);
394 
395  StringID string;
396 
397  if (this->town->goal[i] == TOWN_GROWTH_DESERT || this->town->goal[i] == TOWN_GROWTH_WINTER) {
398  /* For 'original' gameplay, don't show the amount required (you need 1 or more ..) */
399  string = STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH_DELIVERED_GENERAL;
400  if (this->town->received[i].old_act == 0) {
401  string = STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH_REQUIRED_GENERAL;
402 
403  if (this->town->goal[i] == TOWN_GROWTH_WINTER && TileHeight(this->town->xy) < GetSnowLine()) {
404  string = STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH_REQUIRED_WINTER;
405  }
406  }
407 
408  SetDParam(0, cargo->name);
409  } else {
410  string = STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH_DELIVERED;
411  if (this->town->received[i].old_act < this->town->goal[i]) {
412  string = STR_TOWN_VIEW_CARGO_FOR_TOWNGROWTH_REQUIRED;
413  }
414 
415  SetDParam(0, cargo->Index());
416  SetDParam(1, this->town->received[i].old_act);
417  SetDParam(2, cargo->Index());
418  SetDParam(3, this->town->goal[i]);
419  }
420  DrawString(cargo_text_left, cargo_text_right, y += FONT_HEIGHT_NORMAL, string);
421  }
422 
423  if (HasBit(this->town->flags, TOWN_IS_GROWING)) {
424  SetDParam(0, RoundDivSU(this->town->growth_rate + 1, DAY_TICKS));
425  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, this->town->fund_buildings_months == 0 ? STR_TOWN_VIEW_TOWN_GROWS_EVERY : STR_TOWN_VIEW_TOWN_GROWS_EVERY_FUNDED);
426  } else {
427  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, STR_TOWN_VIEW_TOWN_GROW_STOPPED);
428  }
429 
430  /* only show the town noise, if the noise option is activated. */
432  SetDParam(0, this->town->noise_reached);
433  SetDParam(1, this->town->MaxTownNoise());
434  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_LEFT, y += FONT_HEIGHT_NORMAL, STR_TOWN_VIEW_NOISE_IN_TOWN);
435  }
436 
437  if (this->town->text != nullptr) {
438  SetDParamStr(0, this->town->text);
439  DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y += FONT_HEIGHT_NORMAL, UINT16_MAX, STR_JUST_RAW_STRING, TC_BLACK);
440  }
441  }
442 
443  void OnClick(Point pt, int widget, int click_count) override
444  {
445  switch (widget) {
446  case WID_TV_CENTER_VIEW: // scroll to location
447  if (_ctrl_pressed) {
448  ShowExtraViewPortWindow(this->town->xy);
449  } else {
450  ScrollMainWindowToTile(this->town->xy);
451  }
452  break;
453 
454  case WID_TV_SHOW_AUTHORITY: // town authority
455  ShowTownAuthorityWindow(this->window_number);
456  break;
457 
458  case WID_TV_CHANGE_NAME: // rename
459  SetDParam(0, this->window_number);
460  ShowQueryString(STR_TOWN_NAME, STR_TOWN_VIEW_RENAME_TOWN_BUTTON, MAX_LENGTH_TOWN_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
461  break;
462 
463  case WID_TV_CATCHMENT:
465  break;
466 
467  case WID_TV_EXPAND: { // expand town - only available on Scenario editor
468  /* Warn the user if towns are not allowed to build roads, but do this only once per OpenTTD run. */
469  static bool _warn_town_no_roads = false;
470 
471  if (!_settings_game.economy.allow_town_roads && !_warn_town_no_roads) {
472  ShowErrorMessage(STR_ERROR_TOWN_EXPAND_WARN_NO_ROADS, INVALID_STRING_ID, WL_WARNING);
473  _warn_town_no_roads = true;
474  }
475 
476  DoCommandP(0, this->window_number, 0, CMD_EXPAND_TOWN | CMD_MSG(STR_ERROR_CAN_T_EXPAND_TOWN));
477  break;
478  }
479 
480  case WID_TV_DELETE: // delete town - only available on Scenario editor
481  DoCommandP(0, this->window_number, 0, CMD_DELETE_TOWN | CMD_MSG(STR_ERROR_TOWN_CAN_T_DELETE));
482  break;
483  }
484  }
485 
486  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
487  {
488  switch (widget) {
489  case WID_TV_INFO:
490  size->height = GetDesiredInfoHeight(size->width);
491  break;
492  }
493  }
494 
499  uint GetDesiredInfoHeight(int width) const
500  {
501  uint aimed_height = 3 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
502 
503  bool first = true;
504  for (int i = TE_BEGIN; i < TE_END; i++) {
505  if (this->town->goal[i] == 0) continue;
506  if (this->town->goal[i] == TOWN_GROWTH_WINTER && (TileHeight(this->town->xy) < LowestSnowLine() || this->town->cache.population <= 90)) continue;
507  if (this->town->goal[i] == TOWN_GROWTH_DESERT && (GetTropicZone(this->town->xy) != TROPICZONE_DESERT || this->town->cache.population <= 60)) continue;
508 
509  if (first) {
510  aimed_height += FONT_HEIGHT_NORMAL;
511  first = false;
512  }
513  aimed_height += FONT_HEIGHT_NORMAL;
514  }
515  aimed_height += FONT_HEIGHT_NORMAL;
516 
518 
519  if (this->town->text != nullptr) {
520  SetDParamStr(0, this->town->text);
521  aimed_height += GetStringHeight(STR_JUST_RAW_STRING, width - WD_FRAMERECT_LEFT - WD_FRAMERECT_RIGHT);
522  }
523 
524  return aimed_height;
525  }
526 
527  void ResizeWindowAsNeeded()
528  {
529  const NWidgetBase *nwid_info = this->GetWidget<NWidgetBase>(WID_TV_INFO);
530  uint aimed_height = GetDesiredInfoHeight(nwid_info->current_x);
531  if (aimed_height > nwid_info->current_y || (aimed_height < nwid_info->current_y && nwid_info->current_y > nwid_info->smallest_y)) {
532  this->ReInit();
533  }
534  }
535 
536  void OnResize() override
537  {
538  if (this->viewport != nullptr) {
539  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_TV_VIEWPORT);
540  nvp->UpdateViewportCoordinates(this);
541 
542  ScrollWindowToTile(this->town->xy, this, true); // Re-center viewport.
543  }
544  }
545 
551  void OnInvalidateData(int data = 0, bool gui_scope = true) override
552  {
553  if (!gui_scope) return;
554  /* Called when setting station noise or required cargoes have changed, in order to resize the window */
555  this->SetDirty(); // refresh display for current size. This will allow to avoid glitches when downgrading
556  this->ResizeWindowAsNeeded();
557  }
558 
559  void OnQueryTextFinished(char *str) override
560  {
561  if (str == nullptr) return;
562 
563  DoCommandP(0, this->window_number, 0, CMD_RENAME_TOWN | CMD_MSG(STR_ERROR_CAN_T_RENAME_TOWN), nullptr, str);
564  }
565 };
566 
567 static const NWidgetPart _nested_town_game_view_widgets[] = {
569  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
570  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_TV_CAPTION), SetDataTip(STR_TOWN_VIEW_TOWN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
571  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
572  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
573  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
574  EndContainer(),
575  NWidget(WWT_PANEL, COLOUR_BROWN),
576  NWidget(WWT_INSET, COLOUR_BROWN), SetPadding(2, 2, 2, 2),
577  NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_TV_VIEWPORT), SetMinimalSize(254, 86), SetFill(1, 0), SetResize(1, 1), SetPadding(1, 1, 1, 1),
578  EndContainer(),
579  EndContainer(),
580  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TV_INFO), SetMinimalSize(260, 32), SetResize(1, 0), SetFill(1, 0), EndContainer(),
583  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_CENTER_VIEW), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_BUTTON_LOCATION, STR_TOWN_VIEW_CENTER_TOOLTIP),
584  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_SHOW_AUTHORITY), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TOWN_VIEW_LOCAL_AUTHORITY_BUTTON, STR_TOWN_VIEW_LOCAL_AUTHORITY_TOOLTIP),
585  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_CHANGE_NAME), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_BUTTON_RENAME, STR_TOWN_VIEW_RENAME_TOOLTIP),
586  EndContainer(),
587  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_TV_CATCHMENT), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_BUTTON_CATCHMENT, STR_TOOLTIP_CATCHMENT),
588  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
589  EndContainer(),
590 };
591 
592 static WindowDesc _town_game_view_desc(
593  WDP_AUTO, "view_town", 260, TownViewWindow::WID_TV_HEIGHT_NORMAL,
595  0,
596  _nested_town_game_view_widgets, lengthof(_nested_town_game_view_widgets)
597 );
598 
599 static const NWidgetPart _nested_town_editor_view_widgets[] = {
601  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
602  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_TV_CAPTION), SetDataTip(STR_TOWN_VIEW_TOWN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
603  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_CHANGE_NAME), SetMinimalSize(76, 14), SetDataTip(STR_BUTTON_RENAME, STR_TOWN_VIEW_RENAME_TOOLTIP),
604  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
605  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
606  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
607  EndContainer(),
608  NWidget(WWT_PANEL, COLOUR_BROWN),
609  NWidget(WWT_INSET, COLOUR_BROWN), SetPadding(2, 2, 2, 2),
610  NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_TV_VIEWPORT), SetMinimalSize(254, 86), SetFill(1, 1), SetResize(1, 1), SetPadding(1, 1, 1, 1),
611  EndContainer(),
612  EndContainer(),
613  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TV_INFO), SetMinimalSize(260, 32), SetResize(1, 0), SetFill(1, 0), EndContainer(),
616  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_CENTER_VIEW), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_BUTTON_LOCATION, STR_TOWN_VIEW_CENTER_TOOLTIP),
617  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_EXPAND), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TOWN_VIEW_EXPAND_BUTTON, STR_TOWN_VIEW_EXPAND_TOOLTIP),
618  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_TV_DELETE), SetMinimalSize(80, 12), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TOWN_VIEW_DELETE_BUTTON, STR_TOWN_VIEW_DELETE_TOOLTIP),
619  EndContainer(),
620  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_TV_CATCHMENT), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_BUTTON_CATCHMENT, STR_TOOLTIP_CATCHMENT),
621  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
622  EndContainer(),
623 };
624 
625 static WindowDesc _town_editor_view_desc(
626  WDP_AUTO, "view_town_scen", 260, TownViewWindow::WID_TV_HEIGHT_NORMAL,
628  0,
629  _nested_town_editor_view_widgets, lengthof(_nested_town_editor_view_widgets)
630 );
631 
632 void ShowTownViewWindow(TownID town)
633 {
634  if (_game_mode == GM_EDITOR) {
635  AllocateWindowDescFront<TownViewWindow>(&_town_editor_view_desc, town);
636  } else {
637  AllocateWindowDescFront<TownViewWindow>(&_town_game_view_desc, town);
638  }
639 }
640 
641 static const NWidgetPart _nested_town_directory_widgets[] = {
643  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
644  NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_TOWN_DIRECTORY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
645  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
646  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
647  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
648  EndContainer(),
652  NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_TD_SORT_ORDER), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
653  NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_TD_SORT_CRITERIA), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_SORT_CRITERIA),
654  NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_TD_FILTER), SetFill(35, 12), SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
655  EndContainer(),
656  NWidget(WWT_PANEL, COLOUR_BROWN, WID_TD_LIST), SetMinimalSize(196, 0), SetDataTip(0x0, STR_TOWN_DIRECTORY_LIST_TOOLTIP),
658  NWidget(WWT_PANEL, COLOUR_BROWN),
659  NWidget(WWT_TEXT, COLOUR_BROWN, WID_TD_WORLD_POPULATION), SetPadding(2, 0, 0, 2), SetMinimalSize(196, 12), SetFill(1, 0), SetDataTip(STR_TOWN_POPULATION, STR_NULL),
660  EndContainer(),
661  EndContainer(),
663  NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_TD_SCROLLBAR),
664  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
665  EndContainer(),
666  EndContainer(),
667 };
668 
670 struct TownDirectoryWindow : public Window {
671 private:
672  /* Runtime saved values */
673  static Listing last_sorting;
674  static const Town *last_town;
675 
676  /* Constants for sorting towns */
677  static const StringID sorter_names[];
678  static GUITownList::SortFunction * const sorter_funcs[];
679 
682 
683  GUITownList towns;
684 
685  Scrollbar *vscroll;
686 
687  void BuildSortTownList()
688  {
689  if (this->towns.NeedRebuild()) {
690  this->towns.clear();
691 
692  for (const Town *t : Town::Iterate()) {
693  this->towns.push_back(t);
694  }
695 
696  this->towns.shrink_to_fit();
697  this->towns.RebuildDone();
698  this->vscroll->SetCount((uint)this->towns.size()); // Update scrollbar as well.
699  }
700  /* Always sort the towns. */
701  this->last_town = nullptr;
702  this->towns.Sort();
703  this->SetWidgetDirty(WID_TD_LIST); // Force repaint of the displayed towns.
704  }
705 
707  static bool TownNameSorter(const Town * const &a, const Town * const &b)
708  {
709  static char buf_cache[MAX_LENGTH_TOWN_NAME_CHARS * MAX_CHAR_LENGTH];
711 
712  SetDParam(0, a->index);
713  GetString(buf, STR_TOWN_NAME, lastof(buf));
714 
715  /* If 'b' is the same town as in the last round, use the cached value
716  * We do this to speed stuff up ('b' is called with the same value a lot of
717  * times after each other) */
718  if (b != last_town) {
719  last_town = b;
720  SetDParam(0, b->index);
721  GetString(buf_cache, STR_TOWN_NAME, lastof(buf_cache));
722  }
723 
724  return strnatcmp(buf, buf_cache) < 0; // Sort by name (natural sorting).
725  }
726 
728  static bool TownPopulationSorter(const Town * const &a, const Town * const &b)
729  {
730  uint32 a_population = a->cache.population;
731  uint32 b_population = b->cache.population;
732  if (a_population == b_population) return TownDirectoryWindow::TownNameSorter(a, b);
733  return a_population < b_population;
734  }
735 
737  static bool TownRatingSorter(const Town * const &a, const Town * const &b)
738  {
739  bool before = !TownDirectoryWindow::last_sorting.order; // Value to get 'a' before 'b'.
740 
741  /* Towns without rating are always after towns with rating. */
744  int16 a_rating = a->ratings[_local_company];
745  int16 b_rating = b->ratings[_local_company];
746  if (a_rating == b_rating) return TownDirectoryWindow::TownNameSorter(a, b);
747  return a_rating < b_rating;
748  }
749  return before;
750  }
751  if (HasBit(b->have_ratings, _local_company)) return !before;
752 
753  /* Sort unrated towns always on ascending town name. */
754  if (before) return TownDirectoryWindow::TownNameSorter(a, b);
756  }
757 
758 public:
760  {
761  this->CreateNestedTree();
762 
763  this->vscroll = this->GetScrollbar(WID_TD_SCROLLBAR);
764 
765  this->towns.SetListing(this->last_sorting);
767  this->towns.ForceRebuild();
768  this->BuildSortTownList();
769 
770  this->FinishInitNested(0);
771 
772  this->querystrings[WID_TD_FILTER] = &this->townname_editbox;
773  this->townname_editbox.cancel_button = QueryString::ACTION_CLEAR;
774  }
775 
776  void SetStringParameters(int widget) const override
777  {
778  switch (widget) {
781  break;
782 
785  break;
786  }
787  }
788 
794  static StringID GetTownString(const Town *t)
795  {
796  return t->larger_town ? STR_TOWN_DIRECTORY_CITY : STR_TOWN_DIRECTORY_TOWN;
797  }
798 
799  void DrawWidget(const Rect &r, int widget) const override
800  {
801  switch (widget) {
802  case WID_TD_SORT_ORDER:
803  this->DrawSortButtonState(widget, this->towns.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
804  break;
805 
806  case WID_TD_LIST: {
807  int n = 0;
808  int y = r.top + WD_FRAMERECT_TOP;
809  if (this->towns.size() == 0) { // No towns available.
810  DrawString(r.left + WD_FRAMERECT_LEFT, r.right, y, STR_TOWN_DIRECTORY_NONE);
811  break;
812  }
813 
814  /* At least one town available. */
815  bool rtl = _current_text_dir == TD_RTL;
816  Dimension icon_size = GetSpriteSize(SPR_TOWN_RATING_GOOD);
817  int text_left = r.left + WD_FRAMERECT_LEFT + (rtl ? 0 : icon_size.width + 2);
818  int text_right = r.right - WD_FRAMERECT_RIGHT - (rtl ? icon_size.width + 2 : 0);
819  int icon_x = rtl ? r.right - WD_FRAMERECT_RIGHT - icon_size.width : r.left + WD_FRAMERECT_LEFT;
820 
821  for (uint i = this->vscroll->GetPosition(); i < this->towns.size(); i++) {
822  const Town *t = this->towns[i];
823  assert(t->xy != INVALID_TILE);
824 
825  /* Draw rating icon. */
826  if (_game_mode == GM_EDITOR || !HasBit(t->have_ratings, _local_company)) {
827  DrawSprite(SPR_TOWN_RATING_NA, PAL_NONE, icon_x, y + (this->resize.step_height - icon_size.height) / 2);
828  } else {
829  SpriteID icon = SPR_TOWN_RATING_APALLING;
830  if (t->ratings[_local_company] > RATING_VERYPOOR) icon = SPR_TOWN_RATING_MEDIOCRE;
831  if (t->ratings[_local_company] > RATING_GOOD) icon = SPR_TOWN_RATING_GOOD;
832  DrawSprite(icon, PAL_NONE, icon_x, y + (this->resize.step_height - icon_size.height) / 2);
833  }
834 
835  SetDParam(0, t->index);
836  SetDParam(1, t->cache.population);
837  DrawString(text_left, text_right, y + (this->resize.step_height - FONT_HEIGHT_NORMAL) / 2, GetTownString(t));
838 
839  y += this->resize.step_height;
840  if (++n == this->vscroll->GetCapacity()) break; // max number of towns in 1 window
841  }
842  break;
843  }
844  }
845  }
846 
847  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
848  {
849  switch (widget) {
850  case WID_TD_SORT_ORDER: {
851  Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
852  d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
853  d.height += padding.height;
854  *size = maxdim(*size, d);
855  break;
856  }
857  case WID_TD_SORT_CRITERIA: {
858  Dimension d = {0, 0};
859  for (uint i = 0; TownDirectoryWindow::sorter_names[i] != INVALID_STRING_ID; i++) {
861  }
862  d.width += padding.width;
863  d.height += padding.height;
864  *size = maxdim(*size, d);
865  break;
866  }
867  case WID_TD_LIST: {
868  Dimension d = GetStringBoundingBox(STR_TOWN_DIRECTORY_NONE);
869  for (uint i = 0; i < this->towns.size(); i++) {
870  const Town *t = this->towns[i];
871 
872  assert(t != nullptr);
873 
874  SetDParam(0, t->index);
875  SetDParamMaxDigits(1, 8);
876  d = maxdim(d, GetStringBoundingBox(GetTownString(t)));
877  }
878  Dimension icon_size = GetSpriteSize(SPR_TOWN_RATING_GOOD);
879  d.width += icon_size.width + 2;
880  d.height = max(d.height, icon_size.height);
881  resize->height = d.height;
882  d.height *= 5;
883  d.width += padding.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
884  d.height += padding.height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
885  *size = maxdim(*size, d);
886  break;
887  }
889  SetDParamMaxDigits(0, 10);
890  Dimension d = GetStringBoundingBox(STR_TOWN_POPULATION);
891  d.width += padding.width;
892  d.height += padding.height;
893  *size = maxdim(*size, d);
894  break;
895  }
896  }
897  }
898 
899  void OnClick(Point pt, int widget, int click_count) override
900  {
901  switch (widget) {
902  case WID_TD_SORT_ORDER: // Click on sort order button
903  if (this->towns.SortType() != 2) { // A different sort than by rating.
904  this->towns.ToggleSortOrder();
905  this->last_sorting = this->towns.GetListing(); // Store new sorting order.
906  } else {
907  /* Some parts are always sorted ascending on name. */
908  this->last_sorting.order = !this->last_sorting.order;
909  this->towns.SetListing(this->last_sorting);
910  this->towns.ForceResort();
911  this->towns.Sort();
912  }
913  this->SetDirty();
914  break;
915 
916  case WID_TD_SORT_CRITERIA: // Click on sort criteria dropdown
918  break;
919 
920  case WID_TD_LIST: { // Click on Town Matrix
921  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_TD_LIST, WD_FRAMERECT_TOP);
922  if (id_v >= this->towns.size()) return; // click out of town bounds
923 
924  const Town *t = this->towns[id_v];
925  assert(t != nullptr);
926  if (_ctrl_pressed) {
928  } else {
930  }
931  break;
932  }
933  }
934  }
935 
936  void OnDropdownSelect(int widget, int index) override
937  {
938  if (widget != WID_TD_SORT_CRITERIA) return;
939 
940  if (this->towns.SortType() != index) {
941  this->towns.SetSortType(index);
942  this->last_sorting = this->towns.GetListing(); // Store new sorting order.
943  this->BuildSortTownList();
944  }
945  }
946 
947  void OnPaint() override
948  {
949  if (this->towns.NeedRebuild()) this->BuildSortTownList();
950  this->DrawWidgets();
951  }
952 
953  void OnHundredthTick() override
954  {
955  this->BuildSortTownList();
956  this->SetDirty();
957  }
958 
959  void OnResize() override
960  {
961  this->vscroll->SetCapacityFromWidget(this, WID_TD_LIST);
962  }
963 
964  void OnEditboxChanged(int wid) override
965  {
966  if (wid == WID_TD_FILTER) {
967  this->string_filter.SetFilterTerm(this->townname_editbox.text.buf);
969  }
970  }
971 
977  void OnInvalidateData(int data = 0, bool gui_scope = true) override
978  {
980 
981  switch (data) {
982  case TDIWD_FORCE_REBUILD:
983  /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
984  this->towns.ForceRebuild();
985  break;
986 
988  if (this->string_filter.IsEmpty()) {
989  this->towns.ForceRebuild();
990  } else {
991  this->towns.clear();
992 
993  for (const Town *t : Town::Iterate()) {
994  this->string_filter.ResetState();
995 
996  SetDParam(0, t->index);
997  GetString(buf, STR_TOWN_NAME, lastof(buf));
998 
999  this->string_filter.AddLine(buf);
1000  if (this->string_filter.GetState()) this->towns.push_back(t);
1001  }
1002 
1003  this->towns.SetListing(this->last_sorting);
1004  this->towns.ForceResort();
1005  this->towns.Sort();
1006  this->towns.shrink_to_fit();
1007  this->towns.RebuildDone();
1008  this->vscroll->SetCount((int)this->towns.size()); // Update scrollbar as well.
1009  }
1010  break;
1011  default:
1012  this->towns.ForceResort();
1013  }
1014  }
1015 };
1016 
1017 Listing TownDirectoryWindow::last_sorting = {false, 0};
1018 const Town *TownDirectoryWindow::last_town = nullptr;
1019 
1022  STR_SORT_BY_NAME,
1023  STR_SORT_BY_POPULATION,
1024  STR_SORT_BY_RATING,
1026 };
1027 
1030  &TownNameSorter,
1031  &TownPopulationSorter,
1032  &TownRatingSorter,
1033 };
1034 
1035 static WindowDesc _town_directory_desc(
1036  WDP_AUTO, "list_towns", 208, 202,
1038  0,
1039  _nested_town_directory_widgets, lengthof(_nested_town_directory_widgets)
1040 );
1041 
1042 void ShowTownDirectory()
1043 {
1044  if (BringWindowToFrontById(WC_TOWN_DIRECTORY, 0)) return;
1045  new TownDirectoryWindow(&_town_directory_desc);
1046 }
1047 
1048 void CcFoundTown(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
1049 {
1050  if (result.Failed()) return;
1051 
1052  if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_SPLAT_OTHER, tile);
1054 }
1055 
1056 void CcFoundRandomTown(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
1057 {
1058  if (result.Succeeded()) ScrollMainWindowToTile(Town::Get(_new_town_id)->xy);
1059 }
1060 
1061 static const NWidgetPart _nested_found_town_widgets[] = {
1063  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1064  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_FOUND_TOWN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1065  NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
1066  NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
1067  EndContainer(),
1068  /* Construct new town(s) buttons. */
1069  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
1071  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_NEW_TOWN), SetMinimalSize(156, 12), SetFill(1, 0),
1072  SetDataTip(STR_FOUND_TOWN_NEW_TOWN_BUTTON, STR_FOUND_TOWN_NEW_TOWN_TOOLTIP), SetPadding(0, 2, 1, 2),
1073  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_TF_RANDOM_TOWN), SetMinimalSize(156, 12), SetFill(1, 0),
1074  SetDataTip(STR_FOUND_TOWN_RANDOM_TOWN_BUTTON, STR_FOUND_TOWN_RANDOM_TOWN_TOOLTIP), SetPadding(0, 2, 1, 2),
1075  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_TF_MANY_RANDOM_TOWNS), SetMinimalSize(156, 12), SetFill(1, 0),
1076  SetDataTip(STR_FOUND_TOWN_MANY_RANDOM_TOWNS, STR_FOUND_TOWN_RANDOM_TOWNS_TOOLTIP), SetPadding(0, 2, 0, 2),
1077  /* Town name selection. */
1078  NWidget(WWT_LABEL, COLOUR_DARK_GREEN), SetMinimalSize(156, 14), SetPadding(0, 2, 0, 2), SetDataTip(STR_FOUND_TOWN_NAME_TITLE, STR_NULL),
1079  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_TF_TOWN_NAME_EDITBOX), SetMinimalSize(156, 12), SetPadding(0, 2, 3, 2),
1080  SetDataTip(STR_FOUND_TOWN_NAME_EDITOR_TITLE, STR_FOUND_TOWN_NAME_EDITOR_HELP),
1081  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_TF_TOWN_NAME_RANDOM), SetMinimalSize(78, 12), SetPadding(0, 2, 0, 2), SetFill(1, 0),
1082  SetDataTip(STR_FOUND_TOWN_NAME_RANDOM_BUTTON, STR_FOUND_TOWN_NAME_RANDOM_TOOLTIP),
1083  /* Town size selection. */
1084  NWidget(NWID_HORIZONTAL), SetPIP(2, 0, 2),
1085  NWidget(NWID_SPACER), SetFill(1, 0),
1086  NWidget(WWT_LABEL, COLOUR_DARK_GREEN), SetMinimalSize(148, 14), SetDataTip(STR_FOUND_TOWN_INITIAL_SIZE_TITLE, STR_NULL),
1087  NWidget(NWID_SPACER), SetFill(1, 0),
1088  EndContainer(),
1090  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_SIZE_SMALL), SetMinimalSize(78, 12), SetFill(1, 0),
1091  SetDataTip(STR_FOUND_TOWN_INITIAL_SIZE_SMALL_BUTTON, STR_FOUND_TOWN_INITIAL_SIZE_TOOLTIP),
1092  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_SIZE_MEDIUM), SetMinimalSize(78, 12), SetFill(1, 0),
1093  SetDataTip(STR_FOUND_TOWN_INITIAL_SIZE_MEDIUM_BUTTON, STR_FOUND_TOWN_INITIAL_SIZE_TOOLTIP),
1094  EndContainer(),
1097  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_SIZE_LARGE), SetMinimalSize(78, 12), SetFill(1, 0),
1098  SetDataTip(STR_FOUND_TOWN_INITIAL_SIZE_LARGE_BUTTON, STR_FOUND_TOWN_INITIAL_SIZE_TOOLTIP),
1099  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_SIZE_RANDOM), SetMinimalSize(78, 12), SetFill(1, 0),
1100  SetDataTip(STR_FOUND_TOWN_SIZE_RANDOM, STR_FOUND_TOWN_INITIAL_SIZE_TOOLTIP),
1101  EndContainer(),
1103  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_CITY), SetPadding(0, 2, 0, 2), SetMinimalSize(156, 12), SetFill(1, 0),
1104  SetDataTip(STR_FOUND_TOWN_CITY, STR_FOUND_TOWN_CITY_TOOLTIP), SetFill(1, 0),
1105  /* Town roads selection. */
1106  NWidget(NWID_HORIZONTAL), SetPIP(2, 0, 2),
1107  NWidget(NWID_SPACER), SetFill(1, 0),
1108  NWidget(WWT_LABEL, COLOUR_DARK_GREEN), SetMinimalSize(148, 14), SetDataTip(STR_FOUND_TOWN_ROAD_LAYOUT, STR_NULL),
1109  NWidget(NWID_SPACER), SetFill(1, 0),
1110  EndContainer(),
1112  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_LAYOUT_ORIGINAL), SetMinimalSize(78, 12), SetFill(1, 0), SetDataTip(STR_FOUND_TOWN_SELECT_LAYOUT_ORIGINAL, STR_FOUND_TOWN_SELECT_TOWN_ROAD_LAYOUT),
1113  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_LAYOUT_BETTER), SetMinimalSize(78, 12), SetFill(1, 0), SetDataTip(STR_FOUND_TOWN_SELECT_LAYOUT_BETTER_ROADS, STR_FOUND_TOWN_SELECT_TOWN_ROAD_LAYOUT),
1114  EndContainer(),
1117  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_LAYOUT_GRID2), SetMinimalSize(78, 12), SetFill(1, 0), SetDataTip(STR_FOUND_TOWN_SELECT_LAYOUT_2X2_GRID, STR_FOUND_TOWN_SELECT_TOWN_ROAD_LAYOUT),
1118  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_LAYOUT_GRID3), SetMinimalSize(78, 12), SetFill(1, 0), SetDataTip(STR_FOUND_TOWN_SELECT_LAYOUT_3X3_GRID, STR_FOUND_TOWN_SELECT_TOWN_ROAD_LAYOUT),
1119  EndContainer(),
1121  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_TF_LAYOUT_RANDOM), SetPadding(0, 2, 0, 2), SetMinimalSize(0, 12), SetFill(1, 0),
1122  SetDataTip(STR_FOUND_TOWN_SELECT_LAYOUT_RANDOM, STR_FOUND_TOWN_SELECT_TOWN_ROAD_LAYOUT), SetFill(1, 0),
1124  EndContainer(),
1125 };
1126 
1129 private:
1132  bool city;
1135  uint32 townnameparts;
1137 
1138 public:
1140  Window(desc),
1141  town_size(TSZ_MEDIUM),
1142  town_layout(_settings_game.economy.town_layout),
1144  params(_settings_game.game_creation.town_name)
1145  {
1146  this->InitNested(window_number);
1147  this->querystrings[WID_TF_TOWN_NAME_EDITBOX] = &this->townname_editbox;
1148  this->RandomTownName();
1149  this->UpdateButtons(true);
1150  }
1151 
1152  void RandomTownName()
1153  {
1154  this->townnamevalid = GenerateTownName(&this->townnameparts);
1155 
1156  if (!this->townnamevalid) {
1157  this->townname_editbox.text.DeleteAll();
1158  } else {
1159  GetTownName(this->townname_editbox.text.buf, &this->params, this->townnameparts, &this->townname_editbox.text.buf[this->townname_editbox.text.max_bytes - 1]);
1160  this->townname_editbox.text.UpdateSize();
1161  }
1163 
1165  }
1166 
1167  void UpdateButtons(bool check_availability)
1168  {
1169  if (check_availability && _game_mode != GM_EDITOR) {
1174  }
1175 
1176  for (int i = WID_TF_SIZE_SMALL; i <= WID_TF_SIZE_RANDOM; i++) {
1177  this->SetWidgetLoweredState(i, i == WID_TF_SIZE_SMALL + this->town_size);
1178  }
1179 
1180  this->SetWidgetLoweredState(WID_TF_CITY, this->city);
1181 
1182  for (int i = WID_TF_LAYOUT_ORIGINAL; i <= WID_TF_LAYOUT_RANDOM; i++) {
1183  this->SetWidgetLoweredState(i, i == WID_TF_LAYOUT_ORIGINAL + this->town_layout);
1184  }
1185 
1186  this->SetDirty();
1187  }
1188 
1189  void ExecuteFoundTownCommand(TileIndex tile, bool random, StringID errstr, CommandCallback cc)
1190  {
1191  const char *name = nullptr;
1192 
1193  if (!this->townnamevalid) {
1194  name = this->townname_editbox.text.buf;
1195  } else {
1196  /* If user changed the name, send it */
1198  GetTownName(buf, &this->params, this->townnameparts, lastof(buf));
1199  if (strcmp(buf, this->townname_editbox.text.buf) != 0) name = this->townname_editbox.text.buf;
1200  }
1201 
1202  bool success = DoCommandP(tile, this->town_size | this->city << 2 | this->town_layout << 3 | random << 6,
1203  townnameparts, CMD_FOUND_TOWN | CMD_MSG(errstr), cc, name);
1204 
1205  /* Rerandomise name, if success and no cost-estimation. */
1206  if (success && !_shift_pressed) this->RandomTownName();
1207  }
1208 
1209  void OnClick(Point pt, int widget, int click_count) override
1210  {
1211  switch (widget) {
1212  case WID_TF_NEW_TOWN:
1213  HandlePlacePushButton(this, WID_TF_NEW_TOWN, SPR_CURSOR_TOWN, HT_RECT);
1214  break;
1215 
1216  case WID_TF_RANDOM_TOWN:
1217  this->ExecuteFoundTownCommand(0, true, STR_ERROR_CAN_T_GENERATE_TOWN, CcFoundRandomTown);
1218  break;
1219 
1221  this->RandomTownName();
1223  break;
1224 
1226  _generating_world = true;
1228  if (!GenerateTowns(this->town_layout)) {
1229  ShowErrorMessage(STR_ERROR_CAN_T_GENERATE_TOWN, STR_ERROR_NO_SPACE_FOR_TOWN, WL_INFO);
1230  }
1232  _generating_world = false;
1233  break;
1234 
1236  this->town_size = (TownSize)(widget - WID_TF_SIZE_SMALL);
1237  this->UpdateButtons(false);
1238  break;
1239 
1240  case WID_TF_CITY:
1241  this->city ^= true;
1242  this->SetWidgetLoweredState(WID_TF_CITY, this->city);
1243  this->SetDirty();
1244  break;
1245 
1248  this->town_layout = (TownLayout)(widget - WID_TF_LAYOUT_ORIGINAL);
1249  this->UpdateButtons(false);
1250  break;
1251  }
1252  }
1253 
1254  void OnPlaceObject(Point pt, TileIndex tile) override
1255  {
1256  this->ExecuteFoundTownCommand(tile, false, STR_ERROR_CAN_T_FOUND_TOWN_HERE, CcFoundTown);
1257  }
1258 
1259  void OnPlaceObjectAbort() override
1260  {
1261  this->RaiseButtons();
1262  this->UpdateButtons(false);
1263  }
1264 
1270  void OnInvalidateData(int data = 0, bool gui_scope = true) override
1271  {
1272  if (!gui_scope) return;
1273  this->UpdateButtons(true);
1274  }
1275 };
1276 
1277 static WindowDesc _found_town_desc(
1278  WDP_AUTO, "build_town", 160, 162,
1281  _nested_found_town_widgets, lengthof(_nested_found_town_widgets)
1282 );
1283 
1284 void ShowFoundTownWindow()
1285 {
1286  if (_game_mode != GM_EDITOR && !Company::IsValidID(_local_company)) return;
1287  AllocateWindowDescFront<FoundTownWindow>(&_found_town_desc, 0);
1288 }
1289 
1290 void InitializeTownGui()
1291 {
1292  _town_local_authority_kdtree.Clear();
1293 }
Nested widget containing a viewport.
Definition: widget_type.h:79
Selection for a small town.
Definition: town_widget.h:54
Functions related to OTTD&#39;s strings.
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: town_gui.cpp:486
static const uint TOWN_GROWTH_WINTER
The town only needs this cargo in the winter (any amount)
Definition: town.h:34
Base types for having sorted lists in GUIs.
void RebuildDone()
Notify the sortlist that the rebuild is done.
Direction of sort dropdown.
Definition: town_widget.h:15
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:79
Scrollbar of the list of commands.
Definition: town_widget.h:29
Definition of stuff that is very close to a company, like the company struct itself.
void UpdateNearestTownForRoadTiles(bool invalidate)
Updates cached nearest town for all road tiles.
Definition: road_cmd.cpp:1823
bool _networking
are we in networking mode?
Definition: network.cpp:52
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: town_gui.cpp:443
static TropicZone GetTropicZone(TileIndex tile)
Get the tropic zone.
Definition: tile_map.h:238
TransportedCargoStat< uint16 > received[NUM_TE]
Cargo statistics about received cargotypes.
Definition: town.h:78
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
rename a town
Definition: command_type.h:261
Selection for a large town.
Definition: town_widget.h:56
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
uint displayed_actions_on_previous_painting
Actions that were available on the previous call to OnPaint()
Definition: town_gui.cpp:73
Tile is desert.
Definition: tile_type.h:71
byte LowestSnowLine()
Get the lowest possible snow line height, either variable or static.
Definition: landscape.cpp:668
Turn on/off showing local authority zone.
Definition: town_widget.h:26
High level window description.
Definition: window_gui.h:166
EconomySettings economy
settings to change the economy
WindowFlags flags
Window flags.
Definition: window_gui.h:310
int left
x position of left edge of the window
Definition: window_gui.h:317
Expand this town (scenario editor only).
Definition: town_widget.h:43
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:291
Declarations for accessing the k-d tree of towns.
Centered label.
Definition: widget_type.h:55
Scrollbar data structure.
Definition: widget_type.h:587
void DrawRatings()
Draw the contents of the ratings panel.
Definition: town_gui.cpp:126
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:597
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:1934
Horizontal container.
Definition: widget_type.h:73
byte flags
See TownFlags.
Definition: town.h:64
void ResetState()
Reset the matching state to process a new item.
int sel_index
Currently selected town action, 0 to TACT_COUNT-1, -1 means no action selected.
Definition: town_gui.cpp:71
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:536
void SetSortFuncs(SortFunction *const *n_funcs)
Hand the array of sort function pointers to the sort list.
bool GetState() const
Get the matching state of the current item.
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1119
Specification of a cargo type.
Definition: cargotype.h:55
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: town_gui.cpp:899
Medium town.
Definition: town_type.h:21
void OnHundredthTick() override
Called once every 100 (game) ticks.
Definition: town_gui.cpp:953
Filter of name.
Definition: town_widget.h:17
General information about the town.
Definition: town_widget.h:38
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
a textbox for typing
Definition: widget_type.h:69
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
bool GenerateTownName(uint32 *townnameparts, TownNames *town_names)
Generates valid town name.
Definition: townname.cpp:119
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
QueryString townname_editbox
Townname editbox.
Definition: town_gui.cpp:1133
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
TownLayout
Town Layouts.
Definition: town_type.h:78
Generate a random town name.
Definition: town_widget.h:53
static const int ACTION_CLEAR
Clear editbox.
TownSize town_size
Selected town size.
Definition: town_gui.cpp:1130
TownFounding found_town
town founding.
Overview with ratings for each company.
Definition: town_widget.h:27
bool city
Are we building a city?
Definition: town_gui.cpp:1132
Tindex index
Index of this pool item.
Definition: pool_type.hpp:189
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:380
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:547
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:28
Close box (at top-left of a window)
Definition: widget_type.h:67
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
Definition: town.h:102
static bool TownRatingSorter(const Town *const &a, const Town *const &b)
Sort by town rating.
Definition: town_gui.cpp:737
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:963
void SetViewportCatchmentTown(const Town *t, bool sel)
Select or deselect town for coverage area highlight.
Definition: viewport.cpp:3476
TownLayout town_layout
select town layout,
String filter and state.
do a action from the town detail window (like advertises or bribe)
Definition: command_type.h:262
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:48
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:995
Functions related to world/map generation.
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:1925
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: town_gui.cpp:936
#define FOR_EACH_SET_BIT(bitpos_var, bitset_value)
Do an operation for each set set bit in a value.
bool persistent_buildingtools
keep the building tools active after usage
Common return value for all commands.
Definition: command_type.h:23
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: town_gui.cpp:260
bool GenerateTowns(TownLayout layout)
This function will generate a certain amount of towns, with a certain layout It can be called from th...
Definition: town_cmd.cpp:2129
uint32 GetWorldPopulation()
Determines the world population Basically, count population of all towns, one by one.
Definition: town_cmd.cpp:434
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
Town directory; Window numbers:
Definition: window_type.h:247
bool allow_town_roads
towns are allowed to build roads (always allowed when generating world / in SE)
uint32 population
Current population of people.
Definition: town.h:45
void OnPaint() override
The window must be repainted.
Definition: town_gui.cpp:349
List of towns.
Definition: town_widget.h:18
Nested widget to display a viewport in a window.
Definition: widget_type.h:573
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
void SetListing(Listing l)
Import sort conditions.
uint16 noise_reached
level of noise that all the airports are generating
Definition: town.h:66
Pure simple text.
Definition: widget_type.h:56
static GUITownList::SortFunction *const sorter_funcs[]
Available town directory sorting functions.
Definition: town_gui.cpp:678
const byte _town_action_costs[TACT_COUNT]
Factor in the cost of each town action.
Definition: town_cmd.cpp:2946
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:336
bool NeedRebuild() const
Check if a rebuild is needed.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: town_gui.cpp:191
void SetCapacity(int capacity)
Set the capacity of visible elements.
Definition: widget_type.h:684
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:668
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
void ForceRebuild()
Force that a rebuild is needed.
Base for the GUIs that have an edit box in them.
StringFilter string_filter
Filter for towns.
Definition: town_gui.cpp:680
uint32 goal[NUM_TE]
Amount of cargo required for the town to grow.
Definition: town.h:79
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void UpdateOSKOriginalText(const Window *parent, int button)
Updates the original text of the OSK so when the &#39;parent&#39; changes the original and you press on cance...
Definition: osk_gui.cpp:425
Caption of window.
Definition: town_widget.h:36
Selection for a medium town.
Definition: town_widget.h:55
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
void SetFilterTerm(const char *str)
Set the term to filter on.
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1044
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:264
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
Criteria of sort dropdown.
Definition: town_widget.h:16
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:279
enable the &#39;Default&#39; button ("\0" is returned)
Definition: textbuf_gui.h:21
Center the main view on this town.
Definition: town_widget.h:39
void OnResize() override
Called after the window got resized.
Definition: town_gui.cpp:536
TownEffect
Town growth effect when delivering cargo.
Definition: cargotype.h:24
Functions related to low-level strings.
List of commands for the player.
Definition: town_widget.h:28
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
void CommandCallback(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
Define a callback function for the client, after the command is finished.
Definition: command_type.h:470
The world&#39;s population.
Definition: town_widget.h:20
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: town_gui.cpp:1209
TileIndex xy
town center tile
Definition: town.h:54
Invisible widget that takes some space.
Definition: widget_type.h:77
Other information.
Definition: error.h:22
Functions related to errors.
QueryString townname_editbox
Filter editbox.
Definition: town_gui.cpp:681
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
Additional information about the action.
Definition: town_widget.h:30
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1957
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
TownSize
Supported initial town sizes.
Definition: town_type.h:19
const Town * _viewport_highlight_town
Currently selected town for coverage area highlight.
Definition: viewport.cpp:989
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:493
bool townnamevalid
Is generated town name valid?
Definition: town_gui.cpp:1134
SoundSettings sound
sound effect settings
Listing GetListing() const
Export current sort conditions.
bool order
Ascending/descending.
Definition: sortlist_type.h:32
found a town
Definition: command_type.h:260
int16 ratings[MAX_COMPANIES]
ratings of each company for this town
Definition: town.h:75
Town * town
Town being displayed.
Definition: town_gui.cpp:70
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: town_gui.cpp:344
uint smallest_y
Smallest vertical size of the widget in a filled window.
Definition: widget_type.h:170
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
Sort descending.
Definition: window_gui.h:225
void OnPaint() override
The window must be repainted.
Definition: town_gui.cpp:105
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:328
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition: window.cpp:573
char * GetTownName(char *buff, const TownNameParams *par, uint32 townnameparts, const char *last)
Fills buffer with specified town name.
Definition: townname.cpp:49
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:150
Definition of base types and functions in a cross-platform compatible way.
the length of the string is counted in characters
Definition: textbuf_gui.h:22
A number of safeguards to prevent using unsafe methods.
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Geometry functions.
rectangle (stations, depots, ...)
Allowed, with custom town layout.
Definition: town_type.h:96
Simple depressed panel.
Definition: widget_type.h:48
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: town_gui.cpp:977
void DrawSortButtonState(int widget, SortButtonState state) const
Draw a sort button&#39;s up or down arrow symbol.
Definition: widget.cpp:636
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:218
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
GUI Functions related to companies.
delete a town
Definition: command_type.h:267
Number of available town actions.
Definition: town.h:218
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: town_gui.cpp:559
Editor for the town name.
Definition: town_widget.h:52
const CargoSpec * FindFirstCargoWithTownEffect(TownEffect effect)
Determines the first cargo with a certain town effect.
Definition: town_cmd.cpp:2699
expand a town
Definition: command_type.h:266
Randomly place a town.
Definition: town_widget.h:50
void SetDParamMaxDigits(uint n, uint count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:120
int GetRowFromWidget(int clickpos, int widget, int padding, int line_height=-1) const
Compute the row of a widget that a user clicked in.
Definition: window.cpp:201
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
Baseclass for nested widgets.
Definition: widget_type.h:124
Found a town; Window numbers:
Definition: window_type.h:422
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:498
Selection for the 3x3 grid town layout.
Definition: town_widget.h:62
Do-it button.
Definition: town_widget.h:31
Toggle catchment area highlight.
Definition: town_widget.h:42
Basic functions/variables used all over the place.
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:532
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
Caption of window.
Definition: town_widget.h:25
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2385
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Functions related to sound.
void SetSortType(uint8 n_type)
Set the sorttype of the list.
bool Sort(SortFunction *compare)
Sort the list.
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:656
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: town_gui.cpp:226
bool Failed() const
Did this command fail?
Definition: command_type.h:159
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: town_gui.cpp:847
The filename filter has changed (via the editbox)
Definition: town.h:164
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: town_gui.cpp:1270
uint16 MaxTownNoise() const
Calculate the max town noise.
Definition: town.h:123
static const int WIDGET_LIST_END
indicate the end of widgets&#39; list for vararg functions
Definition: widget_type.h:20
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
void ShowExtraViewPortWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Road related functions.
Selection for the better town layout.
Definition: town_widget.h:60
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:700
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:587
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
static StringID GetTownString(const Town *t)
Get the string to draw the town name.
Definition: town_gui.cpp:794
char * text
General text with additional information.
Definition: town.h:81
Randomly place many towns.
Definition: town_widget.h:51
void OnHundredthTick() override
Called once every 100 (game) ticks.
Definition: town_gui.cpp:295
static const uint TOWN_GROWTH_DESERT
The town needs the cargo for growth when on desert (any amount)
Definition: town.h:35
uint16 growth_rate
town growth rate
Definition: town.h:94
Functions related to companies.
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Delete this town (scenario editor only).
Definition: town_widget.h:44
Tstorage old_max
Maximum amount last month.
Definition: town_type.h:113
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:60
Town directory window class.
Definition: town_gui.cpp:670
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
Town authority; Window numbers:
Definition: window_type.h:187
GUISettings gui
settings related to the GUI
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:340
Selection for a randomly chosen town layout.
Definition: town_widget.h:63
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:578
bool station_noise_level
build new airports when the town noise level is still within accepted limits
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
Create a new town.
Definition: town_widget.h:49
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition: main_gui.cpp:98
void OnPaint() override
The window must be repainted.
Definition: town_gui.cpp:947
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: town_gui.cpp:964
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here...
Change the name of this town.
Definition: town_widget.h:41
void Remove(const T &element)
Remove a single element from the tree, if it exists.
Definition: kdtree.hpp:420
Searching and filtering using a stringterm.
Sort ascending.
Definition: window_gui.h:224
Show the town authority window.
Definition: town_widget.h:40
Town * town
Town displayed by the window.
Definition: town_gui.cpp:317
Vertical container.
Definition: widget_type.h:75
uint GetMaskOfTownActions(int *nump, CompanyID cid, const Town *t)
Get a list of available actions to do at a town.
Definition: town_cmd.cpp:3192
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
uint32 townnameparts
Generated town name.
Definition: town_gui.cpp:1135
Town view; Window numbers:
Definition: window_type.h:326
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
Selection for the 2x2 grid town layout.
Definition: town_widget.h:61
Selection for the original town layout.
Definition: town_widget.h:59
void OnResize() override
Called after the window got resized.
Definition: town_gui.cpp:959
TownCache cache
Container for all cacheable data.
Definition: town.h:56
TownLayout town_layout
Selected town layout.
Definition: town_gui.cpp:1131
Selection for a randomly sized town.
Definition: town_widget.h:57
Town data structure.
Definition: town.h:53
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
Definition: town_gui.cpp:1254
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
bool confirm
Play sound effect on successful constructions or other actions.
Scrollbar for the town list.
Definition: town_widget.h:19
Functions related to OTTD&#39;s landscape.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2396
Non-water non-rail construction.
Definition: sound_type.h:68
static bool TownNameSorter(const Town *const &a, const Town *const &b)
Sort by town name.
Definition: town_gui.cpp:707
End of town effects.
Definition: cargotype.h:32
Functions related to commands.
bool larger_town
if this is a larger town and should grow more quickly
Definition: town.h:99
bool _network_server
network-server is active
Definition: network.cpp:53
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:770
Struct holding parameters used to generate town name.
Definition: townname_type.h:27
byte GetSnowLine()
Get the current snow line, either variable or static.
Definition: landscape.cpp:644
TownNameParams params
Town name parameters.
Definition: town_gui.cpp:1136
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:280
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
Definition: tile_map.h:29
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:31
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: town_gui.cpp:776
Drop down list.
Definition: widget_type.h:68
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:620
Town authority window.
Definition: town_gui.cpp:68
static const uint MAX_LENGTH_TOWN_NAME_CHARS
The maximum length of a town name in characters including &#39;\0&#39;.
Definition: town_type.h:108
Window does not do autoscroll,.
Definition: window_gui.h:239
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: town_gui.cpp:551
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
Types related to the town widgets.
K-dimensional tree, specialised for 2-dimensional space.
Definition: kdtree.hpp:38
static const StringID sorter_names[]
Names of the sorting functions.
Definition: town_gui.cpp:677
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:21
void Clear()
Clear the tree.
Definition: kdtree.hpp:380
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: town_gui.cpp:357
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Town name generator stuff.
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
Base of the town class.
bool IsDescSortOrder() const
Check if the sort order is descending.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: town_gui.cpp:799
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:368
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: town_gui.cpp:186
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
TransportedCargoStat< uint32 > supplied[NUM_CARGO]
Cargo statistics about supplied cargo.
Definition: town.h:77
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget. ...
Definition: widget.cpp:1971
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3353
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:82
static bool TownPopulationSorter(const Town *const &a, const Town *const &b)
Sort by population (default descending, as big towns are of the most interest).
Definition: town_gui.cpp:728
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:524
Text is written right-to-left by default.
Definition: strings_type.h:24
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
Functions related to tile highlights.
Window functions not directly related to making/drawing windows.
uint32 num_houses
Amount of houses.
Definition: town.h:44
Find a place automatically.
Definition: window_gui.h:154
Conditions for town growth are met. Grow according to Town::growth_rate.
Definition: town.h:175
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: town_gui.cpp:1259
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
GUI functions that shouldn&#39;t be here.
bool SortFunction(const T &, const T &)
Signature of sort function.
Definition: sortlist_type.h:49
static int GetNthSetBit(uint32 bits, int n)
Get the position of the Nth set bit.
Definition: town_gui.cpp:84
uint GetDesiredInfoHeight(int width) const
Gets the desired height for the information panel.
Definition: town_gui.cpp:499
void Insert(const T &element)
Insert a single element in the tree.
Definition: kdtree.hpp:401
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2142
CompanyID exclusivity
which company has exclusivity
Definition: town.h:73
Selection for the town&#39;s city state.
Definition: town_widget.h:58
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1093
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
Found a town window class.
Definition: town_gui.cpp:1128
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:427
bool IsEmpty() const
Check whether any filter words were entered.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition: window.cpp:1259
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
View of the center of the town.
Definition: town_widget.h:37
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:835
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1074
Default zoom level for the news messages.
Definition: zoom_type.h:34
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window&#39;s data as invalid (in need of re-computing)
Definition: window.cpp:3256
Tstorage old_act
Actually transported last month.
Definition: town_type.h:115
CompanyMask have_ratings
which companies have a rating
Definition: town.h:71
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1462
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:621
void UpdateSize()
Update Textbuf type with its actual physical character and screenlength Get the count of characters i...
Definition: textbuf.cpp:430
(Toggle) Button with text
Definition: widget_type.h:53
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:629
uint8 SortType() const
Get the sorttype of the list.
Definition: sortlist_type.h:94
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199