OpenTTD Source: src/object_gui.cpp Source File

OpenTTD Source 12.2

object_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 "command_func.h"
12 #include "hotkeys.h"
13 #include "newgrf.h"
14 #include "newgrf_object.h"
15 #include "newgrf_text.h"
16 #include "object.h"
17 #include "querystring_gui.h"
18 #include "sortlist_type.h"
19 #include "stringfilter_type.h"
20 #include "string_func.h"
21 #include "strings_func.h"
22 #include "viewport_func.h"
23 #include "tilehighlight_func.h"
24 #include "window_gui.h"
25 #include "window_func.h"
26 #include "zoom_func.h"
27
28 #include "widgets/object_widget.h"
29
30 #include "table/strings.h"
31
32 #include "safeguards.h"
33
34 static ObjectClassID _selected_object_class;
35 static int _selected_object_index;
36 static uint8 _selected_object_view;
37
39 enum BuildObjectHotkeys {
40 BOHK_FOCUS_FILTER_BOX,
41 };
42
44 class BuildObjectWindow : public Window {
45 typedef GUIList<ObjectClassID, StringFilter &> GUIObjectClassList;
46
47 static const uint EDITBOX_MAX_SIZE = 16;
48 static const int OBJECT_MARGIN = 4;
49
50 int line_height;
51 int info_height;
52 Scrollbar *vscroll;
53
54 static Listing last_sorting;
55 static Filtering last_filtering;
56 static GUIObjectClassList::SortFunction * const sorter_funcs[];
57 static GUIObjectClassList::FilterFunction * const filter_funcs[];
58 GUIObjectClassList object_classes;
59 StringFilter string_filter;
60 QueryString filter_editbox;
61
63 void EnsureSelectedObjectClassIsVisible()
64 {
65 uint pos = 0;
66 for (auto object_class_id : this->object_classes) {
67 if (object_class_id == _selected_object_class) break;
68 pos++;
69 }
70 this->vscroll->ScrollTowards(pos);
71 }
72
77 bool CanRestoreSelectedObject()
78 {
79 if (_selected_object_index == -1) return false;
80
81 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
82 if ((int)objclass->GetSpecCount() <= _selected_object_index) return false;
83
84 return objclass->GetSpec(_selected_object_index)->IsAvailable();
85 }
86
91 uint GetMatrixColumnCount()
92 {
93 const NWidgetBase *matrix = this->GetWidget<NWidgetBase>(WID_BO_SELECT_MATRIX);
94 return 1 + (matrix->current_x - matrix->smallest_x) / matrix->resize_x;
95 }
96
97 public:
98 BuildObjectWindow(WindowDesc *desc, WindowNumber number) : Window(desc), info_height(1), filter_editbox(EDITBOX_MAX_SIZE * MAX_CHAR_LENGTH, EDITBOX_MAX_SIZE)
99 {
100 this->CreateNestedTree();
101
102 this->vscroll = this->GetScrollbar(WID_BO_SCROLLBAR);
103
104 this->querystrings[WID_BO_FILTER] = &this->filter_editbox;
105
106 this->object_classes.SetListing(this->last_sorting);
107 this->object_classes.SetFiltering(this->last_filtering);
108 this->object_classes.SetSortFuncs(this->sorter_funcs);
109 this->object_classes.SetFilterFuncs(this->filter_funcs);
110 this->object_classes.ForceRebuild();
111
112 BuildObjectClassesAvailable();
113 SelectClassAndObject();
114
115 this->FinishInitNested(number);
116
117 NWidgetMatrix *matrix = this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX);
118 matrix->SetScrollbar(this->GetScrollbar(WID_BO_SELECT_SCROLL));
119
120 this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetCount(4);
121
122 ResetObjectToPlace();
123
124 this->vscroll->SetCount((int)this->object_classes.size());
125
126 EnsureSelectedObjectClassIsVisible();
127
128 this->InvalidateData();
129 }
130
132 static bool ObjectClassIDSorter(ObjectClassID const &a, ObjectClassID const &b)
133 {
134 return a < b;
135 }
136
138 static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
139 {
140 ObjectClass *objclass = ObjectClass::Get(*oc);
141 char buffer[DRAW_STRING_BUFFER];
142 GetString(buffer, objclass->name, lastof(buffer));
143
144 filter.ResetState();
145 filter.AddLine(buffer);
146 return filter.GetState();
147 }
148
150 void BuildObjectClassesAvailable()
151 {
152 if (!this->object_classes.NeedRebuild()) return;
153
154 this->object_classes.clear();
155
156 for (uint i = 0; i < ObjectClass::GetClassCount(); i++) {
157 ObjectClass *objclass = ObjectClass::Get((ObjectClassID)i);
158 if (objclass->GetUISpecCount() == 0) continue; // Is this needed here?
159 object_classes.push_back((ObjectClassID)i);
160 }
161
162 this->object_classes.Filter(this->string_filter);
163 this->object_classes.shrink_to_fit();
164 this->object_classes.RebuildDone();
165 this->object_classes.Sort();
166
167 this->vscroll->SetCount((uint)this->object_classes.size());
168 }
169
174 void SelectClassAndObject()
175 {
176 assert(!this->object_classes.empty()); // object GUI should be disabled elsewise
177 if (_selected_object_class == ObjectClassID::OBJECT_CLASS_BEGIN) {
178 /* This happens during the first time the window is open during the game life cycle. */
179 this->SelectOtherClass(this->object_classes[0]);
180 } else {
181 /* Check if the previously selected object class is not available anymore as a
182 * result of starting a new game without the corresponding NewGRF. */
183 bool available = false;
184 for (uint i = 0; ObjectClass::GetClassCount(); ++i) {
185 if ((ObjectClassID)i == _selected_object_class) {
186 available = true;
187 break;
188 }
189 }
190
191 if (available) {
192 this->SelectOtherClass(_selected_object_class);
193 } else {
194 this->SelectOtherClass(this->object_classes[0]);
195 }
196 }
197
198 if (this->CanRestoreSelectedObject()) {
199 this->SelectOtherObject(_selected_object_index);
200 } else {
201 this->SelectFirstAvailableObject(true);
202 }
203 assert(ObjectClass::Get(_selected_object_class)->GetUISpecCount() > 0); // object GUI should be disabled elsewise
204 }
205
206 void SetStringParameters(int widget) const override
207 {
208 switch (widget) {
209 case WID_BO_OBJECT_NAME: {
210 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
211 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
212 SetDParam(0, spec != nullptr ? spec->name : STR_EMPTY);
213 break;
214 }
215
216 case WID_BO_OBJECT_SIZE: {
217 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
218 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
219 int size = spec == nullptr ? 0 : spec->size;
220 SetDParam(0, GB(size, HasBit(_selected_object_view, 0) ? 4 : 0, 4));
221 SetDParam(1, GB(size, HasBit(_selected_object_view, 0) ? 0 : 4, 4));
222 break;
223 }
224
225 default: break;
226 }
227 }
228
229 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
230 {
231 switch (widget) {
232 case WID_BO_CLASS_LIST: {
233 for (auto object_class_id : this->object_classes) {
234 ObjectClass *objclass = ObjectClass::Get(object_class_id);
235 if (objclass->GetUISpecCount() == 0) continue;
236 size->width = std::max(size->width, GetStringBoundingBox(objclass->name).width);
237 }
238 size->width += padding.width;
239 this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
240 resize->height = this->line_height;
241 size->height = 5 * this->line_height;
242 break;
243 }
244
245 case WID_BO_OBJECT_NAME:
246 case WID_BO_OBJECT_SIZE:
247 /* We do not want the window to resize when selecting objects; better clip texts */
248 size->width = 0;
249 break;
250
251 case WID_BO_OBJECT_MATRIX: {
252 /* Get the right amount of buttons based on the current spec. */
253 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
254 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
255 if (spec != nullptr) {
256 if (spec->views >= 2) size->width += resize->width;
257 if (spec->views >= 4) size->height += resize->height;
258 }
259 resize->width = 0;
260 resize->height = 0;
261 break;
262 }
263
264 case WID_BO_OBJECT_SPRITE: {
265 bool two_wide = false; // Whether there will be two widgets next to each other in the matrix or not.
266 int height[2] = {0, 0}; // The height for the different views; in this case views 1/2 and 4.
267
268 /* Get the height and view information. */
269 for (int i = 0; i < NUM_OBJECTS; i++) {
270 const ObjectSpec *spec = ObjectSpec::Get(i);
271 if (!spec->IsEverAvailable()) continue;
272 two_wide |= spec->views >= 2;
273 height[spec->views / 4] = std::max<int>(ObjectSpec::Get(i)->height, height[spec->views / 4]);
274 }
275
276 /* Determine the pixel heights. */
277 for (size_t i = 0; i < lengthof(height); i++) {
278 height[i] *= ScaleGUITrad(TILE_HEIGHT);
279 height[i] += ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN;
280 }
281
282 /* Now determine the size of the minimum widgets. When there are two columns, then
283 * we want these columns to be slightly less wide. When there are two rows, then
284 * determine the size of the widgets based on the maximum size for a single row
285 * of widgets, or just the twice the widget height of the two row ones. */
286 size->height = std::max(height[0], height[1] * 2 + 2);
287 if (two_wide) {
288 size->width = (3 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN) * 2 + 2;
289 } else {
290 size->width = 4 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN;
291 }
292
293 /* Get the right size for the single widget based on the current spec. */
294 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
295 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
296 if (spec != nullptr) {
297 if (spec->views >= 2) size->width = size->width / 2 - 1;
298 if (spec->views >= 4) size->height = size->height / 2 - 1;
299 }
300 break;
301 }
302
303 case WID_BO_INFO:
304 size->height = this->info_height;
305 break;
306
307 case WID_BO_SELECT_MATRIX:
308 fill->height = 1;
309 resize->height = 1;
310 break;
311
312 case WID_BO_SELECT_IMAGE:
313 size->width = ScaleGUITrad(64) + 2;
314 size->height = ScaleGUITrad(58) + 2;
315 break;
316
317 default: break;
318 }
319 }
320
321 void DrawWidget(const Rect &r, int widget) const override
322 {
323 switch (GB(widget, 0, 16)) {
324 case WID_BO_CLASS_LIST: {
325 int y = r.top;
326 uint pos = 0;
327 for (auto object_class_id : this->object_classes) {
328 ObjectClass *objclass = ObjectClass::Get(object_class_id);
329 if (objclass->GetUISpecCount() == 0) continue;
330 if (!this->vscroll->IsVisible(pos++)) continue;
331 DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y + WD_MATRIX_TOP, objclass->name,
332 (object_class_id == _selected_object_class) ? TC_WHITE : TC_BLACK);
333 y += this->line_height;
334 }
335 break;
336 }
337
338 case WID_BO_OBJECT_SPRITE: {
339 if (_selected_object_index == -1) break;
340
341 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
342 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
343 if (spec == nullptr) break;
344
345 /* Height of the selection matrix.
346 * Depending on the number of views, the matrix has a 1x1, 1x2, 2x1 or 2x2 layout. To make the previews
347 * look nice in all layouts, we use the 4x4 layout (smallest previews) as starting point. For the bigger
348 * previews in the layouts with less views we add space homogeneously on all sides, so the 4x4 preview-rectangle
349 * is centered in the 2x1, 1x2 resp. 1x1 buttons. */
350 uint matrix_height = this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->current_y;
351
352 DrawPixelInfo tmp_dpi;
353 /* Set up a clipping area for the preview. */
354 if (FillDrawPixelInfo(&tmp_dpi, r.left, r.top, r.right - r.left + 1, r.bottom - r.top + 1)) {
355 DrawPixelInfo *old_dpi = _cur_dpi;
356 _cur_dpi = &tmp_dpi;
357 if (spec->grf_prop.grffile == nullptr) {
358 extern const DrawTileSprites _objects[];
359 const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
360 DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, (r.bottom - r.top + matrix_height / 2) / 2 - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
361 } else {
362 DrawNewObjectTileInGUI((r.right - r.left) / 2 - 1, (r.bottom - r.top + matrix_height / 2) / 2 - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), spec, GB(widget, 16, 16));
363 }
364 _cur_dpi = old_dpi;
365 }
366 break;
367 }
368
369 case WID_BO_SELECT_IMAGE: {
370 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
371 int obj_index = objclass->GetIndexFromUI(GB(widget, 16, 16));
372 if (obj_index < 0) break;
373 const ObjectSpec *spec = objclass->GetSpec(obj_index);
374 if (spec == nullptr) break;
375
376 if (!spec->IsAvailable()) {
377 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK, FILLRECT_CHECKER);
378 }
379 DrawPixelInfo tmp_dpi;
380 /* Set up a clipping area for the preview. */
381 if (FillDrawPixelInfo(&tmp_dpi, r.left + 1, r.top, (r.right - 1) - (r.left + 1) + 1, r.bottom - r.top + 1)) {
382 DrawPixelInfo *old_dpi = _cur_dpi;
383 _cur_dpi = &tmp_dpi;
384 if (spec->grf_prop.grffile == nullptr) {
385 extern const DrawTileSprites _objects[];
386 const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
387 DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
388 } else {
389 DrawNewObjectTileInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), spec,
390 std::min<int>(_selected_object_view, spec->views - 1));
391 }
392 _cur_dpi = old_dpi;
393 }
394 break;
395 }
396
397 case WID_BO_INFO: {
398 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
399 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
400 if (spec == nullptr) break;
401
402 /* Get the extra message for the GUI */
403 if (HasBit(spec->callback_mask, CBM_OBJ_FUND_MORE_TEXT)) {
404 uint16 callback_res = GetObjectCallback(CBID_OBJECT_FUND_MORE_TEXT, 0, 0, spec, nullptr, INVALID_TILE, _selected_object_view);
405 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
406 if (callback_res > 0x400) {
407 ErrorUnknownCallbackResult(spec->grf_prop.grffile->grfid, CBID_OBJECT_FUND_MORE_TEXT, callback_res);
408 } else {
409 StringID message = GetGRFStringID(spec->grf_prop.grffile->grfid, 0xD000 + callback_res);
410 if (message != STR_NULL && message != STR_UNDEFINED) {
411 StartTextRefStackUsage(spec->grf_prop.grffile, 6);
412 /* Use all the available space left from where we stand up to the
413 * end of the window. We ALSO enlarge the window if needed, so we
414 * can 'go' wild with the bottom of the window. */
415 int y = DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, message, TC_ORANGE) - r.top;
416 StopTextRefStackUsage();
417 if (y > this->info_height) {
418 BuildObjectWindow *bow = const_cast<BuildObjectWindow *>(this);
419 bow->info_height = y + 2;
420 bow->ReInit();
421 }
422 }
423 }
424 }
425 }
426 }
427 }
428 }
429
434 void SelectOtherClass(ObjectClassID object_class)
435 {
436 _selected_object_class = object_class;
437 ObjectClass *objclass = ObjectClass::Get(object_class);
438 this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetCount(objclass->GetUISpecCount());
439 }
440
445 void SelectOtherObject(int object_index)
446 {
447 _selected_object_index = object_index;
448 if (_selected_object_index != -1) {
449 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
450 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
451 _selected_object_view = std::min<int>(_selected_object_view, spec->views - 1);
452 this->ReInit();
453 } else {
454 _selected_object_view = 0;
455 }
456
457 if (_selected_object_index != -1) {
458 SetObjectToPlaceWnd(SPR_CURSOR_TRANSMITTER, PAL_NONE, HT_RECT, this);
459 }
460
461 this->UpdateButtons(_selected_object_class, _selected_object_index, _selected_object_view);
462 }
463
464 void UpdateSelectSize()
465 {
466 if (_selected_object_index == -1) {
467 SetTileSelectSize(1, 1);
468 } else {
469 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
470 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
471 int w = GB(spec->size, HasBit(_selected_object_view, 0) ? 4 : 0, 4);
472 int h = GB(spec->size, HasBit(_selected_object_view, 0) ? 0 : 4, 4);
473 SetTileSelectSize(w, h);
474 }
475 }
476
483 void UpdateButtons(ObjectClassID object_class, int sel_index, uint sel_view)
484 {
485 int view_number, object_number;
486 if (sel_index == -1) {
487 view_number = -1; // If no object selected, also hide the selected view.
488 object_number = -1;
489 } else {
490 view_number = sel_view;
491 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
492 object_number = objclass->GetUIFromIndex(sel_index);
493 }
494
495 this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetClicked(view_number);
496 this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetClicked(object_number);
497 this->UpdateSelectSize();
498 this->SetDirty();
499 }
500
501 void OnInvalidateData(int data = 0, bool gui_scope = true) override
502 {
503 if (!gui_scope) return;
504
505 this->BuildObjectClassesAvailable();
506 }
507
508 void OnResize() override
509 {
510 this->vscroll->SetCapacityFromWidget(this, WID_BO_CLASS_LIST);
511 }
512
513 void OnClick(Point pt, int widget, int click_count) override
514 {
515 switch (GB(widget, 0, 16)) {
516 case WID_BO_CLASS_LIST: {
517 int num_clicked = this->vscroll->GetPosition() + (pt.y - this->GetWidget<NWidgetBase>(widget)->pos_y) / this->line_height;
518 if (num_clicked >= (int)this->object_classes.size()) break;
519
520 this->SelectOtherClass(this->object_classes[num_clicked]);
521 this->SelectFirstAvailableObject(false);
522 break;
523 }
524
525 case WID_BO_SELECT_IMAGE: {
526 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
527 int num_clicked = objclass->GetIndexFromUI(GB(widget, 16, 16));
528 if (num_clicked >= 0 && objclass->GetSpec(num_clicked)->IsAvailable()) this->SelectOtherObject(num_clicked);
529 break;
530 }
531
532 case WID_BO_OBJECT_SPRITE:
533 if (_selected_object_index != -1) {
534 _selected_object_view = GB(widget, 16, 16);
535 this->SelectOtherObject(_selected_object_index); // Re-select the object for a different view.
536 }
537 break;
538 }
539 }
540
541 void OnPlaceObject(Point pt, TileIndex tile) override
542 {
543 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
544 DoCommandP(tile, objclass->GetSpec(_selected_object_index)->Index(),
545 _selected_object_view, CMD_BUILD_OBJECT | CMD_MSG(STR_ERROR_CAN_T_BUILD_OBJECT), CcTerraform);
546 }
547
548 void OnPlaceObjectAbort() override
549 {
550 this->UpdateButtons(_selected_object_class, -1, _selected_object_view);
551 }
552
553 EventState OnHotkey(int hotkey) override
554 {
555 switch (hotkey) {
556 case BOHK_FOCUS_FILTER_BOX:
557 this->SetFocusedWidget(WID_BO_FILTER);
558 SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
559 break;
560
561 default:
562 return ES_NOT_HANDLED;
563 }
564
565 return ES_HANDLED;
566 }
567
568 void OnEditboxChanged(int wid) override
569 {
570 string_filter.SetFilterTerm(this->filter_editbox.text.buf);
571 this->object_classes.SetFilterState(!string_filter.IsEmpty());
572 this->object_classes.ForceRebuild();
573 this->InvalidateData();
574 }
575
581 void SelectFirstAvailableObject(bool change_class)
582 {
583 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
584
585 /* First try to select an object in the selected class. */
586 for (uint i = 0; i < objclass->GetSpecCount(); i++) {
587 const ObjectSpec *spec = objclass->GetSpec(i);
588 if (spec->IsAvailable()) {
589 this->SelectOtherObject(i);
590 return;
591 }
592 }
593 if (change_class) {
594 /* If that fails, select the first available object
595 * from a random class. */
596 for (auto object_class_id : this->object_classes) {
597 ObjectClass *objclass = ObjectClass::Get(object_class_id);
598 for (uint i = 0; i < objclass->GetSpecCount(); i++) {
599 const ObjectSpec *spec = objclass->GetSpec(i);
600 if (spec->IsAvailable()) {
601 this->SelectOtherClass(object_class_id);
602 this->SelectOtherObject(i);
603 return;
604 }
605 }
606 }
607 }
608 /* If all objects are unavailable, select nothing... */
609 if (objclass->GetUISpecCount() == 0) {
610 /* ... but make sure that the class is not empty. */
611 for (auto object_class_id : this->object_classes) {
612 ObjectClass *objclass = ObjectClass::Get(object_class_id);
613 if (objclass->GetUISpecCount() > 0) {
614 this->SelectOtherClass(object_class_id);
615 break;
616 }
617 }
618 }
619 this->SelectOtherObject(-1);
620 }
621
622 static HotkeyList hotkeys;
623 };
624
630 static EventState BuildObjectGlobalHotkeys(int hotkey)
631 {
632 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
633 Window *w = ShowBuildObjectPicker();
634 if (w == nullptr) return ES_NOT_HANDLED;
635 return w->OnHotkey(hotkey);
636 }
637
638 static Hotkey buildobject_hotkeys[] = {
639 Hotkey('F', "focus_filter_box", BOHK_FOCUS_FILTER_BOX),
640 HOTKEY_LIST_END
641 };
642 HotkeyList BuildObjectWindow::hotkeys("buildobject", buildobject_hotkeys, BuildObjectGlobalHotkeys);
643
644 Listing BuildObjectWindow::last_sorting = { false, 0 };
645 Filtering BuildObjectWindow::last_filtering = { false, 0 };
646
647 BuildObjectWindow::GUIObjectClassList::SortFunction * const BuildObjectWindow::sorter_funcs[] = {
648 &ObjectClassIDSorter,
649 };
650
651 BuildObjectWindow::GUIObjectClassList::FilterFunction * const BuildObjectWindow::filter_funcs[] = {
652 &TagNameFilter,
653 };
654
655 static const NWidgetPart _nested_build_object_widgets[] = {
656 NWidget(NWID_HORIZONTAL),
657 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
658 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_OBJECT_BUILD_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
659 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
660 EndContainer(),
661 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
662 NWidget(NWID_HORIZONTAL), SetPadding(2, 0, 0, 2),
663 NWidget(NWID_VERTICAL), SetPadding(0, 5, 2, 0), SetPIP(0, 2, 0),
664 NWidget(NWID_HORIZONTAL),
665 NWidget(WWT_TEXT, COLOUR_DARK_GREEN), SetFill(0, 1), SetDataTip(STR_LIST_FILTER_TITLE, STR_NULL),
666 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_BO_FILTER), SetFill(1, 0), SetResize(1, 0),
667 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
668 EndContainer(),
669 NWidget(NWID_HORIZONTAL),
670 NWidget(WWT_MATRIX, COLOUR_GREY, WID_BO_CLASS_LIST), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_OBJECT_BUILD_CLASS_TOOLTIP), SetScrollbar(WID_BO_SCROLLBAR),
671 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_BO_SCROLLBAR),
672 EndContainer(),
673 NWidget(NWID_HORIZONTAL),
674 NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_OBJECT_MATRIX), SetPIP(0, 2, 0),
675 NWidget(WWT_PANEL, COLOUR_GREY, WID_BO_OBJECT_SPRITE), SetDataTip(0x0, STR_OBJECT_BUILD_PREVIEW_TOOLTIP), EndContainer(),
676 EndContainer(),
677 EndContainer(),
678 NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_NAME), SetDataTip(STR_ORANGE_STRING, STR_NULL),
679 NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_SIZE), SetDataTip(STR_OBJECT_BUILD_SIZE, STR_NULL),
680 EndContainer(),
681 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetScrollbar(WID_BO_SELECT_SCROLL),
682 NWidget(NWID_HORIZONTAL),
683 NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_SELECT_MATRIX), SetFill(0, 1), SetPIP(0, 2, 0),
684 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BO_SELECT_IMAGE), SetMinimalSize(66, 60), SetDataTip(0x0, STR_OBJECT_BUILD_TOOLTIP),
685 SetFill(0, 0), SetResize(0, 0), SetScrollbar(WID_BO_SELECT_SCROLL),
686 EndContainer(),
687 EndContainer(),
688 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_BO_SELECT_SCROLL),
689 EndContainer(),
690 EndContainer(),
691 EndContainer(),
692 NWidget(NWID_HORIZONTAL),
693 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_BO_INFO), SetPadding(0, 5, 0, 1), SetFill(1, 0), SetResize(1, 0),
694 NWidget(NWID_VERTICAL),
695 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(0, 1), EndContainer(),
696 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
697 EndContainer(),
698 EndContainer(),
699 EndContainer(),
700 };
701
702 static WindowDesc _build_object_desc(
703 WDP_AUTO, "build_object", 0, 0,
704 WC_BUILD_OBJECT, WC_BUILD_TOOLBAR,
705 WDF_CONSTRUCTION,
706 _nested_build_object_widgets, lengthof(_nested_build_object_widgets),
707 &BuildObjectWindow::hotkeys
708 );
709
711 Window *ShowBuildObjectPicker()
712 {
713 /* Don't show the place object button when there are no objects to place. */
714 if (ObjectClass::GetUIClassCount() > 0) {
715 return AllocateWindowDescFront<BuildObjectWindow>(&_build_object_desc, 0);
716 }
717 return nullptr;
718 }
719
721 void InitializeObjectGui()
722 {
723 _selected_object_class = ObjectClassID::OBJECT_CLASS_BEGIN;
724 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
OBJECT_CLASS_BEGIN
@ OBJECT_CLASS_BEGIN
The lowest valid value.
Definition: newgrf_object.h:47
_selected_object_index
static int _selected_object_index
Index of the currently selected object if existing, else -1.
Definition: object_gui.cpp:35
WID_BO_FILTER
@ WID_BO_FILTER
The filter text box for the object list.
Definition: object_widget.h:15
BuildObjectWindow::ObjectClassIDSorter
static bool ObjectClassIDSorter(ObjectClassID const &a, ObjectClassID const &b)
Sort object classes by ObjectClassID.
Definition: object_gui.cpp:132
SetTileSelectSize
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2472
BuildObjectWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: object_gui.cpp:501
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:372
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
BuildObjectWindow::CanRestoreSelectedObject
bool CanRestoreSelectedObject()
Tests whether the previously selected object can be selected.
Definition: object_gui.cpp:77
WC_BUILD_TOOLBAR
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:65
BuildObjectWindow::EnsureSelectedObjectClassIsVisible
void EnsureSelectedObjectClassIsVisible()
Scroll WID_BO_CLASS_LIST so that the selected object class is visible.
Definition: object_gui.cpp:63
WD_MATRIX_RIGHT
@ WD_MATRIX_RIGHT
Offset at right of a matrix cell.
Definition: window_gui.h:79
querystring_gui.h
BuildObjectWindow::last_filtering
static Filtering last_filtering
Default filtering of GUIObjectClassList.
Definition: object_gui.cpp:55
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
NewGRFClass::GetUISpecCount
uint GetUISpecCount() const
Get the number of potentially user-available specs within the class.
Definition: newgrf_class.h:46
HotkeyList
List of hotkeys for a window.
Definition: hotkeys.h:40
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
SetFocusedWindow
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:445
BuildObjectHotkeys
BuildObjectHotkeys
Enum referring to the Hotkeys in the build object window.
Definition: object_gui.cpp:39
DrawOrigTileSeqInGUI
static void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
Draw TTD sprite sequence in GUI.
Definition: sprite.h:115
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
BuildObjectWindow::GetMatrixColumnCount
uint GetMatrixColumnCount()
Calculate the number of columns of the WID_BO_SELECT_MATRIX widget.
Definition: object_gui.cpp:91
command_func.h
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:58
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:60
SetPadding
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:1139
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition: sortlist_type.h:247
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:210
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:1004
BuildObjectWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: object_gui.cpp:513
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
WD_MATRIX_TOP
@ WD_MATRIX_TOP
Offset at top of a matrix cell.
Definition: window_gui.h:80
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Scrollbar::ScrollTowards
void ScrollTowards(int position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
Definition: widget_type.h:775
NewGRFClass::GetSpecCount
uint GetSpecCount() const
Get the number of allocated specs within the class.
Definition: newgrf_class.h:44
NWidgetMatrix
Matrix container with implicitly equal sized (virtual) sub-widgets.
Definition: widget_type.h:532
GUIList< ObjectClassID, StringFilter & >
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
BuildObjectWindow
The window used for building objects.
Definition: object_gui.cpp:44
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
ObjectSpec::IsAvailable
bool IsAvailable() const
Check whether the object is available at this time.
Definition: newgrf_object.cpp:78
object_widget.h
WWT_MATRIX
@ WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:57
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:710
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
DrawNewObjectTileInGUI
void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view)
Draw representation of an object (tile) for GUI purposes.
Definition: newgrf_object.cpp:464
NUM_OBJECTS
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition: object_type.h:25
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
zoom_func.h
WID_BO_INFO
@ WID_BO_INFO
Other information about the object (from the NewGRF).
Definition: object_widget.h:22
StartTextRefStackUsage
void StartTextRefStackUsage(const GRFFile *grffile, byte numEntries, const uint32 *values)
Start using the TTDP compatible string code parsing.
Definition: newgrf_text.cpp:821
NWidgetMatrix::SetScrollbar
void SetScrollbar(Scrollbar *sb)
Assign a scrollbar to this matrix.
Definition: widget.cpp:1651
DrawString
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:643
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
StringFilter::AddLine
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Definition: stringfilter.cpp:104
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
StopTextRefStackUsage
void StopTextRefStackUsage()
Stop using the TTDP compatible string code parsing.
Definition: newgrf_text.cpp:838
InitializeObjectGui
void InitializeObjectGui()
Reset all data of the object GUI.
Definition: object_gui.cpp:721
ObjectSpec::IsEverAvailable
bool IsEverAvailable() const
Check whether the object might be available at some point in this game with the current game mode.
Definition: newgrf_object.cpp:59
BuildObjectWindow::SelectOtherClass
void SelectOtherClass(ObjectClassID object_class)
Select the specified object class.
Definition: object_gui.cpp:434
NWID_MATRIX
@ NWID_MATRIX
Matrix container.
Definition: widget_type.h:76
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
ObjectSpec::Get
static const ObjectSpec * Get(ObjectType index)
Get the specification associated with a specific ObjectType.
Definition: newgrf_object.cpp:39
Window::OnHotkey
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:621
ObjectSpec::size
uint8 size
The size of this objects; low nibble for X, high nibble for Y.
Definition: newgrf_object.h:65
ObjectSpec::callback_mask
uint16 callback_mask
Bitmask of requested/allowed callbacks.
Definition: newgrf_object.h:72
SetDParam
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:196
BuildObjectWindow::filter_funcs
static GUIObjectClassList::FilterFunction *const filter_funcs[]
Filter functions of the GUIObjectClassList.
Definition: object_gui.cpp:57
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
WID_BO_SELECT_MATRIX
@ WID_BO_SELECT_MATRIX
Selection preview matrix of objects of a given class.
Definition: object_widget.h:24
BuildObjectWindow::OnPlaceObject
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
Definition: object_gui.cpp:541
BuildObjectWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: object_gui.cpp:508
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:889
GUIList::SetFilterFuncs
void SetFilterFuncs(FilterFunction *const *n_funcs)
Hand the array of filter function pointers to the sort list.
Definition: sortlist_type.h:341
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
BuildObjectWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: object_gui.cpp:206
DrawStringMultiLine
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:788
MAX_CHAR_LENGTH
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
BuildObjectWindow::SelectClassAndObject
void SelectClassAndObject()
Checks if the previously selected current object class and object can be shown as selected to the use...
Definition: object_gui.cpp:174
WindowDesc
High level window description.
Definition: window_gui.h:168
CBM_OBJ_FUND_MORE_TEXT
@ CBM_OBJ_FUND_MORE_TEXT
additional text in fund window
Definition: newgrf_callbacks.h:386
window_gui.h
WID_BO_SCROLLBAR
@ WID_BO_SCROLLBAR
The scrollbar associated with the list.
Definition: object_widget.h:17
BuildObjectWindow::UpdateButtons
void UpdateButtons(ObjectClassID object_class, int sel_index, uint sel_view)
Update buttons to show the selection to the user.
Definition: object_gui.cpp:483
BuildObjectWindow::TagNameFilter
static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
Filter object classes by class name.
Definition: object_gui.cpp:138
_selected_object_view
static uint8 _selected_object_view
the view of the selected object
Definition: object_gui.cpp:36
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
Listing
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:30
GUIList::SetFilterState
void SetFilterState(bool state)
Enable or disable the filter.
Definition: sortlist_type.h:302
DRAW_STRING_BUFFER
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:86
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
tilehighlight_func.h
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
WID_BO_SELECT_IMAGE
@ WID_BO_SELECT_IMAGE
Preview image in the WID_BO_SELECT_MATRIX.
Definition: object_widget.h:25
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
ObjectClassID
ObjectClassID
Class IDs for objects.
Definition: newgrf_object.h:46
GUIList< ObjectClassID, StringFilter & >::SortFunction
bool SortFunction(const ObjectClassID &, const ObjectClassID &)
Signature of sort function.
Definition: sortlist_type.h:48
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
BuildObjectWindow::filter_editbox
QueryString filter_editbox
Filter editbox.
Definition: object_gui.cpp:60
GUIList::SetListing
void SetListing(Listing l)
Import sort conditions.
Definition: sortlist_type.h:130
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:183
BuildObjectWindow::info_height
int info_height
The height of the info box.
Definition: object_gui.cpp:51
BuildObjectGlobalHotkeys
static EventState BuildObjectGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildObjectWindow.
Definition: object_gui.cpp:630
BOHK_FOCUS_FILTER_BOX
@ BOHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition: object_gui.cpp:40
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
SetMatrixDataTip
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1125
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:19
Filtering
Data structure describing what to show in the list (filter criteria).
Definition: sortlist_type.h:35
_selected_object_class
static ObjectClassID _selected_object_class
Currently selected available object class.
Definition: object_gui.cpp:34
safeguards.h
WID_BO_OBJECT_SPRITE
@ WID_BO_OBJECT_SPRITE
A preview sprite of the object.
Definition: object_widget.h:19
sortlist_type.h
GetGRFStringID
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
Definition: newgrf_text.cpp:601
BuildObjectWindow::OBJECT_MARGIN
static const int OBJECT_MARGIN
The margin (in pixels) around an object.
Definition: object_gui.cpp:48
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:58
newgrf_text.h
BuildObjectWindow::line_height
int line_height
The height of a single line.
Definition: object_gui.cpp:50
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
BuildObjectWindow::GUIObjectClassList
GUIList< ObjectClassID, StringFilter & > GUIObjectClassList
Type definition for the list to hold available object classes.
Definition: object_gui.cpp:45
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:506
stdafx.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:192
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:117
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3174
viewport_func.h
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1770
BuildObjectWindow::BuildObjectClassesAvailable
void BuildObjectClassesAvailable()
Builds the filter list of available object classes.
Definition: object_gui.cpp:150
newgrf_object.h
ObjectSpec::name
StringID name
The name for this object.
Definition: newgrf_object.h:62
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition: sortlist_type.h:362
string_func.h
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:404
ShowBuildObjectPicker
Window * ShowBuildObjectPicker()
Show our object picker.
Definition: object_gui.cpp:711
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
BuildObjectWindow::vscroll
Scrollbar * vscroll
The scrollbar.
Definition: object_gui.cpp:52
BuildObjectWindow::OnHotkey
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition: object_gui.cpp:553
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
BuildObjectWindow::OnPlaceObjectAbort
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: object_gui.cpp:548
ObjectSpec::views
uint8 views
The number of views.
Definition: newgrf_object.h:74
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:167
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
Scrollbar::IsVisible
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:681
GUIList< ObjectClassID, StringFilter & >::FilterFunction
bool CDECL FilterFunction(const ObjectClassID *, StringFilter &)
Signature of filter function.
Definition: sortlist_type.h:49
BuildObjectWindow::object_classes
GUIObjectClassList object_classes
Available object classes.
Definition: object_gui.cpp:58
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
StringFilter::ResetState
void ResetState()
Reset the matching state to process a new item.
Definition: stringfilter.cpp:88
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
WID_BO_SELECT_SCROLL
@ WID_BO_SELECT_SCROLL
Scrollbar next to the WID_BO_SELECT_MATRIX.
Definition: object_widget.h:26
newgrf.h
EventState
EventState
State of handling an event.
Definition: window_type.h:717
GetObjectCallback
uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view)
Perform a callback for an object.
Definition: newgrf_object.cpp:408
HT_RECT
@ HT_RECT
rectangle (stations, depots, ...)
Definition: tilehighlight_type.h:21
CMD_BUILD_OBJECT
@ CMD_BUILD_OBJECT
build an object
Definition: command_type.h:187
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:671
GUIList::SetFiltering
void SetFiltering(Filtering f)
Import filter conditions.
Definition: sortlist_type.h:181
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
NewGRFClass::name
StringID name
Name of this class.
Definition: newgrf_class.h:39
GUIList::Filter
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
Definition: sortlist_type.h:318
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
WID_BO_CLASS_LIST
@ WID_BO_CLASS_LIST
The list with classes.
Definition: object_widget.h:16
BuildObjectWindow::SelectFirstAvailableObject
void SelectFirstAvailableObject(bool change_class)
Select the first available object.
Definition: object_gui.cpp:581
WD_MATRIX_BOTTOM
@ WD_MATRIX_BOTTOM
Offset at bottom of a matrix cell.
Definition: window_gui.h:81
window_func.h
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition: sortlist_type.h:370
BuildObjectWindow::UpdateWidgetSize
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: object_gui.cpp:229
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
stringfilter_type.h
NewGRFClass::Get
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
Definition: newgrf_class_func.h:103
Scrollbar::SetCapacityFromWidget
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:2172
WC_BUILD_OBJECT
@ WC_BUILD_OBJECT
Build object; Window numbers:
Definition: window_type.h:368
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1169
TILE_HEIGHT
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:16
WID_BO_OBJECT_NAME
@ WID_BO_OBJECT_NAME
The name of the selected object.
Definition: object_widget.h:20
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
SetObjectToPlaceWnd
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3360
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
BuildObjectWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: object_gui.cpp:568
BuildObjectWindow::string_filter
StringFilter string_filter
Filter for available objects.
Definition: object_gui.cpp:59
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
BuildObjectWindow::EDITBOX_MAX_SIZE
static const uint EDITBOX_MAX_SIZE
The maximum number of characters for the filter edit box.
Definition: object_gui.cpp:47
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:516
BuildObjectWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: object_gui.cpp:321
Window
Data structure for an opened window.
Definition: window_gui.h:279
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
TILE_PIXELS
static const uint TILE_PIXELS
Pixel distance between tile columns/rows in #ZOOM_LVL_BASE.
Definition: tile_type.h:15
BuildObjectWindow::SelectOtherObject
void SelectOtherObject(int object_index)
Select the specified object in _selected_object_class class.
Definition: object_gui.cpp:445
WD_MATRIX_LEFT
@ WD_MATRIX_LEFT
Offset at left of a matrix cell.
Definition: window_gui.h:78
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
BuildObjectWindow::last_sorting
static Listing last_sorting
Default sorting of GUIObjectClassList.
Definition: object_gui.cpp:54
WID_BO_OBJECT_SIZE
@ WID_BO_OBJECT_SIZE
The size of the selected object.
Definition: object_widget.h:21
WID_BO_OBJECT_MATRIX
@ WID_BO_OBJECT_MATRIX
The matrix with preview sprites.
Definition: object_widget.h:18
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:178
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:186
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3423
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
object.h
GUIList::SetSortFuncs
void SetSortFuncs(SortFunction *const *n_funcs)
Hand the array of sort function pointers to the sort list.
Definition: sortlist_type.h:270
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
Hotkey
All data for a single hotkey.
Definition: hotkeys.h:22
BuildObjectWindow::sorter_funcs
static GUIObjectClassList::SortFunction *const sorter_funcs[]
Sort functions of the GUIObjectClassList.
Definition: object_gui.cpp:56
hotkeys.h
CBID_OBJECT_FUND_MORE_TEXT
@ CBID_OBJECT_FUND_MORE_TEXT
Called to determine more text in the fund object window.
Definition: newgrf_callbacks.h:269