OpenTTD Source 20261112-master-gbcbec5e63f
terraform_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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "core/backup_type.hpp"
12#include "clear_map.h"
13#include "company_func.h"
14#include "company_base.h"
15#include "gui.h"
16#include "window_gui.h"
17#include "window_func.h"
18#include "viewport_func.h"
19#include "command_func.h"
20#include "signs_func.h"
21#include "sound_func.h"
22#include "base_station_base.h"
23#include "textbuf_gui.h"
24#include "genworld.h"
25#include "tree_map.h"
26#include "landscape_type.h"
27#include "tilehighlight_func.h"
28#include "strings_func.h"
29#include "newgrf_object.h"
30#include "object.h"
31#include "hotkeys.h"
32#include "engine_base.h"
33#include "terraform_gui.h"
34#include "terraform_cmd.h"
35#include "zoom_func.h"
36#include "rail_cmd.h"
37#include "landscape_cmd.h"
38#include "terraform_cmd.h"
39#include "object_cmd.h"
40
42
43#include "table/strings.h"
44
45#include "safeguards.h"
46
47void CcTerraform(Commands, const CommandCost &result, Money, TileIndex tile)
48{
49 if (result.Succeeded()) {
50 if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, tile);
51 } else {
53 }
54}
55
56
62static void GenerateDesertArea(TileIndex end, TileIndex start)
63{
64 if (_game_mode != GameMode::Editor) return;
65
66 Backup<bool> old_generating_world(_generating_world, true);
67
68 TileArea ta(start, end);
69 for (TileIndex tile : ta) {
71 Command<Commands::LandscapeClear>::Post(tile);
73 }
74 old_generating_world.Restore();
75 InvalidateWindowClassesData(WindowClass::TownView, 0);
76}
77
84static void PlaceRockyArea(TileIndex end, TileIndex start, bool remove)
85{
86 if (_game_mode != GameMode::Editor) return;
87
88 bool success = false;
89 TileArea ta(start, end);
90
91 for (TileIndex tile : ta) {
92 switch (GetTileType(tile)) {
93 case TileType::Trees:
94 if (GetTreeGround(tile) == TreeGround::Shore) continue;
95 if (!remove) {
97 }
98 break;
99
100 case TileType::Clear:
101 if (remove) {
102 if (GetClearGround(tile) == ClearGround::Rocks) {
104 }
105 } else {
107 }
108 break;
109
110 case TileType::Water:
111 if (remove) {
112 switch (GetWaterTileType(tile)) {
115 default: continue;
116 }
117 } else {
118 switch (GetWaterTileType(tile)) {
120 if (GetTileSlope(tile) != SLOPE_FLAT) continue;
122 break;
123
125 default: continue;
126 }
127 }
128 break;
129
130 default:
131 continue;
132 }
134 success = true;
135 }
136
137 if (success && _settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, end);
138}
139
146static void PlaceRoughGround(TileIndex end, TileIndex start, bool remove)
147{
148 if (_game_mode != GameMode::Editor) return;
149
150 bool success = false;
151 TileArea ta(start, end);
152
153 for (TileIndex tile : ta) {
154 switch (GetTileType(tile)) {
155 case TileType::Trees: {
156 /* Preserve snowline density underneath trees, so the tile loop
157 * doesn't have to come back and fix it later. */
158 uint density = GetTreeDensity(tile);
159 if (remove) {
160 switch (GetTreeGround(tile)) {
163 break;
166 break;
167 default:
168 continue;
169 }
170 } else {
171 switch (GetTreeGround(tile)) {
174 break;
177 break;
178 default:
179 continue;
180 }
181 }
182 break;
183 }
184
185 case TileType::Clear:
186 if (remove) {
187 if (GetClearGround(tile) == ClearGround::Rough) {
189 } else {
190 continue;
191 }
192 } else {
194 }
195 break;
196
197 default:
198 continue;
199 }
201 success = true;
202 }
203
204 if (success && _settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, end);
205}
206
217{
218 if (!_settings_game.construction.freeform_edges) {
219 /* When end_tile is TileType::Void, the error tile will not be visible to the
220 * user. This happens when terraforming at the southern border. */
221 if (TileX(end_tile) == Map::MaxX()) end_tile += TileDiffXY(-1, 0);
222 if (TileY(end_tile) == Map::MaxY()) end_tile += TileDiffXY(0, -1);
223 }
224
225 switch (proc) {
227 Command<Commands::ClearArea>::Post(STR_ERROR_CAN_T_CLEAR_THIS_AREA, CcPlaySound_EXPLOSION, end_tile, start_tile, IsCtrlPressed());
228 break;
230 Command<Commands::LevelLand>::Post(STR_ERROR_CAN_T_RAISE_LAND_HERE, CcTerraform, end_tile, start_tile, IsCtrlPressed(), LevelMode::Raise);
231 break;
233 Command<Commands::LevelLand>::Post(STR_ERROR_CAN_T_LOWER_LAND_HERE, CcTerraform, end_tile, start_tile, IsCtrlPressed(), LevelMode::Lower);
234 break;
235 case DDSP_LEVEL_AREA:
236 Command<Commands::LevelLand>::Post(STR_ERROR_CAN_T_LEVEL_LAND_HERE, CcTerraform, end_tile, start_tile, IsCtrlPressed(), LevelMode::Level);
237 break;
239 PlaceRockyArea(end_tile, start_tile, IsCtrlPressed());
240 break;
242 PlaceRoughGround(end_tile, start_tile, IsCtrlPressed());
243 break;
245 GenerateDesertArea(end_tile, start_tile);
246 break;
247 default:
248 return false;
249 }
250
251 return true;
252}
253
262
264struct TerraformToolbarWindow : Window {
266
267 TerraformToolbarWindow(WindowDesc &desc, WindowNumber window_number) : Window(desc)
268 {
269 /* This is needed as we like to have the tree available on OnInit. */
270 this->CreateNestedTree();
271 this->FinishInitNested(window_number);
272 }
273
274 void OnInit() override
275 {
276 /* Don't show the place object button when there are no objects to place. */
279 }
280
281 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
282 {
283 if (widget < WID_TT_BUTTONS_START) return;
284
285 switch (widget) {
286 case WID_TT_LOWER_LAND: // Lower land button
288 this->last_user_action = widget;
289 break;
290
291 case WID_TT_RAISE_LAND: // Raise land button
293 this->last_user_action = widget;
294 break;
295
296 case WID_TT_LEVEL_LAND: // Level land button
298 this->last_user_action = widget;
299 break;
300
301 case WID_TT_DEMOLISH: // Demolish aka dynamite button
303 this->last_user_action = widget;
304 break;
305
306 case WID_TT_BUY_LAND: // Buy land button
308 this->last_user_action = widget;
309 break;
310
311 case WID_TT_PLANT_TREES: // Plant trees button
312 ShowBuildTreesToolbar();
313 break;
314
315 case WID_TT_PLACE_SIGN: // Place sign button
317 this->last_user_action = widget;
318 break;
319
320 case WID_TT_PLACE_OBJECT: // Place object button
322 break;
323
324 default: NOT_REACHED();
325 }
326 }
327
328 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
329 {
330 switch (this->last_user_action) {
331 case WID_TT_LOWER_LAND: // Lower land button
333 break;
334
335 case WID_TT_RAISE_LAND: // Raise land button
337 break;
338
339 case WID_TT_LEVEL_LAND: // Level land button
341 break;
342
343 case WID_TT_DEMOLISH: // Demolish aka dynamite button
345 break;
346
347 case WID_TT_BUY_LAND: // Buy land button
349 break;
350
351 case WID_TT_PLACE_SIGN: // Place sign button
352 PlaceProc_Sign(tile);
353 break;
354
355 default: NOT_REACHED();
356 }
357 }
358
359 void OnPlaceDrag(ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt) override
360 {
361 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
362 }
363
364 Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
365 {
367 if (FindWindowByClass(WindowClass::BuildToolbar) != nullptr && !_settings_client.gui.link_terraform_toolbar) pt.y += sm_height;
368
369 return pt;
370 }
371
372 void OnPlaceMouseUp([[maybe_unused]] ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, TileIndex start_tile, TileIndex end_tile) override
373 {
374 if (pt.x != -1) {
375 switch (select_proc) {
376 default: NOT_REACHED();
380 case DDSP_LEVEL_AREA:
381 GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
382 break;
384 if (!_settings_game.construction.freeform_edges) {
385 /* When end_tile is TileType::Void, the error tile will not be visible to the
386 * user. This happens when terraforming at the southern border. */
387 if (TileX(end_tile) == Map::MaxX()) end_tile += TileDiffXY(-1, 0);
388 if (TileY(end_tile) == Map::MaxY()) end_tile += TileDiffXY(0, -1);
389 }
390 Command<Commands::BuildObjectArea>::Post(STR_ERROR_CAN_T_PURCHASE_THIS_LAND, CcPlaySound_CONSTRUCTION_RAIL,
391 end_tile, start_tile, OBJECT_OWNED_LAND, 0, IsCtrlPressed());
392 break;
393 }
394 }
395 }
396
397 void OnPlaceObjectAbort() override
398 {
399 this->RaiseButtons();
400 }
401
408 {
409 if (_game_mode != GameMode::Normal) return EventState::NotHandled;
410 Window *w = ShowTerraformToolbar(nullptr);
411 if (w == nullptr) return EventState::NotHandled;
412 return w->OnHotkey(hotkey);
413 }
414
415 static inline HotkeyList hotkeys{"terraform", {
419 Hotkey('D' | WKC_GLOBAL_HOTKEY, "dynamite", WID_TT_DEMOLISH),
420 Hotkey('U', "buyland", WID_TT_BUY_LAND),
421 Hotkey('I', "trees", WID_TT_PLANT_TREES),
422 Hotkey('O', "placesign", WID_TT_PLACE_SIGN),
423 Hotkey('P', "placeobject", WID_TT_PLACE_OBJECT),
425};
426
427static constexpr std::initializer_list<NWidgetPart> _nested_terraform_widgets = {
430 NWidget(WWT_CAPTION, Colours::DarkGreen), SetStringTip(STR_LANDSCAPING_TOOLBAR, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
432 EndContainer(),
435 SetFill(0, 1), SetSpriteTip(SPR_IMG_TERRAFORM_DOWN, STR_LANDSCAPING_TOOLTIP_LOWER_A_CORNER_OF_LAND),
437 SetFill(0, 1), SetSpriteTip(SPR_IMG_TERRAFORM_UP, STR_LANDSCAPING_TOOLTIP_RAISE_A_CORNER_OF_LAND),
439 SetFill(0, 1), SetSpriteTip(SPR_IMG_LEVEL_LAND, STR_LANDSCAPING_LEVEL_LAND_TOOLTIP),
440
442
444 SetFill(0, 1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
446 SetFill(0, 1), SetSpriteTip(SPR_IMG_BUY_LAND, STR_LANDSCAPING_TOOLTIP_PURCHASE_LAND),
448 SetFill(0, 1), SetSpriteTip(SPR_IMG_PLANTTREES, STR_SCENEDIT_TOOLBAR_PLANT_TREES_TOOLTIP),
450 SetFill(0, 1), SetSpriteTip(SPR_IMG_SIGN, STR_SCENEDIT_TOOLBAR_PLACE_SIGN_TOOLTIP),
453 SetFill(0, 1), SetSpriteTip(SPR_IMG_TRANSMITTER, STR_SCENEDIT_TOOLBAR_PLACE_OBJECT_TOOLTIP),
454 EndContainer(),
455 EndContainer(),
456};
457
460 WindowPosition::Manual, "toolbar_landscape", 0, 0,
461 WindowClass::ScenarioGenerateLandscape, WindowClass::None,
463 _nested_terraform_widgets,
464 &TerraformToolbarWindow::hotkeys
465);
466
473{
474 if (!Company::IsValidID(_local_company)) return nullptr;
475
476 /* Delete the terraform toolbar to place it again. */
477 CloseWindowById(WindowClass::ScenarioGenerateLandscape, 0, true);
478
480
482 /* Put the linked toolbar to the left / right of the main toolbar. */
483 link->left = w->left + (_current_text_dir == TD_RTL ? w->width : -link->width);
484 link->top = w->top;
485 link->SetDirty();
486
487 return w;
488}
489
490static uint8_t _terraform_size = 1;
491
501static void CommonRaiseLowerBigLand(TileIndex tile, bool mode)
502{
503 if (_terraform_size == 1) {
504 StringID msg =
505 mode ? STR_ERROR_CAN_T_RAISE_LAND_HERE : STR_ERROR_CAN_T_LOWER_LAND_HERE;
506
507 Command<Commands::TerraformLand>::Post(msg, CcTerraform, tile, SLOPE_N, mode);
508 } else {
509 assert(_terraform_size != 0);
510 TileArea ta(tile, _terraform_size, _terraform_size);
511 ta.ClampToMap();
512
513 if (ta.w == 0 || ta.h == 0) return;
514
515 if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, tile);
516
517 uint h;
518 if (mode != 0) {
519 /* Raise land */
520 h = MAX_TILE_HEIGHT;
521 for (TileIndex tile2 : ta) {
522 h = std::min(h, TileHeight(tile2));
523 }
524 } else {
525 /* Lower land */
526 h = 0;
527 for (TileIndex tile2 : ta) {
528 h = std::max(h, TileHeight(tile2));
529 }
530 }
531
532 for (TileIndex tile2 : ta) {
533 if (TileHeight(tile2) == h) {
534 Command<Commands::TerraformLand>::Post(tile2, SLOPE_N, mode);
535 }
536 }
537 }
538}
539
540static const int8_t _multi_terraform_coords[][2] = {
541 { 0, -2},
542 { 4, 0}, { -4, 0}, { 0, 2},
543 { -8, 2}, { -4, 4}, { 0, 6}, { 4, 4}, { 8, 2},
544 {-12, 0}, { -8, -2}, { -4, -4}, { 0, -6}, { 4, -4}, { 8, -2}, { 12, 0},
545 {-16, 2}, {-12, 4}, { -8, 6}, { -4, 8}, { 0, 10}, { 4, 8}, { 8, 6}, { 12, 4}, { 16, 2},
546 {-20, 0}, {-16, -2}, {-12, -4}, { -8, -6}, { -4, -8}, { 0,-10}, { 4, -8}, { 8, -6}, { 12, -4}, { 16, -2}, { 20, 0},
547 {-24, 2}, {-20, 4}, {-16, 6}, {-12, 8}, { -8, 10}, { -4, 12}, { 0, 14}, { 4, 12}, { 8, 10}, { 12, 8}, { 16, 6}, { 20, 4}, { 24, 2},
548 {-28, 0}, {-24, -2}, {-20, -4}, {-16, -6}, {-12, -8}, { -8,-10}, { -4,-12}, { 0,-14}, { 4,-12}, { 8,-10}, { 12, -8}, { 16, -6}, { 20, -4}, { 24, -2}, { 28, 0},
549};
550
551static constexpr std::initializer_list<NWidgetPart> _nested_scen_edit_land_gen_widgets = {
554 NWidget(WWT_CAPTION, Colours::DarkGreen), SetStringTip(STR_TERRAFORM_TOOLBAR_LAND_GENERATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
557 EndContainer(),
559 NWidget(NWID_HORIZONTAL), SetPadding(2, 2, 7, 2),
562 SetFill(0, 1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
564 SetFill(0, 1), SetSpriteTip(SPR_IMG_TERRAFORM_DOWN, STR_TERRAFORM_TOOLTIP_LOWER_A_CORNER_OF_LAND),
566 SetFill(0, 1), SetSpriteTip(SPR_IMG_TERRAFORM_UP, STR_TERRAFORM_TOOLTIP_RAISE_A_CORNER_OF_LAND),
568 SetFill(0, 1), SetSpriteTip(SPR_IMG_LEVEL_LAND, STR_LANDSCAPING_LEVEL_LAND_TOOLTIP),
570 SetFill(0, 1), SetSpriteTip(SPR_IMG_ROCKS, STR_TERRAFORM_TOOLTIP_PLACE_ROCKY_AREAS_ON_LANDSCAPE),
572 SetFill(0, 1), SetSpriteTip(SPR_IMG_SHOW_COUNTOURS, STR_TERRAFORM_TOOLTIP_PLACE_ROUGH_AREAS_ON_LANDSCAPE),
575 SetFill(0, 1), SetSpriteTip(SPR_IMG_DESERT, STR_TERRAFORM_TOOLTIP_DEFINE_DESERT_AREA),
576 EndContainer(),
578 SetFill(0, 1), SetSpriteTip(SPR_IMG_TRANSMITTER, STR_SCENEDIT_TOOLBAR_PLACE_OBJECT_TOOLTIP),
580 EndContainer(),
587 NWidget(WWT_IMGBTN, Colours::Grey, WID_ETT_INCREASE_SIZE), SetMinimalSize(12, 12), SetSpriteTip(SPR_ARROW_UP, STR_TERRAFORM_TOOLTIP_INCREASE_SIZE_OF_LAND_AREA),
589 NWidget(WWT_IMGBTN, Colours::Grey, WID_ETT_DECREASE_SIZE), SetMinimalSize(12, 12), SetSpriteTip(SPR_ARROW_DOWN, STR_TERRAFORM_TOOLTIP_DECREASE_SIZE_OF_LAND_AREA),
591 EndContainer(),
593 EndContainer(),
596 SetFill(1, 0), SetStringTip(STR_TERRAFORM_SE_NEW_WORLD, STR_TERRAFORM_TOOLTIP_GENERATE_RANDOM_LAND), SetPadding(0, 2, 0, 2),
598 SetFill(1, 0), SetStringTip(STR_TERRAFORM_RESET_LANDSCAPE, STR_TERRAFORM_RESET_LANDSCAPE_TOOLTIP), SetPadding(1, 2, 2, 2),
599 EndContainer(),
600};
601
606static void ResetLandscapeConfirmationCallback(Window *, bool confirmed)
607{
608 if (confirmed) {
609 /* Set generating_world to true to get instant-green grass after removing
610 * company property. */
611 Backup<bool> old_generating_world(_generating_world, true);
612
613 /* Delete all companies */
614 for (Company *c : Company::Iterate()) {
616 delete c;
617 }
618
619 old_generating_world.Restore();
620
621 /* Delete all station signs */
622 for (BaseStation *st : BaseStation::Iterate()) {
623 /* There can be buoys, remove them */
624 if (IsBuoyTile(st->xy)) Command<Commands::LandscapeClear>::Do({DoCommandFlag::Execute, DoCommandFlag::Bankrupt}, st->xy);
625 if (!st->IsInUse()) delete st;
626 }
627
628 /* Now that all vehicles are gone, we can reset the engine pool. Maybe it reduces some NewGRF changing-mess */
630
632 }
633}
634
636struct ScenarioEditorLandscapeGenerationWindow : Window {
638
639 ScenarioEditorLandscapeGenerationWindow(WindowDesc &desc, WindowNumber window_number) : Window(desc)
640 {
641 this->CreateNestedTree();
643 show_desert->SetDisplayedPlane(_settings_game.game_creation.landscape == LandscapeType::Tropic ? 0 : SZSP_NONE);
644 this->FinishInitNested(window_number);
645 }
646
647 void OnPaint() override
648 {
649 this->DrawWidgets();
650
651 if (this->IsWidgetLowered(WID_ETT_LOWER_LAND) || this->IsWidgetLowered(WID_ETT_RAISE_LAND)) { // change area-size if raise/lower corner is selected
652 SetTileSelectSize(_terraform_size, _terraform_size);
653 }
654 }
655
656 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
657 {
658 if (widget != WID_ETT_DOTS) return;
659
660 size.width = std::max<uint>(size.width, ScaleGUITrad(59));
661 size.height = std::max<uint>(size.height, ScaleGUITrad(31));
662 }
663
664 void DrawWidget(const Rect &r, WidgetID widget) const override
665 {
666 if (widget != WID_ETT_DOTS) return;
667
668 int center_x = RoundDivSU(r.left + r.right, 2);
669 int center_y = RoundDivSU(r.top + r.bottom, 2);
670
671 int n = _terraform_size * _terraform_size;
672 const int8_t *coords = &_multi_terraform_coords[0][0];
673
674 assert(n != 0);
675 do {
676 DrawSprite(SPR_WHITE_POINT, PAL_NONE, center_x + ScaleGUITrad(coords[0]), center_y + ScaleGUITrad(coords[1]));
677 coords += 2;
678 } while (--n);
679 }
680
681 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
682 {
683 if (widget < WID_ETT_BUTTONS_START) return;
684
685 switch (widget) {
686 case WID_ETT_DEMOLISH: // Demolish aka dynamite button
688 this->last_user_action = widget;
689 break;
690
691 case WID_ETT_LOWER_LAND: // Lower land button
693 this->last_user_action = widget;
694 break;
695
696 case WID_ETT_RAISE_LAND: // Raise land button
698 this->last_user_action = widget;
699 break;
700
701 case WID_ETT_LEVEL_LAND: // Level land button
703 this->last_user_action = widget;
704 break;
705
706 case WID_ETT_PLACE_ROCKS: // Place rocks button
708 this->last_user_action = widget;
709 break;
710
711 case WID_ETT_PLACE_ROUGH: // Place rough land button
713 this->last_user_action = widget;
714 break;
715
716 case WID_ETT_PLACE_DESERT: // Place desert button (in tropical climate)
718 this->last_user_action = widget;
719 break;
720
721 case WID_ETT_PLACE_OBJECT: // Place transmitter button
723 break;
724
726 case WID_ETT_DECREASE_SIZE: { // Increase/Decrease terraform size
727 int size = (widget == WID_ETT_INCREASE_SIZE) ? 1 : -1;
728 this->HandleButtonClick(widget);
729 size += _terraform_size;
730
731 if (!IsInsideMM(size, 1, 8 + 1)) return;
732 _terraform_size = size;
733
734 this->SetDirty();
735 break;
736 }
737
738 case WID_ETT_NEW_SCENARIO: // gen random land
739 this->HandleButtonClick(widget);
741 break;
742
743 case WID_ETT_RESET_LANDSCAPE: // Reset landscape
744 ShowQuery(
745 GetEncodedString(STR_QUERY_RESET_LANDSCAPE_CAPTION),
746 GetEncodedString(STR_RESET_LANDSCAPE_CONFIRMATION_TEXT),
748 break;
749
750 default: NOT_REACHED();
751 }
752 }
753
754 void OnTimeout() override
755 {
756 for (const auto &pair : this->widget_lookup) {
757 if (pair.first < WID_ETT_START || (pair.first >= WID_ETT_BUTTONS_START && pair.first < WID_ETT_BUTTONS_END)) continue; // skip the buttons
758 this->RaiseWidgetWhenLowered(pair.first);
759 }
760 }
761
762 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
763 {
764 switch (this->last_user_action) {
765 case WID_ETT_DEMOLISH: // Demolish aka dynamite button
767 break;
768
769 case WID_ETT_LOWER_LAND: // Lower land button
770 if (_terraform_size == 1) {
772 } else {
773 CommonRaiseLowerBigLand(tile, false);
774 }
775 break;
776
777 case WID_ETT_RAISE_LAND: // Raise land button
778 if (_terraform_size == 1) {
780 } else {
781 CommonRaiseLowerBigLand(tile, true);
782 }
783 break;
784
785 case WID_ETT_LEVEL_LAND: // Level land button
787 break;
788
789 case WID_ETT_PLACE_ROCKS: // Place rocks button
791 break;
792
793 case WID_ETT_PLACE_ROUGH: // Place rough land button
795 break;
796
797 case WID_ETT_PLACE_DESERT: // Place desert button (in tropical climate)
799 break;
800
801 default: NOT_REACHED();
802 }
803 }
804
805 void OnPlaceDrag(ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt) override
806 {
807 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
808 }
809
810 void OnPlaceMouseUp([[maybe_unused]] ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, TileIndex start_tile, TileIndex end_tile) override
811 {
812 if (pt.x != -1) {
813 switch (select_proc) {
814 default: NOT_REACHED();
820 case DDSP_LEVEL_AREA:
822 GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
823 break;
824 }
825 }
826 }
827
829 {
830 switch (this->last_user_action) {
834 if (this->IsWidgetLowered(this->last_user_action)) {
835 SetSelectionRed(IsCtrlPressed());
836 return EventState::Handled;
837 }
838 break;
839 }
841 }
842
843 void OnPlaceObjectAbort() override
844 {
845 this->RaiseButtons();
846 this->SetDirty();
847 }
848
855 {
856 if (_game_mode != GameMode::Editor) return EventState::NotHandled;
858 if (w == nullptr) return EventState::NotHandled;
859 return w->OnHotkey(hotkey);
860 }
861
862 static inline HotkeyList hotkeys{"terraform_editor", {
863 Hotkey('D' | WKC_GLOBAL_HOTKEY, "dynamite", WID_ETT_DEMOLISH),
867 Hotkey('R', "rocky", WID_ETT_PLACE_ROCKS),
868 Hotkey('T', "desert", WID_ETT_PLACE_DESERT),
869 Hotkey('O', "object", WID_ETT_PLACE_OBJECT),
871};
872
875 WindowPosition::Automatic, "toolbar_landscape_scen", 0, 0,
876 WindowClass::ScenarioGenerateLandscape, WindowClass::None,
878 _nested_scen_edit_land_gen_widgets,
879 &ScenarioEditorLandscapeGenerationWindow::hotkeys
880);
881
Class for backupping variables and making sure they are restored later.
Base classes/functions for base stations.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
Stacked widgets, widgets all occupying the same space in the window.
bool SetDisplayedPlane(int plane)
Select which plane to show (for NWID_SELECTION only).
Definition widget.cpp:1458
void ClampToMap()
Clamp the tile area to map borders.
uint16_t w
The width of the area.
uint16_t h
The height of the area.
Map accessors for 'clear' tiles.
@ Rocks
Rocks with snow transition (0-3).
Definition clear_map.h:24
@ Grass
Plain grass with dirt transition (0-3).
Definition clear_map.h:22
@ Rough
Rough mounds (3).
Definition clear_map.h:23
void MakeClear(Tile t, ClearGround g, uint density)
Make a clear tile.
Definition clear_map.h:253
ClearGround GetClearGround(Tile t)
Get the type of clear tile.
Definition clear_map.h:52
void SetClearGroundDensity(Tile t, ClearGround type, uint density)
Sets ground type and density in one go, also sets the counter to 0.
Definition clear_map.h:152
Functions related to commands.
@ Execute
execute the given command
@ Bankrupt
company bankrupts, skip money check, skip vehicle on tile check in some cases
Commands
List of commands.
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
Change the ownership of all the items of a company.
Definition economy.cpp:325
static constexpr Owner INVALID_OWNER
An invalid owner.
Base class for engines.
bool _generating_world
Whether we are generating the map or not.
Definition genworld.cpp:70
Functions related to world/map generation.
void ShowCreateScenario()
Show the window to create a scenario.
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:1032
bool IsCtrlPressed()
Test if the ctrl key is pressed.
Definition gfx_func.h:82
@ Invalid
Invalid marker.
Definition gfx_type.h:302
@ Grey
Grey.
Definition gfx_type.h:299
@ DarkGreen
Dark green.
Definition gfx_type.h:292
@ WKC_GLOBAL_HOTKEY
Fake keycode bit to indicate global hotkeys.
Definition gfx_type.h:35
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetToolbarMinimalSize(int width)
Widget part function to setting the minimal size for a toolbar button.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetToolbarSpacerMinimalSize()
Widget part function to setting the minimal size for a toolbar spacer.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
static const CursorID ANIMCURSOR_DEMOLISH
704 - 707 - demolish dynamite
Definition sprites.h:1694
static const CursorID ANIMCURSOR_LOWERLAND
699 - 701 - lower land tool
Definition sprites.h:1695
static const CursorID ANIMCURSOR_RAISELAND
696 - 698 - raise land tool
Definition sprites.h:1696
static const CursorID SPR_CURSOR_LEVEL_LAND
Definition sprites.h:1578
static const CursorID SPR_CURSOR_SIGN
Definition sprites.h:1574
static const CursorID SPR_CURSOR_ROCKY_AREA
Definition sprites.h:1582
static const CursorID SPR_CURSOR_DESERT
Definition sprites.h:1583
static const CursorID SPR_CURSOR_BUY_LAND
Definition sprites.h:1577
void SetDirty() const
Mark entire window as dirty (in need of re-paint).
Definition window.cpp:1013
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1548
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
GUI functions that shouldn't be here.
Hotkey related functions.
Command definitions related to landscape (slopes etc.).
Types related to the landscape.
@ Tropic
Landscape with distinct rainforests and deserts,.
#define Point
Macro that prevents name conflicts between included headers.
bool HandlePlacePushButton(Window *w, WidgetID widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition main_gui.cpp:58
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:392
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
@ Raise
Raise the land.
Definition map_type.h:46
@ Level
Level the land.
Definition map_type.h:44
@ Lower
Lower the land.
Definition map_type.h:45
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
void ShowQuery(EncodedString &&caption, EncodedString &&message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
Functions related to NewGRF objects.
Functions related to objects.
Window * ShowBuildObjectPicker()
Show our object picker.
Command definitions related to objects.
static const ObjectType OBJECT_OWNED_LAND
Owned land 'flag'.
Definition object_type.h:21
@ Editor
In the scenario editor.
Definition openttd.h:21
@ Normal
Playing a game.
Definition openttd.h:20
Command definitions for rail.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
void PlaceProc_Sign(TileIndex tile)
PlaceProc function, called when someone pressed the button if the sign-tool is selected.
Functions related to signs.
@ SLOPE_N
the north corner of the tile is raised
Definition slope_type.h:58
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:54
Functions related to sound.
@ SND_1F_CONSTRUCTION_OTHER
29 == 0x1D Construction: other (non-water, non-rail, non-bridge)
Definition sound_type.h:76
static const SpriteID SPR_IMG_PLANTTREES
Definition sprites.h:1260
static const SpriteID SPR_IMG_DYNAMITE
Definition sprites.h:1236
static const SpriteID SPR_IMG_SIGN
Definition sprites.h:1276
static const SpriteID SPR_IMG_TRANSMITTER
Definition sprites.h:1239
static const SpriteID SPR_IMG_BUY_LAND
Definition sprites.h:1277
static const SpriteID SPR_IMG_ROCKS
Definition sprites.h:1237
static const SpriteID SPR_IMG_SHOW_COUNTOURS
Definition sprites.h:1256
static const SpriteID SPR_IMG_TERRAFORM_UP
Definition sprites.h:1234
static const SpriteID SPR_IMG_LEVEL_LAND
Definition sprites.h:1240
static const SpriteID SPR_ARROW_DOWN
Definition sprites.h:85
static const SpriteID SPR_IMG_DESERT
Definition sprites.h:1238
static const SpriteID SPR_ARROW_UP
Definition sprites.h:86
static const SpriteID SPR_IMG_TERRAFORM_DOWN
Definition sprites.h:1235
bool IsBuoyTile(Tile t)
Is tile t a buoy tile?
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:89
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:55
Functions related to OTTD's strings.
StrongType::Typedef< uint32_t, struct StringIDTag, StrongType::Compare, StrongType::Integer > StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
Class to backup a specific variable and restore it later.
void Restore()
Restore the variable.
Base class for all station-ish types.
T y
Y coordinate.
Dimensions (a width and height) of a rectangle in 2D.
value_type height
The height of the rectangle.
value_type width
The width of the rectangle.
static bool ResetToCurrentNewGRFConfig()
Tries to reset the engine mapping to match the current NewGRF configuration.
Definition engine.cpp:622
List of hotkeys for a window.
Definition hotkeys.h:44
All data for a single hotkey.
Definition hotkeys.h:20
static uint MaxY()
Gets the maximum Y coordinate within the map, including TileType::Void.
Definition map_func.h:298
static uint MaxX()
Gets the maximum X coordinate within the map, including TileType::Void.
Definition map_func.h:289
static Pool::IterateWrapper< Company > Iterate(size_t from=0)
Specification of a rectangle with absolute coordinates of all edges.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
void OnPaint() override
The window must be repainted.
WidgetID last_user_action
Last started user action.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
The user has dragged over the map when the tile highlight mode has been set.
EventState OnCTRLStateChange() override
The state of the control key has changed.
void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
The user is dragging over the map when the tile highlight mode has been set.
void OnTimeout() override
Called when this window's timeout has been reached.
static EventState TerraformToolbarEditorGlobalHotkeys(int hotkey)
Handler for global hotkeys of the ScenarioEditorLandscapeGenerationWindow.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
The user has dragged over the map when the tile highlight mode has been set.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
The user is dragging over the map when the tile highlight mode has been set.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInit() override
Notification that the nested widget tree gets initialized.
Point OnInitialPosition(int16_t sm_width, int16_t sm_height, int window_number) override
Compute the initial position of the window.
static EventState TerraformToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the TerraformToolbarWindow.
WidgetID last_user_action
Last started user action.
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
High level window description.
Definition window_gui.h:171
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:272
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1855
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:792
void RaiseWidgetWhenLowered(WidgetID widget_index)
Marks a widget as raised and dirty (redraw), when it is marked as lowered.
Definition window_gui.h:477
ResizeInfo resize
Resize information.
Definition window_gui.h:313
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1845
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:490
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition window.cpp:539
int left
x position of left edge of the window
Definition window_gui.h:308
int top
y position of top edge of the window
Definition window_gui.h:309
WidgetLookup widget_lookup
Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
Definition window_gui.h:321
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1879
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition window.cpp:604
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:579
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:310
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:301
Command definitions related to terraforming.
static void PlaceRockyArea(TileIndex end, TileIndex start, bool remove)
Scenario editor command that generates rocky areas.
bool GUIPlaceProcDragXY(ViewportDragDropSelectionProcess proc, TileIndex start_tile, TileIndex end_tile)
A central place to handle all X_AND_Y dragged GUI functions.
static WindowDesc _scen_edit_land_gen_desc(WindowPosition::Automatic, "toolbar_landscape_scen", 0, 0, WindowClass::ScenarioGenerateLandscape, WindowClass::None, WindowDefaultFlag::Construction, _nested_scen_edit_land_gen_widgets, &ScenarioEditorLandscapeGenerationWindow::hotkeys)
Window definition for the landscaping toolbar for he scenario editor.
static void ResetLandscapeConfirmationCallback(Window *, bool confirmed)
Callback function for the scenario editor 'reset landscape' confirmation window.
void PlaceProc_DemolishArea(TileIndex tile)
Start a drag for demolishing an area.
static WindowDesc _terraform_desc(WindowPosition::Manual, "toolbar_landscape", 0, 0, WindowClass::ScenarioGenerateLandscape, WindowClass::None, WindowDefaultFlag::Construction, _nested_terraform_widgets, &TerraformToolbarWindow::hotkeys)
Window definition for the landscaping toolbar.
Window * ShowEditorTerraformToolbar()
Show the toolbar for terraforming in the scenario editor.
static void PlaceRoughGround(TileIndex end, TileIndex start, bool remove)
Scenario editor command that generates rough land areas.
static void CommonRaiseLowerBigLand(TileIndex tile, bool mode)
Raise/Lower a bigger chunk of land at the same time in the editor.
Window * ShowTerraformToolbar(Window *link)
Show the toolbar for terraforming in the game.
static void GenerateDesertArea(TileIndex end, TileIndex start)
Scenario editor command that generates desert areas.
GUI stuff related to terraforming.
Types related to the terraform widgets.
@ WID_ETT_INCREASE_SIZE
Upwards arrow button to increase terraforming size.
@ WID_ETT_PLACE_ROCKS
Place rocks button.
@ WID_ETT_DOTS
Invisible widget for rendering the terraform size on.
@ WID_ETT_PLACE_ROUGH
Place rough land button.
@ WID_ETT_DECREASE_SIZE
Downwards arrow button to decrease terraforming size.
@ WID_ETT_SHOW_PLACE_DESERT
Should the place desert button be shown?
@ WID_ETT_PLACE_OBJECT
Place transmitter button.
@ WID_ETT_PLACE_DESERT
Place desert button (in tropical climate).
@ WID_ETT_NEW_SCENARIO
Button for generating a new scenario.
@ WID_ETT_RESET_LANDSCAPE
Button for removing all company-owned property.
@ WID_ETT_BUTTONS_START
Start of pushable buttons.
@ WID_ETT_LEVEL_LAND
Level land button.
@ WID_ETT_LOWER_LAND
Lower land button.
@ WID_ETT_START
Used for iterations.
@ WID_ETT_RAISE_LAND
Raise land button.
@ WID_ETT_BUTTONS_END
End of pushable buttons.
@ WID_ETT_DEMOLISH
Demolish aka dynamite button.
@ WID_TT_LEVEL_LAND
Level land button.
@ WID_TT_DEMOLISH
Demolish aka dynamite button.
@ WID_TT_SHOW_PLACE_OBJECT
Should the place object button be shown?
@ WID_TT_RAISE_LAND
Raise land button.
@ WID_TT_PLACE_OBJECT
Place object button.
@ WID_TT_PLANT_TREES
Plant trees button (note: opens separate window, no place-push-button).
@ WID_TT_PLACE_SIGN
Place sign button.
@ WID_TT_BUY_LAND
Buy land button.
@ WID_TT_BUTTONS_START
Start of pushable buttons.
@ WID_TT_LOWER_LAND
Lower land button.
Stuff related to the text buffer GUI.
static uint TileHeight(Tile tile)
Returns the height of a tile.
Definition tile_map.h:29
Slope GetTileSlope(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.h:279
void SetTropicZone(Tile tile, TropicZone type)
Set the tropic zone.
Definition tile_map.h:225
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
static constexpr uint MAX_TILE_HEIGHT
Maximum allowed tile height.
Definition tile_type.h:24
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
@ Desert
Tile is desert.
Definition tile_type.h:83
@ Normal
Normal tropiczone.
Definition tile_type.h:82
@ Water
Water tile.
Definition tile_type.h:55
@ Trees
Tile with one or more trees.
Definition tile_type.h:53
@ Clear
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition tile_type.h:49
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Functions related to tile highlights.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
Prepare state for highlighting tiles while dragging with the mouse.
@ HT_DIAGONAL
Also allow 'diagonal rectangles'. Only usable in combination with HT_RECT or HT_POINT.
@ HT_POINT
point (lower land, raise land, level land, ...)
@ HT_RECT
rectangle (stations, depots, ...)
Map accessors for tree tiles.
TreeGround GetTreeGround(Tile t)
Returns the groundtype for tree tiles.
Definition tree_map.h:102
@ SnowOrDesert
Snow or desert, depending on landscape.
Definition tree_map.h:55
@ Shore
Shore.
Definition tree_map.h:56
@ RoughSnow
A snow tile that is rough underneath.
Definition tree_map.h:57
@ Grass
Normal grass.
Definition tree_map.h:53
@ Rough
Rough land.
Definition tree_map.h:54
void SetTreeGroundDensity(Tile t, TreeGround g, uint d)
Set the density and ground type of a tile with trees.
Definition tree_map.h:145
uint GetTreeDensity(Tile t)
Returns the 'density' of a tile with trees.
Definition tree_map.h:128
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
Functions related to (drawing on) viewports.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects).
@ VPM_X_AND_Y
area of land in X and Y directions
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
@ DDSP_CREATE_DESERT
Fill area with desert.
@ DDSP_CREATE_ROUGH
Fill area with rough land.
@ DDSP_LOWER_AND_LEVEL_AREA
Lower / level area.
@ DDSP_DEMOLISH_AREA
Clear area.
@ DDSP_CREATE_ROCKS
Fill area with rocks.
@ DDSP_RAISE_AND_LEVEL_AREA
Raise / level area.
@ DDSP_LEVEL_AREA
Level area.
@ DDSP_BUILD_OBJECT
Build an object.
WaterTileType GetWaterTileType(Tile t)
Get the water tile type of a tile.
Definition water_map.h:82
void SetWaterTileType(Tile t, WaterTileType type)
Set the water tile type of a tile.
Definition water_map.h:93
@ ClearRocks
Rocks on water.
Definition water_map.h:36
@ Coast
Coast.
Definition water_map.h:33
@ CoastRocks
Rocks on coast.
Definition water_map.h:37
@ Clear
Plain water.
Definition water_map.h:32
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:41
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:70
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX).
Definition widget_type.h:57
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX).
Definition widget_type.h:55
@ WWT_CAPTION
Window caption (window title between closebox and stickybox).
Definition widget_type.h:52
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window).
Definition widget_type.h:60
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:37
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1242
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition window.cpp:1214
Point GetToolbarAlignedWindowPosition(int window_width)
Computer the position of the top-left corner of a window to be opened right under the toolbar.
Definition window.cpp:1732
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3395
Window functions not directly related to making/drawing windows.
Functions, definitions and such used only by the GUI.
@ Construction
This window is used for construction; close it whenever changing company.
Definition window_gui.h:154
Twindow * AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
Open a new window.
@ Automatic
Find a place automatically.
Definition window_gui.h:145
@ Manual
Manually align the window (so no automatic location finding).
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:21
EventState
State of handling an event.
@ Handled
The passed event is handled.
@ NotHandled
The passed event is not handled.
static constexpr WidgetID INVALID_WIDGET
An invalid widget index.
Definition window_type.h:24
Functions related to zooming.