OpenTTD Source 20261112-master-gbcbec5e63f
toolbar_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"
12#include "gui.h"
13#include "spritecache.h"
14#include "window_gui.h"
15#include "window_func.h"
16#include "viewport_func.h"
17#include "command_func.h"
18#include "dropdown_type.h"
19#include "dropdown_func.h"
20#include "house.h"
21#include "vehicle_gui.h"
22#include "rail_gui.h"
23#include "road.h"
24#include "road_gui.h"
25#include "sound_func.h"
26#include "terraform_gui.h"
27#include "object.h"
28#include "newgrf_object.h"
29#include "strings_func.h"
30#include "company_func.h"
31#include "company_gui.h"
32#include "vehicle_base.h"
33#include "cheat_func.h"
34#include "transparency_gui.h"
35#include "screenshot.h"
36#include "signs_func.h"
37#include "fios.h"
38#include "console_gui.h"
39#include "news_gui.h"
40#include "ai/ai_gui.hpp"
41#include "game/game_gui.hpp"
42#include "script/script_gui.h"
43#include "tilehighlight_func.h"
44#include "smallmap_gui.h"
45#include "graph_gui.h"
46#include "textbuf_gui.h"
49#include "newgrf_debug.h"
50#include "hotkeys.h"
51#include "highscore.h"
52#include "goal_base.h"
53#include "goal_gui.h"
54#include "story_base.h"
55#include "toolbar_gui.h"
56#include "framerate_type.h"
57#include "screenshot_gui.h"
58#include "misc_cmd.h"
59#include "league_gui.h"
60#include "league_base.h"
61#include "timer/timer.h"
62#include "timer/timer_window.h"
64#include "help_gui.h"
66#include "screensaver.h"
67
69
70#include "network/network.h"
71#include "network/network_gui.h"
73
74#include "table/strings.h"
75
77
78#include "safeguards.h"
79
80
83
87
89enum class ToolbarMode : uint8_t {
93};
94
96enum class CallBackFunction : uint8_t {
100};
101
103
107class DropDownListCompanyItem : public DropDownIcon<DropDownIcon<DropDownString<DropDownListItem>, true>> {
108public:
109 DropDownListCompanyItem(CompanyID company, bool shaded) : DropDownIcon<DropDownIcon<DropDownString<DropDownListItem>, true>>(SPR_COMPANY_ICON, GetCompanyPalette(company), NetworkCanJoinCompany(company) ? SPR_EMPTY : SPR_LOCK, PAL_NONE, GetString(STR_COMPANY_NAME_COMPANY_NUM, company, company), company.base(), false, shaded)
110 {
111 }
112};
113
120{
121 if (_settings_client.gui.toolbar_dropdown_autoselect) options.Set(DropDownOption::InstantClose).Reset(DropDownOption::Filterable);
122 return options;
123}
124
132static void PopupMainToolbarMenu(Window *w, WidgetID widget, DropDownList &&list, int def)
133{
134 ShowDropDownList(w, std::move(list), def, widget, 0, GetToolbarDropDownOptions());
135}
136
143static void PopupMainToolbarMenu(Window *w, WidgetID widget, const std::initializer_list<StringID> &strings)
144{
145 DropDownList list;
146 int i = 0;
147 for (StringID string : strings) {
148 if (string == STR_NULL) {
149 list.push_back(MakeDropDownListDividerItem());
150 } else {
151 list.push_back(MakeDropDownListStringItem(string, i));
152 i++;
153 }
154 }
155 PopupMainToolbarMenu(w, widget, std::move(list), 0);
156}
157
158/* Special values used in the dropdowns related to companies.
159 * They cannot interfere with valid IDs for companies. */
160static const int CTMN_CLIENT_LIST = MAX_COMPANIES;
161static const int CTMN_SPECTATE = COMPANY_SPECTATOR.base();
162static const int CTMN_SPECTATOR = CompanyID::Invalid().base();
163
170static void PopupMainCompanyToolbMenu(Window *w, WidgetID widget, CompanyMask grey = {})
171{
172 DropDownList list;
173
174 switch (widget) {
175 case WID_TN_COMPANIES:
176 if (!_networking) break;
177
178 /* Add the client list button for the companies menu */
179 list.push_back(MakeDropDownListStringItem(STR_NETWORK_COMPANY_LIST_CLIENT_LIST, CTMN_CLIENT_LIST));
180
182 list.push_back(MakeDropDownListStringItem(STR_NETWORK_COMPANY_LIST_SPECTATE, CTMN_SPECTATE));
183 }
184 break;
185 case WID_TN_STORY:
186 list.push_back(MakeDropDownListStringItem(STR_STORY_BOOK_SPECTATOR, CTMN_SPECTATOR));
187 break;
188
189 case WID_TN_GOAL:
190 list.push_back(MakeDropDownListStringItem(STR_GOALS_SPECTATOR, CTMN_SPECTATOR));
191 break;
192 }
193
194 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
195 if (!Company::IsValidID(c)) continue;
196 list.push_back(std::make_unique<DropDownListCompanyItem>(c, grey.Test(c)));
197 }
198
200}
201
202static ToolbarMode _toolbar_mode;
203
204static CallBackFunction SelectSignTool()
205{
209 } else {
210 SetObjectToPlace(SPR_CURSOR_SIGN, PAL_NONE, HT_RECT, WindowClass::MainToolbar, 0);
212 }
213}
214
215/* --- Pausing --- */
216
217static CallBackFunction ToolbarPauseClick(Window *)
218{
219 if (_networking && !_network_server) return CallBackFunction::None; // only server can pause the game
220
221 if (Command<Commands::Pause>::Post(PauseMode::Normal, _pause_mode.None())) {
223 }
225}
226
233{
234 if (_networking) return CallBackFunction::None; // no fast forward in network game
235
236 ChangeGameSpeed(_game_speed == 100);
237
238 SndClickBeep();
240}
241
268
276{
277 DropDownList list;
278 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_GAME_OPTIONS, OptionMenuEntries::GameOptions));
279 /* Changes to the per-AI settings don't get send from the server to the clients. Clients get
280 * the settings once they join but never update it. As such don't show the window at all
281 * to network clients. */
283 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_AI_SETTINGS, OptionMenuEntries::AISettings));
284 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_GAMESCRIPT_SETTINGS, OptionMenuEntries::GameScriptSettings));
285 }
286 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_NEWGRF_SETTINGS, OptionMenuEntries::NewGRFSettings));
287 if (_game_mode != GameMode::Editor && !_networking) {
288 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_SANDBOX_OPTIONS, OptionMenuEntries::SandboxOptions));
289 }
290 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_TRANSPARENCY_OPTIONS, OptionMenuEntries::Transparencies));
291 list.push_back(MakeDropDownListDividerItem());
292 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::ShowTownNames), STR_SETTINGS_MENU_TOWN_NAMES_DISPLAYED, OptionMenuEntries::ShowTownNames));
293 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::ShowStationNames), STR_SETTINGS_MENU_STATION_NAMES_DISPLAYED, OptionMenuEntries::ShowStationNames));
294 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(StationFacility::Train), STR_SETTINGS_MENU_STATION_NAMES_TRAIN, OptionMenuEntries::ShowTrainStationNames, false, false, 1));
295 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(StationFacility::TruckStop), STR_SETTINGS_MENU_STATION_NAMES_LORRY, OptionMenuEntries::ShowLorryStationNames, false, false, 1));
296 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(StationFacility::BusStop), STR_SETTINGS_MENU_STATION_NAMES_BUS, OptionMenuEntries::ShowBusStationNames, false, false, 1));
297 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(StationFacility::Dock), STR_SETTINGS_MENU_STATION_NAMES_SHIP, OptionMenuEntries::ShowDockNames, false, false, 1));
298 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(StationFacility::Airport), STR_SETTINGS_MENU_STATION_NAMES_PLANE, OptionMenuEntries::ShowAirportNames, false, false, 1));
299 list.push_back(MakeDropDownListCheckedItem(_facility_display_opt.Test(STATION_FACILITY_GHOST), STR_SETTINGS_MENU_STATION_NAMES_GHOST, OptionMenuEntries::ShowGhostStationNames, false, false, 1));
300 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::ShowWaypointNames), STR_SETTINGS_MENU_WAYPOINTS_DISPLAYED, OptionMenuEntries::ShowWaypointNames));
301 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::ShowSigns), STR_SETTINGS_MENU_SIGNS_DISPLAYED, OptionMenuEntries::ShowSigns));
302 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::ShowCompetitorSigns), STR_SETTINGS_MENU_SHOW_COMPETITOR_SIGNS, OptionMenuEntries::ShowCompetitorSigns));
303 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::FullAnimation), STR_SETTINGS_MENU_FULL_ANIMATION, OptionMenuEntries::FullAnimation));
304 list.push_back(MakeDropDownListCheckedItem(_display_opt.Test(DisplayOption::FullDetail), STR_SETTINGS_MENU_FULL_DETAIL, OptionMenuEntries::FullDetails));
307
308 ShowDropDownList(w, std::move(list), 0, WID_TN_SETTINGS, 140, GetToolbarDropDownOptions());
310}
311
319{
320 switch (OptionMenuEntries(index)) {
324 case OptionMenuEntries::NewGRFSettings: ShowNewGRFSettings(!_networking && _settings_client.gui.UserIsAllowedToChangeNewGRFs(), true, true, _grfconfig); return CallBackFunction::None;
327
340 InvalidateWindowClassesData(WindowClass::SignList, -1);
341 break;
346 }
349}
350
362
372
380{
381 PopupMainToolbarMenu(w, WID_TN_SAVE, {STR_FILE_MENU_SAVE_GAME, STR_FILE_MENU_LOAD_GAME, STR_FILE_MENU_QUIT_GAME,
382 STR_NULL, STR_FILE_MENU_EXIT});
384}
385
393{
394 PopupMainToolbarMenu(w, WID_TE_SAVE, {STR_SCENEDIT_FILE_MENU_SAVE_SCENARIO, STR_SCENEDIT_FILE_MENU_LOAD_SCENARIO,
395 STR_SCENEDIT_FILE_MENU_SAVE_HEIGHTMAP, STR_SCENEDIT_FILE_MENU_LOAD_HEIGHTMAP,
396 STR_SCENEDIT_FILE_MENU_QUIT_EDITOR, STR_NULL, STR_SCENEDIT_FILE_MENU_QUIT});
398}
399
427
428/* --- Map button menu --- */
429
431enum class MapMenuEntries : uint8_t {
436 ShowTownDirectory,
437 ShowIndustryDirectory,
438};
439
440static CallBackFunction ToolbarMapClick(Window *w)
441{
442 DropDownList list;
443 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_MAP_OF_WORLD, MapMenuEntries::ShowSmallMap));
444 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_EXTRA_VIEWPORT, MapMenuEntries::ShowExtraViewport));
445 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_LINGRAPH_LEGEND, MapMenuEntries::ShowLinkGraph));
446 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_SIGN_LIST, MapMenuEntries::ShowSignList));
447 PopupMainToolbarMenu(w, WID_TN_SMALL_MAP, std::move(list), 0);
449}
450
451static CallBackFunction ToolbarScenMapTownDir(Window *w)
452{
453 DropDownList list;
454 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_MAP_OF_WORLD, MapMenuEntries::ShowSmallMap));
455 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_EXTRA_VIEWPORT, MapMenuEntries::ShowExtraViewport));
456 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_SIGN_LIST, MapMenuEntries::ShowSignList));
457 list.push_back(MakeDropDownListStringItem(STR_TOWN_MENU_TOWN_DIRECTORY, MapMenuEntries::ShowTownDirectory));
458 list.push_back(MakeDropDownListStringItem(STR_INDUSTRY_MENU_INDUSTRY_DIRECTORY, MapMenuEntries::ShowIndustryDirectory));
459 PopupMainToolbarMenu(w, WID_TE_SMALL_MAP, std::move(list), 0);
461}
462
481
482/* --- Town button menu --- */
483
490
491static CallBackFunction ToolbarTownClick(Window *w)
492{
493 DropDownList list;
494 list.push_back(MakeDropDownListStringItem(STR_TOWN_MENU_TOWN_DIRECTORY, TownMenuEntries::ShowDirectory));
495 if (_settings_game.economy.found_town != TownFounding::Forbidden) list.push_back(MakeDropDownListStringItem(STR_TOWN_MENU_FOUND_TOWN, TownMenuEntries::ShowFoundTown));
496 if (_settings_game.economy.place_houses != PlaceHouses::Forbidden) list.push_back(MakeDropDownListStringItem(STR_SCENEDIT_TOWN_MENU_PACE_HOUSE, TownMenuEntries::ShowPlaceHouses));
497
498 PopupMainToolbarMenu(w, WID_TN_TOWNS, std::move(list), 0);
499
501}
502
510{
511 switch (TownMenuEntries(index)) {
513 case TownMenuEntries::ShowFoundTown: // Setting could be changed when the dropdown was open
514 if (_settings_game.economy.found_town != TownFounding::Forbidden) ShowFoundTownWindow();
515 break;
516 case TownMenuEntries::ShowPlaceHouses: // Setting could be changed when the dropdown was open
517 if (_settings_game.economy.place_houses != PlaceHouses::Forbidden) ShowBuildHousePicker(nullptr);
518 break;
519 }
521}
522
523/* --- Subidies button menu --- */
524
525static CallBackFunction ToolbarSubsidiesClick(Window *w)
526{
527 PopupMainToolbarMenu(w, WID_TN_SUBSIDIES, {STR_SUBSIDIES_MENU_SUBSIDIES});
529}
530
537{
538 ShowSubsidiesList();
540}
541
542/* --- Stations button menu --- */
543
544static CallBackFunction ToolbarStationsClick(Window *w)
545{
548}
549
557{
558 ShowCompanyStations((CompanyID)index);
560}
561
562/* --- Finances button menu --- */
563
564static CallBackFunction ToolbarFinancesClick(Window *w)
565{
568}
569
577{
578 ShowCompanyFinances((CompanyID)index);
580}
581
582/* --- Company's button menu --- */
583
584static CallBackFunction ToolbarCompaniesClick(Window *w)
585{
588}
589
597{
598 if (_networking) {
599 switch (index) {
600 case CTMN_CLIENT_LIST:
603
604 case CTMN_SPECTATE:
605 if (_network_server) {
608 } else {
610 }
612 }
613 }
614 ShowCompany((CompanyID)index);
616}
617
618/* --- Story button menu --- */
619
620static CallBackFunction ToolbarStoryClick(Window *w)
621{
624}
625
633{
634 ShowStoryBook(CompanyID(index));
636}
637
638/* --- Goal button menu --- */
639
640static CallBackFunction ToolbarGoalClick(Window *w)
641{
644}
645
653{
654 ShowGoalsList(CompanyID(index));
656}
657
658/* --- Graphs and League Table button menu --- */
659
664static const int GRMN_OPERATING_PROFIT_GRAPH = -1;
665static const int GRMN_INCOME_GRAPH = -2;
666static const int GRMN_DELIVERED_CARGO_GRAPH = -3;
667static const int GRMN_PERFORMANCE_HISTORY_GRAPH = -4;
668static const int GRMN_COMPANY_VALUE_GRAPH = -5;
669static const int GRMN_CARGO_PAYMENT_RATES = -6;
670static const int LTMN_PERFORMANCE_LEAGUE = -7;
671static const int LTMN_PERFORMANCE_RATING = -8;
672static const int LTMN_HIGHSCORE = -9;
673
674static void AddDropDownLeagueTableOptions(DropDownList &list)
675{
676 if (LeagueTable::GetNumItems() > 0) {
677 for (LeagueTable *lt : LeagueTable::Iterate()) {
678 list.push_back(MakeDropDownListStringItem(lt->title.GetDecodedString(), lt->index.base()));
679 }
680 } else {
681 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_COMPANY_LEAGUE_TABLE, LTMN_PERFORMANCE_LEAGUE));
682 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_DETAILED_PERFORMANCE_RATING, LTMN_PERFORMANCE_RATING));
683 if (!_networking) {
684 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_HIGHSCORE, LTMN_HIGHSCORE));
685 }
686 }
687}
688
689static CallBackFunction ToolbarGraphsClick(Window *w)
690{
691 DropDownList list;
692
693 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_OPERATING_PROFIT_GRAPH, GRMN_OPERATING_PROFIT_GRAPH));
694 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_INCOME_GRAPH, GRMN_INCOME_GRAPH));
695 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_DELIVERED_CARGO_GRAPH, GRMN_DELIVERED_CARGO_GRAPH));
696 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_PERFORMANCE_HISTORY_GRAPH, GRMN_PERFORMANCE_HISTORY_GRAPH));
697 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_COMPANY_VALUE_GRAPH, GRMN_COMPANY_VALUE_GRAPH));
698 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_CARGO_PAYMENT_RATES, GRMN_CARGO_PAYMENT_RATES));
699
700 if (_toolbar_mode != ToolbarMode::Normal) AddDropDownLeagueTableOptions(list);
701
704}
705
706static CallBackFunction ToolbarLeagueClick(Window *w)
707{
708 DropDownList list;
709
710 AddDropDownLeagueTableOptions(list);
711
712 int selected = list[0]->result;
713 ShowDropDownList(w, std::move(list), selected, WID_TN_LEAGUE, 140, GetToolbarDropDownOptions());
715}
716
724{
725 switch (index) {
726 case GRMN_OPERATING_PROFIT_GRAPH: ShowOperatingProfitGraph(); break;
727 case GRMN_INCOME_GRAPH: ShowIncomeGraph(); break;
728 case GRMN_DELIVERED_CARGO_GRAPH: ShowDeliveredCargoGraph(); break;
729 case GRMN_PERFORMANCE_HISTORY_GRAPH: ShowPerformanceHistoryGraph(); break;
730 case GRMN_COMPANY_VALUE_GRAPH: ShowCompanyValueGraph(); break;
731 case GRMN_CARGO_PAYMENT_RATES: ShowCargoPaymentRates(); break;
732 case LTMN_PERFORMANCE_LEAGUE: ShowPerformanceLeagueTable(); break;
733 case LTMN_PERFORMANCE_RATING: ShowPerformanceRatingDetail(); break;
734 case LTMN_HIGHSCORE: ShowHighscoreTable(); break;
735 default: {
736 if (LeagueTable::IsValidID(index)) {
737 ShowScriptLeagueTable((LeagueTableID)index);
738 }
739 }
740 }
742}
743
744
745
746/* --- Industries button menu --- */
747
748static CallBackFunction ToolbarIndustryClick(Window *w)
749{
750 /* Disable build-industry menu if we are a spectator */
752 PopupMainToolbarMenu(w, WID_TN_INDUSTRIES, {STR_INDUSTRY_MENU_INDUSTRY_DIRECTORY, STR_INDUSTRY_MENU_INDUSTRY_CHAIN});
753 } else {
754 PopupMainToolbarMenu(w, WID_TN_INDUSTRIES, {STR_INDUSTRY_MENU_INDUSTRY_DIRECTORY, STR_INDUSTRY_MENU_INDUSTRY_CHAIN, STR_INDUSTRY_MENU_FUND_NEW_INDUSTRY});
755 }
757}
758
766{
767 switch (index) {
768 case 0: ShowIndustryDirectory(); break;
769 case 1: ShowIndustryCargoesWindow(); break;
770 case 2: ShowBuildIndustryWindow(); break;
771 }
773}
774
775/* --- Trains button menu + 1 helper function for all vehicles. --- */
776
777static void ToolbarVehicleClick(Window *w, VehicleType veh)
778{
779 CompanyMask dis{};
780
781 for (const Company *c : Company::Iterate()) {
782 if (c->group_all[veh].num_vehicle == 0) dis.Set(c->index);
783 }
785}
786
787
788static CallBackFunction ToolbarTrainClick(Window *w)
789{
790 ToolbarVehicleClick(w, VehicleType::Train);
792}
793
801{
802 ShowVehicleListWindow((CompanyID)index, VehicleType::Train);
804}
805
806/* --- Road vehicle button menu --- */
807
808static CallBackFunction ToolbarRoadClick(Window *w)
809{
810 ToolbarVehicleClick(w, VehicleType::Road);
812}
813
821{
822 ShowVehicleListWindow((CompanyID)index, VehicleType::Road);
824}
825
826/* --- Ship button menu --- */
827
828static CallBackFunction ToolbarShipClick(Window *w)
829{
830 ToolbarVehicleClick(w, VehicleType::Ship);
832}
833
841{
842 ShowVehicleListWindow((CompanyID)index, VehicleType::Ship);
844}
845
846/* --- Aircraft button menu --- */
847
848static CallBackFunction ToolbarAirClick(Window *w)
849{
850 ToolbarVehicleClick(w, VehicleType::Aircraft);
852}
853
861{
862 ShowVehicleListWindow((CompanyID)index, VehicleType::Aircraft);
864}
865
866/* --- Zoom in button --- */
867
868static CallBackFunction ToolbarZoomInClick(Window *w)
869{
872 }
874}
875
876/* --- Zoom out button --- */
877
878static CallBackFunction ToolbarZoomOutClick(Window *w)
879{
882 }
884}
885
886/* --- Rail button menu --- */
887
888static std::string _railtype_filter;
889static std::string _roadtype_filter;
890static std::string _tramtype_filter;
891
892static CallBackFunction ToolbarBuildRailClick(Window *w)
893{
896}
897
910
911/* --- Road button menu --- */
912
913static CallBackFunction ToolbarBuildRoadClick(Window *w)
914{
917}
918
931
932/* --- Tram button menu --- */
933
934static CallBackFunction ToolbarBuildTramClick(Window *w)
935{
938}
939
952
953/* --- Water button menu --- */
954
955static CallBackFunction ToolbarBuildWaterClick(Window *w)
956{
957 DropDownList list;
958 list.push_back(MakeDropDownListIconItem(SPR_IMG_BUILD_CANAL, PAL_NONE, STR_WATERWAYS_MENU_WATERWAYS_CONSTRUCTION, 0));
959 ShowDropDownList(w, std::move(list), 0, WID_TN_WATER, 140, GetToolbarDropDownOptions());
961}
962
973
974/* --- Airport button menu --- */
975
976static CallBackFunction ToolbarBuildAirClick(Window *w)
977{
978 DropDownList list;
979 list.push_back(MakeDropDownListIconItem(SPR_IMG_AIRPORT, PAL_NONE, STR_AIRCRAFT_MENU_AIRPORT_CONSTRUCTION, 0));
980 ShowDropDownList(w, std::move(list), 0, WID_TN_AIR, 140, GetToolbarDropDownOptions());
982}
983
994
995/* --- Forest button menu --- */
996
997static CallBackFunction ToolbarForestClick(Window *w)
998{
999 DropDownList list;
1000 list.push_back(MakeDropDownListIconItem(SPR_IMG_LANDSCAPING, PAL_NONE, STR_LANDSCAPING_MENU_LANDSCAPING, 0));
1001 list.push_back(MakeDropDownListIconItem(SPR_IMG_PLANTTREES, PAL_NONE, STR_LANDSCAPING_MENU_PLANT_TREES, 1));
1002 list.push_back(MakeDropDownListIconItem(SPR_IMG_SIGN, PAL_NONE, STR_LANDSCAPING_MENU_PLACE_SIGN, 2));
1003 if (ObjectClass::GetUIClassCount() != 0) {
1004 list.push_back(MakeDropDownListIconItem(SPR_IMG_TRANSMITTER, PAL_NONE, STR_LANDSCAPING_MENU_PLACE_OBJECT, 3));
1005 }
1006 ShowDropDownList(w, std::move(list), 0, WID_TN_LANDSCAPE, 100, GetToolbarDropDownOptions());
1008}
1009
1017{
1018 switch (index) {
1019 case 0: ShowTerraformToolbar(); break;
1020 case 1: ShowBuildTreesToolbar(); break;
1021 case 2: return SelectSignTool();
1022 case 3: ShowBuildObjectPicker(); break;
1023 }
1025}
1026
1027/* --- Music button menu --- */
1028
1029static CallBackFunction ToolbarMusicClick(Window *w)
1030{
1031 PopupMainToolbarMenu(w, _game_mode == GameMode::Editor ? (WidgetID)WID_TE_MUSIC_SOUND : (WidgetID)WID_TN_MUSIC_SOUND, {STR_TOOLBAR_SOUND_MUSIC});
1033}
1034
1041{
1042 ShowMusicWindow();
1044}
1045
1046/* --- Newspaper button menu --- */
1047
1048static CallBackFunction ToolbarNewspaperClick(Window *w)
1049{
1050 PopupMainToolbarMenu(w, WID_TN_MESSAGES, {STR_NEWS_MENU_LAST_MESSAGE_NEWS_REPORT, STR_NEWS_MENU_MESSAGE_HISTORY_MENU, STR_NEWS_MENU_DELETE_ALL_MESSAGES});
1052}
1053
1061{
1062 switch (index) {
1063 case 0: ShowLastNewsMessage(); break;
1064 case 1: ShowMessageHistory(); break;
1065 case 2: DeleteAllMessages(); break;
1066 }
1068}
1069
1070/* --- Help button menu --- */
1071
1072static CallBackFunction PlaceLandBlockInfo()
1073{
1077 } else {
1078 SetObjectToPlace(SPR_CURSOR_QUERY, PAL_NONE, HT_RECT, WindowClass::MainToolbar, 0);
1080 }
1081}
1082
1083static CallBackFunction ToolbarHelpClick(Window *w)
1084{
1085 if (_settings_client.gui.newgrf_developer_tools) {
1086 PopupMainToolbarMenu(w, _game_mode == GameMode::Editor ? (WidgetID)WID_TE_HELP : (WidgetID)WID_TN_HELP, {STR_ABOUT_MENU_LAND_BLOCK_INFO,
1087 STR_ABOUT_MENU_HELP, STR_NULL, STR_ABOUT_MENU_ENTER_SCREENSAVER_MODE,
1088 STR_ABOUT_MENU_TOGGLE_CONSOLE, STR_ABOUT_MENU_AI_DEBUG,
1089 STR_ABOUT_MENU_SCREENSHOT, STR_ABOUT_MENU_SHOW_FRAMERATE, STR_ABOUT_MENU_ABOUT_OPENTTD,
1090 STR_ABOUT_MENU_SPRITE_ALIGNER, STR_ABOUT_MENU_TOGGLE_BOUNDING_BOXES, STR_ABOUT_MENU_TOGGLE_DIRTY_BLOCKS,
1091 STR_ABOUT_MENU_TOGGLE_WIDGET_OUTLINES});
1092 } else {
1093 PopupMainToolbarMenu(w, _game_mode == GameMode::Editor ? (WidgetID)WID_TE_HELP : (WidgetID)WID_TN_HELP, {STR_ABOUT_MENU_LAND_BLOCK_INFO,
1094 STR_ABOUT_MENU_HELP, STR_NULL, STR_ABOUT_MENU_ENTER_SCREENSAVER_MODE, STR_ABOUT_MENU_TOGGLE_CONSOLE, STR_ABOUT_MENU_AI_DEBUG,
1095 STR_ABOUT_MENU_SCREENSHOT, STR_ABOUT_MENU_SHOW_FRAMERATE, STR_ABOUT_MENU_ABOUT_OPENTTD});
1096 }
1098}
1099
1108{
1109 extern bool _draw_bounding_boxes;
1110 /* Always allow to toggle them off */
1111 if (_settings_client.gui.newgrf_developer_tools || _draw_bounding_boxes) {
1112 _draw_bounding_boxes = !_draw_bounding_boxes;
1114 }
1115}
1116
1125{
1126 extern bool _draw_dirty_blocks;
1127 /* Always allow to toggle them off */
1128 if (_settings_client.gui.newgrf_developer_tools || _draw_dirty_blocks) {
1129 _draw_dirty_blocks = !_draw_dirty_blocks;
1131 }
1132}
1133
1139{
1140 extern bool _draw_widget_outlines;
1141 /* Always allow to toggle them off */
1142 if (_settings_client.gui.newgrf_developer_tools || _draw_widget_outlines) {
1143 _draw_widget_outlines = !_draw_widget_outlines;
1145 }
1146}
1147
1153{
1154 _settings_game.game_creation.starting_year = Clamp(year, CalendarTime::MIN_YEAR, CalendarTime::MAX_YEAR);
1155 TimerGameCalendar::Date new_calendar_date = TimerGameCalendar::ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1);
1156 TimerGameEconomy::Date new_economy_date{new_calendar_date.base()};
1157
1158 /* We must set both Calendar and Economy dates to keep them in sync. Calendar first. */
1159 TimerGameCalendar::SetDate(new_calendar_date, 0);
1160
1161 /* If you open a savegame as a scenario, there may already be link graphs and/or vehicles. These use economy date. */
1162 LinkGraphSchedule::instance.ShiftDates(new_economy_date - TimerGameEconomy::date);
1163 for (auto v : Vehicle::Iterate()) v->ShiftDates(new_economy_date - TimerGameEconomy::date);
1164
1165 /* Only change the date after changing cached values above. */
1166 TimerGameEconomy::SetDate(new_economy_date, 0);
1167}
1168
1175{
1176 switch (index) {
1177 case 0: return PlaceLandBlockInfo();
1178 case 1: ShowHelpWindow(); break;
1179 case 2: ToggleScreensaverMode(); break;
1180 case 3: IConsoleSwitch(); break;
1181 case 4: ShowScriptDebugWindow(CompanyID::Invalid(), IsCtrlPressed()); break;
1182 case 5: ShowScreenshotWindow(); break;
1183 case 6: ShowFramerateWindow(); break;
1184 case 7: ShowAboutWindow(); break;
1185 case 8: ShowSpriteAlignerWindow(); break;
1186 case 9: ToggleBoundingBoxes(); break;
1187 case 10: ToggleDirtyBlocks(); break;
1188 case 11: ToggleWidgetOutlines(); break;
1189 }
1191}
1192
1193/* --- Switch toolbar button --- */
1194
1195static CallBackFunction ToolbarSwitchClick(Window *w)
1196{
1197 if (_toolbar_mode != ToolbarMode::Lower) {
1198 _toolbar_mode = ToolbarMode::Lower;
1199 } else {
1200 _toolbar_mode = ToolbarMode::Upper;
1201 }
1202
1203 w->ReInit();
1205 SndClickBeep();
1207}
1208
1209/* --- Scenario editor specific handlers. */
1210
1216{
1217 ShowQueryString(GetString(STR_JUST_INT, _settings_game.game_creation.starting_year), STR_MAPGEN_START_DATE_QUERY_CAPT, 8, w, CS_NUMERAL, QueryStringFlag::EnableDefault);
1219}
1220
1221static CallBackFunction ToolbarScenDateBackward(Window *w)
1222{
1223 /* don't allow too fast scrolling */
1224 if (!w->flags.Test(WindowFlag::Timeout) || w->timeout_timer <= 1) {
1226 w->SetDirty();
1227
1228 SetStartingYear(_settings_game.game_creation.starting_year - 1);
1229 }
1232}
1233
1234static CallBackFunction ToolbarScenDateForward(Window *w)
1235{
1236 /* don't allow too fast scrolling */
1237 if (!w->flags.Test(WindowFlag::Timeout) || w->timeout_timer <= 1) {
1239 w->SetDirty();
1240
1241 SetStartingYear(_settings_game.game_creation.starting_year + 1);
1242 }
1245}
1246
1247static CallBackFunction ToolbarScenGenLand(Window *w)
1248{
1250
1253}
1254
1255static CallBackFunction ToolbarScenGenTownClick(Window *w)
1256{
1257 PopupMainToolbarMenu(w, WID_TE_TOWN_GENERATE, {STR_SCENEDIT_TOWN_MENU_BUILD_TOWN, STR_SCENEDIT_TOWN_MENU_PACE_HOUSE});
1259}
1260
1261static CallBackFunction ToolbarScenGenTown(int index)
1262{
1263 switch (index) {
1264 case 0: ShowFoundTownWindow(); break;
1265 case 1: ShowBuildHousePicker(nullptr); break;
1266 }
1268}
1269
1270static CallBackFunction ToolbarScenGenIndustry(Window *w)
1271{
1273 ShowBuildIndustryWindow();
1275}
1276
1277static CallBackFunction ToolbarScenBuildRoadClick(Window *w)
1278{
1281}
1282
1295
1296static CallBackFunction ToolbarScenBuildTramClick(Window *w)
1297{
1300}
1301
1314
1315static CallBackFunction ToolbarScenBuildDocks(Window *w)
1316{
1320}
1321
1322static CallBackFunction ToolbarScenPlantTrees(Window *w)
1323{
1325 ShowBuildTreesToolbar();
1327}
1328
1329static CallBackFunction ToolbarScenPlaceSign(Window *w)
1330{
1332 return SelectSignTool();
1333}
1334
1335static CallBackFunction ToolbarBtn_NULL(Window *)
1336{
1338}
1339
1340typedef CallBackFunction MenuClickedProc(int index);
1341
1342static MenuClickedProc * const _menu_clicked_procs[] = {
1343 nullptr, // 0
1344 nullptr, // 1
1345 MenuClickSettings, // 2
1346 MenuClickSaveLoad, // 3
1347 MenuClickMap, // 4
1348 MenuClickTown, // 5
1349 MenuClickSubsidies, // 6
1350 MenuClickStations, // 7
1351 MenuClickFinances, // 8
1352 MenuClickCompany, // 9
1353 MenuClickStory, // 10
1354 MenuClickGoal, // 11
1357 MenuClickIndustry, // 14
1358 MenuClickShowTrains, // 15
1359 MenuClickShowRoad, // 16
1360 MenuClickShowShips, // 17
1361 MenuClickShowAir, // 18
1362 MenuClickMap, // 19
1363 nullptr, // 20
1364 MenuClickBuildRail, // 21
1365 MenuClickBuildRoad, // 22
1366 MenuClickBuildTram, // 23
1367 MenuClickBuildWater, // 24
1368 MenuClickBuildAir, // 25
1369 MenuClickForest, // 26
1371 MenuClickNewspaper, // 28
1372 MenuClickHelp, // 29
1373};
1374
1376class NWidgetToolbarContainer : public NWidgetContainer {
1377protected:
1378 uint spacers = 0;
1379
1380public:
1381 NWidgetToolbarContainer() : NWidgetContainer(NWID_HORIZONTAL)
1382 {
1383 }
1384
1391 {
1392 return type == WWT_IMGBTN || type == WWT_IMGBTN_2 || type == WWT_PUSHIMGBTN;
1393 }
1394
1395 void SetupSmallestSize(Window *w) override
1396 {
1397 this->smallest_x = 0; // Biggest child
1398 this->smallest_y = 0; // Biggest child
1399 this->fill_x = 1;
1400 this->fill_y = 0;
1401 this->resize_x = 1; // We only resize in this direction
1402 this->resize_y = 0; // We never resize in this direction
1403 this->spacers = 0;
1404
1405 uint nbuttons = 0;
1406 /* First initialise some variables... */
1407 for (const auto &child_wid : this->children) {
1408 child_wid->SetupSmallestSize(w);
1409 this->smallest_y = std::max(this->smallest_y, child_wid->smallest_y + child_wid->padding.Vertical());
1410 if (this->IsButton(child_wid->type)) {
1411 nbuttons++;
1412 this->smallest_x = std::max(this->smallest_x, child_wid->smallest_x + child_wid->padding.Horizontal());
1413 } else if (child_wid->type == NWID_SPACER) {
1414 this->spacers++;
1415 }
1416 }
1417
1418 /* ... then in a second pass make sure the 'current' heights are set. Won't change ever. */
1419 for (const auto &child_wid : this->children) {
1420 child_wid->current_y = this->smallest_y;
1421 if (!this->IsButton(child_wid->type)) {
1422 child_wid->current_x = child_wid->smallest_x;
1423 }
1424 }
1425
1426 /* Exclude the switcher button which is not displayed when the toolbar fits the screen. When the switch is
1427 * displayed there will be no spacers anyway. */
1428 --nbuttons;
1429
1430 /* Allow space for all buttons, and include spacers at quarter the width of buttons. */
1431 _toolbar_width = nbuttons * this->smallest_x + this->spacers * this->smallest_x / 4;
1432 }
1433
1434 void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
1435 {
1436 assert(given_width >= this->smallest_x && given_height >= this->smallest_y);
1437
1438 this->pos_x = x;
1439 this->pos_y = y;
1440 this->current_x = given_width;
1441 this->current_y = given_height;
1442
1443 /* Figure out what are the visible buttons */
1444 uint arrangeable_count, button_count, spacer_count;
1445 const WidgetID *arrangement = GetButtonArrangement(given_width, arrangeable_count, button_count, spacer_count);
1446
1447 /* Create us ourselves a quick lookup table from WidgetID to slot. */
1448 std::map<WidgetID, uint> lookup;
1449 for (auto it = std::begin(this->children); it != std::end(this->children); ++it) {
1450 NWidgetBase *nwid = it->get();
1451 nwid->current_x = 0; /* Hide widget, it will be revealed in the next step. */
1452 if (nwid->type == NWID_SPACER) continue;
1453 NWidgetCore *nwc = dynamic_cast<NWidgetCore *>(nwid);
1454 assert(nwc != nullptr);
1455 lookup[nwc->GetIndex()] = std::distance(this->children.begin(), it);
1456 }
1457
1458 /* Now assign the widgets to their rightful place */
1459 uint position = 0; // Place to put next child relative to origin of the container.
1460 uint spacer_space = std::max(0, (int)given_width - (int)(button_count * this->smallest_x)); // Remaining spacing for 'spacer' widgets
1461 uint button_space = given_width - spacer_space; // Remaining spacing for the buttons
1462 uint spacer_i = 0;
1463 uint button_i = 0;
1464
1465 /* Index into the arrangement indices. */
1466 const WidgetID *slotp = rtl ? &arrangement[arrangeable_count - 1] : arrangement;
1467 for (uint i = 0; i < arrangeable_count; i++) {
1468 uint slot = lookup[*slotp];
1469 auto &child_wid = this->children[slot];
1470 /* If we have space to give to the spacers, do that. */
1471 if (spacer_space > 0 && slot > 0 && slot < this->children.size() - 1) {
1472 const auto &possible_spacer = this->children[slot + (rtl ? 1 : -1)];
1473 if (possible_spacer != nullptr && possible_spacer->type == NWID_SPACER) {
1474 uint add = spacer_space / (spacer_count - spacer_i);
1475 position += add;
1476 spacer_space -= add;
1477 spacer_i++;
1478 }
1479 }
1480
1481 /* Buttons can be scaled, the others not. */
1482 if (this->IsButton(child_wid->type)) {
1483 child_wid->current_x = button_space / (button_count - button_i);
1484 button_space -= child_wid->current_x;
1485 button_i++;
1486 } else {
1487 child_wid->current_x = child_wid->smallest_x;
1488 }
1489 child_wid->AssignSizePosition(sizing, x + position, y, child_wid->current_x, this->current_y, rtl);
1490 position += child_wid->current_x;
1491
1492 if (rtl) {
1493 slotp--;
1494 } else {
1495 slotp++;
1496 }
1497 }
1498 }
1499
1500 void Draw(const Window *w) override
1501 {
1502 /* Draw brown-red toolbar bg. */
1503 const Rect r = this->GetCurrentRect();
1506
1507 this->NWidgetContainer::Draw(w);
1508 }
1509
1518 virtual const WidgetID *GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const = 0;
1519};
1520
1522class NWidgetMainToolbarContainer : public NWidgetToolbarContainer {
1523 const WidgetID *GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const override
1524 {
1525 static const uint SMALLEST_ARRANGEMENT = 14;
1526 static const uint BIGGEST_ARRANGEMENT = 20;
1527
1528 /* The number of buttons of each row of the toolbar should match the number of items which we want to be visible.
1529 * The total number of buttons should be equal to arrangeable_count * 2.
1530 * No bad things happen, but we could see strange behaviours if we have buttons < (arrangeable_count * 2) like a
1531 * pause button appearing on the right of the lower toolbar and weird resizing of the widgets even if there is
1532 * enough space.
1533 */
1534 static const WidgetID arrange14[] = {
1546 WID_TN_AIR,
1549 /* lower toolbar */
1564 };
1565 static const WidgetID arrange15[] = {
1576 WID_TN_AIR,
1581 /* lower toolbar */
1597 };
1598 static const WidgetID arrange16[] = {
1610 WID_TN_AIR,
1615 /* lower toolbar */
1632 };
1633 static const WidgetID arrange17[] = {
1646 WID_TN_AIR,
1651 /* lower toolbar */
1669 };
1670 static const WidgetID arrange18[] = {
1684 WID_TN_AIR,
1689 /* lower toolbar */
1708 };
1709 static const WidgetID arrange19[] = {
1723 WID_TN_AIR,
1729 /* lower toolbar */
1743 WID_TN_AIR,
1749 };
1750 static const WidgetID arrange20[] = {
1764 WID_TN_AIR,
1771 /* lower toolbar */
1785 WID_TN_AIR,
1792 };
1793 static const WidgetID arrange_all[] = {
1819 WID_TN_AIR,
1824 };
1825
1826 /* If at least BIGGEST_ARRANGEMENT fit, just spread all the buttons nicely */
1827 uint full_buttons = std::max(CeilDiv(width, this->smallest_x), SMALLEST_ARRANGEMENT);
1828 if (full_buttons > BIGGEST_ARRANGEMENT) {
1829 _toolbar_mode = ToolbarMode::Normal;
1830 button_count = arrangeable_count = lengthof(arrange_all);
1831 spacer_count = this->spacers;
1832 return arrange_all;
1833 }
1834
1835 /* Introduce the split toolbar */
1836 static const WidgetID * const arrangements[] = { arrange14, arrange15, arrange16, arrange17, arrange18, arrange19, arrange20 };
1837
1838 button_count = arrangeable_count = full_buttons;
1839 spacer_count = this->spacers;
1840 return arrangements[full_buttons - SMALLEST_ARRANGEMENT] + ((_toolbar_mode == ToolbarMode::Lower) ? full_buttons : 0);
1841 }
1842};
1843
1845class NWidgetScenarioToolbarContainer : public NWidgetToolbarContainer {
1846 std::array<uint, 2> panel_widths{};
1847
1848 void SetupSmallestSize(Window *w) override
1849 {
1851
1852 /* Find the size of panel_widths */
1853 auto it = this->panel_widths.begin();
1854 for (const auto &child_wid : this->children) {
1855 if (child_wid->type == NWID_SPACER || this->IsButton(child_wid->type)) continue;
1856
1857 assert(it != this->panel_widths.end());
1858 *it = child_wid->current_x;
1859 _toolbar_width += child_wid->current_x;
1860 ++it;
1861 }
1862 }
1863
1864 const WidgetID *GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const override
1865 {
1866 static const WidgetID arrange_all[] = {
1886 };
1887 static const WidgetID arrange_nopanel[] = {
1906 };
1907 static const WidgetID arrange_switch[] = {
1919 /* lower toolbar */
1931 };
1932
1933 /* If we can place all buttons *and* the panels, show them. */
1934 size_t min_full_width = (lengthof(arrange_all) - std::size(this->panel_widths)) * this->smallest_x + this->panel_widths[0] + this->panel_widths[1];
1935 if (width >= min_full_width) {
1936 width -= this->panel_widths[0] + this->panel_widths[1];
1937 arrangeable_count = lengthof(arrange_all);
1938 button_count = arrangeable_count - 2;
1939 spacer_count = this->spacers;
1940 return arrange_all;
1941 }
1942
1943 /* Otherwise don't show the date panel and if we can't fit half the buttons and the panels anymore, split the toolbar in two */
1944 size_t min_small_width = (lengthof(arrange_switch) - std::size(this->panel_widths)) * this->smallest_x / 2 + this->panel_widths[1];
1945 if (width > min_small_width) {
1946 width -= this->panel_widths[1];
1947 arrangeable_count = lengthof(arrange_nopanel);
1948 button_count = arrangeable_count - 1;
1949 spacer_count = this->spacers - 1;
1950 return arrange_nopanel;
1951 }
1952
1953 /* Split toolbar */
1954 width -= this->panel_widths[1];
1955 arrangeable_count = lengthof(arrange_switch) / 2;
1956 button_count = arrangeable_count - 1;
1957 spacer_count = 0;
1958 return arrange_switch + ((_toolbar_mode == ToolbarMode::Lower) ? arrangeable_count : 0);
1959 }
1960};
1961
1962/* --- Toolbar handling for the 'normal' case */
1963
1970
1971static ToolbarButtonProc * const _toolbar_button_procs[] = {
1972 ToolbarPauseClick,
1976 ToolbarMapClick,
1977 ToolbarTownClick,
1978 ToolbarSubsidiesClick,
1979 ToolbarStationsClick,
1980 ToolbarFinancesClick,
1981 ToolbarCompaniesClick,
1982 ToolbarStoryClick,
1983 ToolbarGoalClick,
1984 ToolbarGraphsClick,
1985 ToolbarLeagueClick,
1986 ToolbarIndustryClick,
1987 ToolbarTrainClick,
1988 ToolbarRoadClick,
1989 ToolbarShipClick,
1990 ToolbarAirClick,
1991 ToolbarZoomInClick,
1992 ToolbarZoomOutClick,
1993 ToolbarBuildRailClick,
1994 ToolbarBuildRoadClick,
1995 ToolbarBuildTramClick,
1996 ToolbarBuildWaterClick,
1997 ToolbarBuildAirClick,
1998 ToolbarForestClick,
1999 ToolbarMusicClick,
2000 ToolbarNewspaperClick,
2001 ToolbarHelpClick,
2002 ToolbarSwitchClick,
2003};
2004
2006struct MainToolbarWindow : Window {
2007 MainToolbarWindow(WindowDesc &desc) : Window(desc)
2008 {
2009 this->InitNested(0);
2010
2012 this->flags.Reset(WindowFlag::WhiteBorder);
2013 this->SetWidgetDisabledState(WID_TN_PAUSE, _networking && !_network_server); // if not server, disable pause button
2014 this->SetWidgetDisabledState(WID_TN_FAST_FORWARD, _networking); // if networking, disable fast-forward button
2015 PositionMainToolbar(this);
2017 }
2018
2019 void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
2020 {
2021 Window::FindWindowPlacementAndResize(_toolbar_width, def_height, allow_resize);
2022 }
2023
2024 void OnPaint() override
2025 {
2026 /* If spectator, disable all construction buttons
2027 * ie : Build road, rail, ships, airports and landscaping
2028 * Since enabled state is the default, just disable when needed */
2030 /* disable company list drop downs, if there are no companies */
2032
2035
2036 this->DrawWidgets();
2037 }
2038
2039 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2040 {
2041 if (_game_mode != GameMode::Menu && !this->IsWidgetDisabled(widget)) _toolbar_button_procs[widget](this);
2042 }
2043
2044 void OnDropdownSelect(WidgetID widget, int index, int) override
2045 {
2046 CallBackFunction cbf = _menu_clicked_procs[widget](index);
2048 }
2049
2050 EventState OnHotkey(int hotkey) override
2051 {
2053 switch (hotkey) {
2054 case MTHK_PAUSE: ToolbarPauseClick(this); break;
2055 case MTHK_FASTFORWARD: ToolbarFastForwardClick(this); break;
2056 case MTHK_SETTINGS: ShowGameOptions(); break;
2057 case MTHK_SAVEGAME: MenuClickSaveLoad(); break;
2059 case MTHK_SMALLMAP: ShowSmallMap(); break;
2060 case MTHK_TOWNDIRECTORY: ShowTownDirectory(); break;
2061 case MTHK_SUBSIDIES: ShowSubsidiesList(); break;
2062 case MTHK_STATIONS: ShowCompanyStations(_local_company); break;
2063 case MTHK_FINANCES: ShowCompanyFinances(_local_company); break;
2064 case MTHK_COMPANIES: ShowCompany(_local_company); break;
2065 case MTHK_STORY: ShowStoryBook(_local_company); break;
2066 case MTHK_GOAL: ShowGoalsList(_local_company); break;
2067 case MTHK_GRAPHS: ShowOperatingProfitGraph(); break;
2068 case MTHK_LEAGUE: ShowFirstLeagueTable(); break;
2069 case MTHK_INDUSTRIES: ShowBuildIndustryWindow(); break;
2070 case MTHK_TRAIN_LIST: ShowVehicleListWindow(_local_company, VehicleType::Train); break;
2071 case MTHK_ROADVEH_LIST: ShowVehicleListWindow(_local_company, VehicleType::Road); break;
2072 case MTHK_SHIP_LIST: ShowVehicleListWindow(_local_company, VehicleType::Ship); break;
2073 case MTHK_AIRCRAFT_LIST: ShowVehicleListWindow(_local_company, VehicleType::Aircraft); break;
2074 case MTHK_ZOOM_IN: ToolbarZoomInClick(this); break;
2075 case MTHK_ZOOM_OUT: ToolbarZoomOutClick(this); break;
2076 case MTHK_BUILD_RAIL: ShowBuildRailToolbar(_last_built_railtype); break;
2077 case MTHK_BUILD_ROAD: ShowBuildRoadToolbar(_last_built_roadtype); break;
2078 case MTHK_BUILD_TRAM: ShowBuildRoadToolbar(_last_built_tramtype); break;
2079 case MTHK_BUILD_DOCKS: ShowBuildDocksToolbar(); break;
2080 case MTHK_BUILD_AIRPORT: ShowBuildAirToolbar(); break;
2081 case MTHK_BUILD_TREES: ShowBuildTreesToolbar(); break;
2082 case MTHK_MUSIC: ShowMusicWindow(); break;
2083 case MTHK_SCRIPT_DEBUG: ShowScriptDebugWindow(); break;
2084 case MTHK_SMALL_SCREENSHOT: MakeScreenshotWithConfirm(SC_VIEWPORT); break;
2085 case MTHK_ZOOMEDIN_SCREENSHOT: MakeScreenshotWithConfirm(SC_ZOOMEDIN); break;
2086 case MTHK_DEFAULTZOOM_SCREENSHOT: MakeScreenshotWithConfirm(SC_DEFAULTZOOM); break;
2087 case MTHK_GIANT_SCREENSHOT: MakeScreenshotWithConfirm(SC_WORLD); break;
2088 case MTHK_CHEATS: if (!_networking) ShowCheatWindow(); break;
2089 case MTHK_TERRAFORM: ShowTerraformToolbar(); break;
2090 case MTHK_EXTRA_VIEWPORT: ShowExtraViewportWindowForTileUnderCursor(); break;
2091 case MTHK_CLIENT_LIST: if (_networking) ShowClientList(); break;
2092 case MTHK_SIGN_LIST: ShowSignList(); break;
2093 case MTHK_LANDINFO: cbf = PlaceLandBlockInfo(); break;
2094 default: return EventState::NotHandled;
2095 }
2097 return EventState::Handled;
2098 }
2099
2100 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
2101 {
2102 switch (_last_started_action) {
2104 PlaceProc_Sign(tile);
2105 break;
2106
2108 ShowLandInfo(tile);
2109 break;
2110
2111 default: NOT_REACHED();
2112 }
2113 }
2114
2119
2121 const IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(30), [this](auto) {
2122 if (this->IsWidgetLowered(WID_TN_PAUSE) != _pause_mode.Any()) {
2125 }
2126
2127 if (this->IsWidgetLowered(WID_TN_FAST_FORWARD) != (_game_speed != 100)) {
2130 }
2131 }};
2132
2138 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2139 {
2140 if (!gui_scope) return;
2142 }
2143
2144 static inline HotkeyList hotkeys{"maintoolbar", {
2145 Hotkey({WKC_F1, WKC_PAUSE}, "pause", MTHK_PAUSE),
2146 Hotkey(0, "fastforward", MTHK_FASTFORWARD),
2147 Hotkey(WKC_F2, "settings", MTHK_SETTINGS),
2148 Hotkey(WKC_F3, "saveload", MTHK_SAVEGAME),
2149 Hotkey(0, "load_game", MTHK_LOADGAME),
2150 Hotkey({WKC_F4, 'M'}, "smallmap", MTHK_SMALLMAP),
2151 Hotkey(WKC_F5, "town_list", MTHK_TOWNDIRECTORY),
2152 Hotkey(WKC_F6, "subsidies", MTHK_SUBSIDIES),
2153 Hotkey(WKC_F7, "station_list", MTHK_STATIONS),
2154 Hotkey(WKC_F8, "finances", MTHK_FINANCES),
2155 Hotkey(WKC_F9, "companies", MTHK_COMPANIES),
2156 Hotkey(0, "story_book", MTHK_STORY),
2157 Hotkey(0, "goal_list", MTHK_GOAL),
2158 Hotkey(WKC_F10, "graphs", MTHK_GRAPHS),
2159 Hotkey(WKC_F11, "league", MTHK_LEAGUE),
2160 Hotkey(WKC_F12, "industry_list", MTHK_INDUSTRIES),
2161 Hotkey(WKC_SHIFT | WKC_F1, "train_list", MTHK_TRAIN_LIST),
2162 Hotkey(WKC_SHIFT | WKC_F2, "roadveh_list", MTHK_ROADVEH_LIST),
2163 Hotkey(WKC_SHIFT | WKC_F3, "ship_list", MTHK_SHIP_LIST),
2164 Hotkey(WKC_SHIFT | WKC_F4, "aircraft_list", MTHK_AIRCRAFT_LIST),
2165 Hotkey({WKC_NUM_PLUS, WKC_EQUALS, WKC_SHIFT | WKC_EQUALS, WKC_SHIFT | WKC_F5}, "zoomin", MTHK_ZOOM_IN),
2166 Hotkey({WKC_NUM_MINUS, WKC_MINUS, WKC_SHIFT | WKC_MINUS, WKC_SHIFT | WKC_F6}, "zoomout", MTHK_ZOOM_OUT),
2167 Hotkey(WKC_SHIFT | WKC_F7, "build_rail", MTHK_BUILD_RAIL),
2168 Hotkey(WKC_SHIFT | WKC_F8, "build_road", MTHK_BUILD_ROAD),
2169 Hotkey(0, "build_tram", MTHK_BUILD_TRAM),
2170 Hotkey(WKC_SHIFT | WKC_F9, "build_docks", MTHK_BUILD_DOCKS),
2171 Hotkey(WKC_SHIFT | WKC_F10, "build_airport", MTHK_BUILD_AIRPORT),
2172 Hotkey(WKC_SHIFT | WKC_F11, "build_trees", MTHK_BUILD_TREES),
2173 Hotkey(WKC_SHIFT | WKC_F12, "music", MTHK_MUSIC),
2174 Hotkey(0, "ai_debug", MTHK_SCRIPT_DEBUG),
2175 Hotkey(WKC_CTRL | 'S', "small_screenshot", MTHK_SMALL_SCREENSHOT),
2176 Hotkey(WKC_CTRL | 'P', "zoomedin_screenshot", MTHK_ZOOMEDIN_SCREENSHOT),
2177 Hotkey(WKC_CTRL | 'D', "defaultzoom_screenshot", MTHK_DEFAULTZOOM_SCREENSHOT),
2178 Hotkey(0, "giant_screenshot", MTHK_GIANT_SCREENSHOT),
2179 Hotkey(WKC_CTRL | WKC_ALT | 'C', "cheats", MTHK_CHEATS),
2180 Hotkey('L', "terraform", MTHK_TERRAFORM),
2181 Hotkey('V', "extra_viewport", MTHK_EXTRA_VIEWPORT),
2182 Hotkey(0, "client_list", MTHK_CLIENT_LIST),
2183 Hotkey(0, "sign_list", MTHK_SIGN_LIST),
2184 Hotkey(0, "land_info", MTHK_LANDINFO),
2185 }};
2186};
2187
2189static constexpr std::tuple<WidgetID, WidgetType, SpriteID> _toolbar_button_sprites[] = {
2220 {WID_TN_SWITCH_BAR, WWT_IMGBTN, SPR_IMG_SWITCH_TOOLBAR},
2221};
2222
2228{
2229 Dimension d{};
2230 for (const auto &[widget, tp, sprite] : _toolbar_button_sprites) {
2231 if (!SpriteExists(sprite)) continue;
2232 d = maxdim(d, GetSquareScaledSpriteSize(sprite));
2233 }
2234 return d;
2235}
2236
2241static std::unique_ptr<NWidgetBase> MakeMainToolbar()
2242{
2243 auto hor = std::make_unique<NWidgetMainToolbarContainer>();
2244 for (const auto &[widget, tp, sprite] : _toolbar_button_sprites) {
2245 switch (widget) {
2246 case WID_TN_SMALL_MAP:
2247 case WID_TN_FINANCES:
2249 case WID_TN_ZOOM_IN:
2251 case WID_TN_MUSIC_SOUND:
2252 hor->Add(std::make_unique<NWidgetSpacer>(0, 0));
2253 break;
2254 }
2255 auto leaf = std::make_unique<NWidgetLeaf>(tp, Colours::Grey, widget, WidgetData{.sprite = sprite}, STR_TOOLBAR_TOOLTIP_PAUSE_GAME + widget);
2256 leaf->SetToolbarMinimalSize(1);
2257 hor->Add(std::move(leaf));
2258 }
2259
2260 return hor;
2261}
2262
2263static constexpr std::initializer_list<NWidgetPart> _nested_toolbar_normal_widgets = {
2265};
2266
2269 WindowPosition::Manual, {}, 0, 0,
2270 WindowClass::MainToolbar, WindowClass::None,
2272 _nested_toolbar_normal_widgets,
2273 &MainToolbarWindow::hotkeys
2274);
2275
2276
2277/* --- Toolbar handling for the scenario editor */
2278
2279static MenuClickedProc * const _scen_toolbar_dropdown_procs[] = {
2280 nullptr, // 0
2281 nullptr, // 1
2282 MenuClickSettings, // 2
2283 MenuClickSaveLoad, // 3
2284 nullptr, // 4
2285 nullptr, // 5
2286 nullptr, // 6
2287 nullptr, // 7
2288 MenuClickMap, // 8
2289 nullptr, // 9
2290 nullptr, // 10
2291 nullptr, // 11
2292 ToolbarScenGenTown, // 12
2293 nullptr, // 13
2296 nullptr, // 16
2297 nullptr, // 17
2298 nullptr, // 18
2299 nullptr, // 19
2301 MenuClickHelp, // 21
2302 nullptr, // 22
2303};
2304
2305static ToolbarButtonProc * const _scen_toolbar_button_procs[] = {
2306 ToolbarPauseClick,
2310 ToolbarBtn_NULL,
2312 ToolbarScenDateBackward,
2313 ToolbarScenDateForward,
2314 ToolbarScenMapTownDir,
2315 ToolbarZoomInClick,
2316 ToolbarZoomOutClick,
2317 ToolbarScenGenLand,
2318 ToolbarScenGenTownClick,
2319 ToolbarScenGenIndustry,
2320 ToolbarScenBuildRoadClick,
2321 ToolbarScenBuildTramClick,
2322 ToolbarScenBuildDocks,
2323 ToolbarScenPlantTrees,
2324 ToolbarScenPlaceSign,
2325 ToolbarBtn_NULL,
2326 ToolbarMusicClick,
2327 ToolbarHelpClick,
2328 ToolbarSwitchClick,
2329};
2330
2361
2362struct ScenarioEditorToolbarWindow : Window {
2363 ScenarioEditorToolbarWindow(WindowDesc &desc) : Window(desc)
2364 {
2365 this->InitNested(0);
2366
2368 this->flags.Reset(WindowFlag::WhiteBorder);
2369 PositionMainToolbar(this);
2371 }
2372
2373 void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
2374 {
2375 Window::FindWindowPlacementAndResize(_toolbar_width, def_height, allow_resize);
2376 }
2377
2387
2388 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
2389 {
2390 switch (widget) {
2391 case WID_TE_DATE:
2392 return GetString(STR_JUST_DATE_LONG, TimerGameCalendar::ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1));
2393
2394 default:
2395 return this->Window::GetWidgetString(widget, stringid);
2396 }
2397 }
2398
2399 void DrawWidget(const Rect &r, WidgetID widget) const override
2400 {
2401 switch (widget) {
2402 case WID_TE_SPACER: {
2403 int height = r.Height();
2405 DrawString(r.left, r.right, height / 2 - GetCharacterHeight(FontSize::Normal), STR_SCENEDIT_TOOLBAR_OPENTTD, TextColour::FromString, AlignmentH::Centre);
2406 DrawString(r.left, r.right, height / 2, STR_SCENEDIT_TOOLBAR_SCENARIO_EDITOR, TextColour::FromString, AlignmentH::Centre);
2407 } else {
2408 DrawString(r.left, r.right, (height - GetCharacterHeight(FontSize::Normal)) / 2, STR_SCENEDIT_TOOLBAR_SCENARIO_EDITOR, TextColour::FromString, AlignmentH::Centre);
2409 }
2410 break;
2411 }
2412 }
2413 }
2414
2415 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2416 {
2417 switch (widget) {
2418 case WID_TE_SPACER:
2419 size.width = std::max(GetStringBoundingBox(STR_SCENEDIT_TOOLBAR_OPENTTD).width, GetStringBoundingBox(STR_SCENEDIT_TOOLBAR_SCENARIO_EDITOR).width) + padding.width;
2420 break;
2421
2422 case WID_TE_DATE:
2424 break;
2425 }
2426 }
2427
2428 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2429 {
2430 if (_game_mode == GameMode::Menu) return;
2431 CallBackFunction cbf = _scen_toolbar_button_procs[widget](this);
2433 }
2434
2435 void OnDropdownSelect(WidgetID widget, int index, int) override
2436 {
2437 CallBackFunction cbf = _scen_toolbar_dropdown_procs[widget](index);
2439 SndClickBeep();
2440 }
2441
2442 EventState OnHotkey(int hotkey) override
2443 {
2444 if (IsSpecialHotkey(hotkey)) {
2446 switch (MainToolbarEditorHotkeys(hotkey)) {
2449 case MainToolbarEditorHotkeys::Music: ShowMusicWindow(); break;
2450 case MainToolbarEditorHotkeys::LandInfo: cbf = PlaceLandBlockInfo(); break;
2458 case MainToolbarEditorHotkeys::GenerateTown: ShowFoundTownWindow(); break;
2461 default: return EventState::NotHandled;
2462 }
2464 } else {
2465 this->OnClick({}, hotkey, 0);
2466 }
2467 return EventState::Handled;
2468 }
2469
2470 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
2471 {
2472 switch (_last_started_action) {
2474 PlaceProc_Sign(tile);
2475 break;
2476
2478 ShowLandInfo(tile);
2479 break;
2480
2481 default: NOT_REACHED();
2482 }
2483 }
2484
2489
2496
2498 const IntervalTimer<TimerWindow> refresh_interval = {std::chrono::milliseconds(30), [this](auto) {
2499 if (this->IsWidgetLowered(WID_TE_PAUSE) != _pause_mode.Any()) {
2501 this->SetDirty();
2502 }
2503
2504 if (this->IsWidgetLowered(WID_TE_FAST_FORWARD) != (_game_speed != 100)) {
2506 this->SetDirty();
2507 }
2508 }};
2509
2515 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2516 {
2517 if (!gui_scope) return;
2519 }
2520
2521 void OnQueryTextFinished(std::optional<std::string> str) override
2522 {
2523 /* Was 'cancel' pressed? */
2524 if (!str.has_value()) return;
2525
2527 if (!str->empty()) {
2528 auto val = ParseInteger(*str, 10, true);
2529 if (!val.has_value()) return;
2530 value = static_cast<TimerGameCalendar::Year>(*val);
2531 } else {
2532 /* An empty string means revert to the default */
2534 }
2535 SetStartingYear(value);
2536
2537 this->SetDirty();
2538 }
2539
2540 static inline HotkeyList hotkeys{"scenedit_maintoolbar", {
2541 Hotkey({WKC_F1, WKC_PAUSE}, "pause", MainToolbarEditorHotkeys::Pause),
2542 Hotkey(0, "fastforward", MainToolbarEditorHotkeys::FastForward),
2543 Hotkey(WKC_F2, "settings", MainToolbarEditorHotkeys::Settings),
2544 Hotkey(WKC_F3, "saveload", MainToolbarEditorHotkeys::SaveGame),
2545 Hotkey(WKC_F4, "gen_land", MainToolbarEditorHotkeys::GenerateLand),
2546 Hotkey(WKC_F5, "gen_town", MainToolbarEditorHotkeys::GenerateTown),
2547 Hotkey(WKC_F6, "gen_industry", MainToolbarEditorHotkeys::GenerateIndustry),
2548 Hotkey(WKC_F7, "build_road", MainToolbarEditorHotkeys::BuildRoad),
2549 Hotkey(0, "build_tram", MainToolbarEditorHotkeys::BuildTram),
2550 Hotkey(WKC_F8, "build_docks", MainToolbarEditorHotkeys::BuildWater),
2551 Hotkey(WKC_F9, "build_trees", MainToolbarEditorHotkeys::BuildTrees),
2552 Hotkey(WKC_F10, "build_sign", MainToolbarEditorHotkeys::Sign),
2553 Hotkey(WKC_F11, "music", MainToolbarEditorHotkeys::Music),
2554 Hotkey(WKC_F12, "land_info", MainToolbarEditorHotkeys::LandInfo),
2555 Hotkey(WKC_CTRL | 'S', "small_screenshot", MainToolbarEditorHotkeys::SmallScreenshot),
2556 Hotkey(WKC_CTRL | 'P', "zoomedin_screenshot", MainToolbarEditorHotkeys::ZoomedInScreenshot),
2557 Hotkey(WKC_CTRL | 'D', "defaultzoom_screenshot", MainToolbarEditorHotkeys::DefaultZoomScreenshot),
2558 Hotkey(0, "giant_screenshot", MainToolbarEditorHotkeys::GiantScreenshot),
2559 Hotkey({WKC_NUM_PLUS, WKC_EQUALS, WKC_SHIFT | WKC_EQUALS, WKC_SHIFT | WKC_F5}, "zoomin", MainToolbarEditorHotkeys::ZoomIn),
2560 Hotkey({WKC_NUM_MINUS, WKC_MINUS, WKC_SHIFT | WKC_MINUS, WKC_SHIFT | WKC_F6}, "zoomout", MainToolbarEditorHotkeys::ZoomOut),
2561 Hotkey('L', "terraform", MainToolbarEditorHotkeys::Terraform),
2562 Hotkey('M', "smallmap", MainToolbarEditorHotkeys::SmallMap),
2563 Hotkey('V', "extra_viewport", MainToolbarEditorHotkeys::ExtraViewport),
2564 }};
2565};
2566
2567static constexpr std::initializer_list<NWidgetPart> _nested_toolb_scen_inner_widgets = {
2568 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_PAUSE), SetSpriteTip(SPR_IMG_PAUSE, STR_TOOLBAR_TOOLTIP_PAUSE_GAME),
2571 NWidget(WWT_IMGBTN_2, Colours::Grey, WID_TE_SAVE), SetSpriteTip(SPR_IMG_SAVE, STR_SCENEDIT_TOOLBAR_SAVE_SCENARIO_LOAD_SCENARIO_TOOLTIP),
2577 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_DATE_BACKWARD), SetSpriteTip(SPR_ARROW_DOWN, STR_SCENEDIT_TOOLBAR_MOVE_THE_STARTING_DATE_BACKWARD_TOOLTIP), SetFill(0, 1),
2579 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_DATE_FORWARD), SetSpriteTip(SPR_ARROW_UP, STR_SCENEDIT_TOOLBAR_MOVE_THE_STARTING_DATE_FORWARD_TOOLTIP), SetFill(0, 1),
2580 EndContainer(),
2581 EndContainer(),
2583 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_SMALL_MAP), SetSpriteTip(SPR_IMG_SMALLMAP, STR_SCENEDIT_TOOLBAR_DISPLAY_MAP_TOWN_DIRECTORY_TOOLTIP),
2585 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_ZOOM_IN), SetSpriteTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN),
2586 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_ZOOM_OUT), SetSpriteTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT),
2588 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_LAND_GENERATE), SetSpriteTip(SPR_IMG_LANDSCAPING, STR_SCENEDIT_TOOLBAR_LANDSCAPE_GENERATION_TOOLTIP),
2589 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_TOWN_GENERATE), SetSpriteTip(SPR_IMG_TOWN, STR_SCENEDIT_TOOLBAR_TOWN_GENERATION_TOOLTIP),
2590 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_INDUSTRY), SetSpriteTip(SPR_IMG_INDUSTRY, STR_SCENEDIT_TOOLBAR_INDUSTRY_GENERATION_TOOLTIP),
2591 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_ROADS), SetSpriteTip(SPR_IMG_BUILDROAD, STR_SCENEDIT_TOOLBAR_ROAD_CONSTRUCTION_TOOLTIP),
2592 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_TRAMS), SetSpriteTip(SPR_IMG_BUILDTRAMS, STR_SCENEDIT_TOOLBAR_TRAM_CONSTRUCTION_TOOLTIP),
2593 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_WATER), SetSpriteTip(SPR_IMG_BUILDWATER, STR_TOOLBAR_TOOLTIP_BUILD_SHIP_DOCKS),
2594 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_TREES), SetSpriteTip(SPR_IMG_PLANTTREES, STR_SCENEDIT_TOOLBAR_PLANT_TREES_TOOLTIP),
2595 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_TE_SIGNS), SetSpriteTip(SPR_IMG_SIGN, STR_SCENEDIT_TOOLBAR_PLACE_SIGN_TOOLTIP),
2597 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_MUSIC_SOUND), SetSpriteTip(SPR_IMG_MUSIC, STR_TOOLBAR_TOOLTIP_SHOW_SOUND_MUSIC_WINDOW),
2598 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_HELP), SetSpriteTip(SPR_IMG_QUERY, STR_TOOLBAR_TOOLTIP_LAND_BLOCK_INFORMATION),
2599 NWidget(WWT_IMGBTN, Colours::Grey, WID_TE_SWITCH_BAR), SetSpriteTip(SPR_IMG_SWITCH_TOOLBAR, STR_TOOLBAR_TOOLTIP_SWITCH_TOOLBAR),
2600};
2601
2602static std::unique_ptr<NWidgetBase> MakeScenarioToolbar()
2603{
2604 return MakeNWidgets(_nested_toolb_scen_inner_widgets, std::make_unique<NWidgetScenarioToolbarContainer>());
2605}
2606
2607static constexpr std::initializer_list<NWidgetPart> _nested_toolb_scen_widgets = {
2608 NWidgetFunction(MakeScenarioToolbar),
2609};
2610
2613 WindowPosition::Manual, {}, 0, 0,
2614 WindowClass::MainToolbar, WindowClass::None,
2616 _nested_toolb_scen_widgets,
2617 &ScenarioEditorToolbarWindow::hotkeys
2618);
2619
2622{
2623 if (_game_mode == GameMode::Editor) {
2625 } else {
2627 }
2628}
void ShowAIConfigWindow()
Open the AI config window.
Definition ai_gui.cpp:338
Window for configuring the AIs.
Window * ShowBuildAirToolbar()
Open the build airport toolbar window.
Functions related to cheating.
void ShowCheatWindow()
Open cheat window.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
static LinkGraphSchedule instance
Static instance of LinkGraphSchedule.
WidgetType type
Type of the widget / nested widget.
uint resize_x
Horizontal resize step (0 means not resizable).
uint fill_x
Horizontal fill stepsize (from initial size, 0 means not resizable).
uint smallest_x
Smallest horizontal size of the widget in a filled window.
uint current_x
Current horizontal size (after resizing).
int pos_y
Vertical position of top-left corner of the widget in the window.
int pos_x
Horizontal position of top-left corner of the widget in the window.
uint smallest_y
Smallest vertical size of the widget in a filled window.
uint fill_y
Vertical fill stepsize (from initial size, 0 means not resizable).
uint resize_y
Vertical resize step (0 means not resizable).
uint current_y
Current vertical size (after resizing).
void Draw(const Window *w) override
Draw the widgets of the tree.
Definition widget.cpp:1343
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in container.
Base class for a 'real' widget.
Container for the 'normal' main toolbar.
const WidgetID * GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const override
Get the arrangement of the buttons for the toolbar.
Container for the scenario editor's toolbar.
std::array< uint, 2 > panel_widths
The width of the two panels (the text panel and date panel).
const WidgetID * GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const override
Get the arrangement of the buttons for the toolbar.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
uint spacers
Number of spacer widgets in this toolbar.
void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
Assign size and position to the widget.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
bool IsButton(WidgetType type) const
Check whether the given widget type is a button for us.
void Draw(const Window *w) override
Draw the widgets of the tree.
virtual const WidgetID * GetButtonArrangement(uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const =0
Get the arrangement of the buttons for the toolbar.
static Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
static void SetDate(Date date, DateFract fract)
Set the date.
static constexpr TimerGame< struct Calendar >::Year DEF_START_YEAR
static constexpr TimerGame< struct Calendar >::Year MIN_YEAR
static constexpr TimerGame< struct Calendar >::Year MAX_YEAR
static Date date
Current date in days (day counter).
static void SetDate(Date date, DateFract fract)
Set the date.
StrongType::Typedef< int32_t, struct YearTag< struct Calendar >, StrongType::Compare, StrongType::Integer > Year
StrongType::Typedef< int32_t, DateTag< struct Calendar >, StrongType::Compare, StrongType::Integer > Date
Functions related to commands.
PaletteID GetCompanyPalette(CompanyID company)
Get the palette for recolouring with a company colour.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
void ShowCompanyFinances(CompanyID company)
Open the finances window of a company.
void ShowCompany(CompanyID company)
Show the window with the overview of the company.
GUI Functions related to companies.
void ShowCompanyStations(CompanyID company)
Opens window with list of company's stations.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
void ShowFramerateWindow()
Open the general framerate window.
void IConsoleSwitch()
Toggle in-game console between opened and closed.
GUI related functions in the console.
Window * ShowBuildDocksScenToolbar()
Open the build water toolbar window for the scenario editor.
Definition dock_gui.cpp:416
Window * ShowBuildDocksToolbar()
Open the build water toolbar window.
Definition dock_gui.cpp:375
std::unique_ptr< DropDownListItem > MakeDropDownListDividerItem()
Creates new DropDownListDividerItem.
Definition dropdown.cpp:36
std::unique_ptr< DropDownListItem > MakeDropDownListIconItem(SpriteID sprite, PaletteID palette, StringID str, int value, bool masked, bool shaded)
Creates new DropDownListIconItem.
Definition dropdown.cpp:70
std::unique_ptr< DropDownListItem > MakeDropDownListStringItem(StringID str, int value, bool masked, bool shaded)
Creates new DropDownListStringItem.
Definition dropdown.cpp:49
std::unique_ptr< DropDownListItem > MakeDropDownListCheckedItem(bool checked, StringID str, int value, bool masked, bool shaded, uint indent)
Creates new DropDownListCheckedItem.
Definition dropdown.cpp:94
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options, std::string *const persistent_filter_text)
Show a drop down list.
Definition dropdown.cpp:591
Common drop down list components.
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
@ InstantClose
Set if releasing mouse button should close the list regardless of where the cursor is.
@ Filterable
Set if the dropdown is filterable.
EnumBitSet< DropDownOption, uint8_t > DropDownOptions
Bitset of DropDownOption elements.
@ Save
File is being saved.
Definition fileio_type.h:54
@ Load
File is being loaded.
Definition fileio_type.h:53
@ Savegame
old or new savegame
Definition fileio_type.h:18
@ Scenario
old or new scenario
Definition fileio_type.h:19
@ Heightmap
heightmap file
Definition fileio_type.h:20
Declarations for savegames operations.
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:88
Types for recording game performance data.
void ShowGSConfigWindow()
Open the GS config window.
Definition game_gui.cpp:428
Window for configuring GS.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
@ Centre
Align to the centre.
@ Middle
Align to the middle.
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:894
uint16_t _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition gfx.cpp:40
ControlInputs _input_clicked
Control inputs that have been actioned.
Definition gfx.cpp:35
PauseModes _pause_mode
The current pause mode.
Definition gfx.cpp:46
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:111
int DrawString(int left, int right, int top, std::string_view str, ExtendedTextColour colour, Alignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:663
Dimension GetSquareScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI, as a square.
Definition widget.cpp:85
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition gfxinit.cpp:325
bool IsCtrlPressed()
Test if the ctrl key is pressed.
Definition gfx_func.h:82
@ Normal
Index of the normal font in the font tables.
Definition gfx_type.h:249
@ Invalid
Invalid marker.
Definition gfx_type.h:302
@ Grey
Grey.
Definition gfx_type.h:299
@ White
White colour.
Definition gfx_type.h:330
@ FromString
Marker for telling to use the colour from the string.
Definition gfx_type.h:317
@ Checker
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:393
@ Left
Left mouse button is pressed.
Definition gfx_type.h:444
@ WKC_MINUS
Definition gfx_type.h:106
@ WKC_EQUALS
= Equals
Definition gfx_type.h:99
Goal base class.
void ShowGoalsList(CompanyID company)
Open a goal list window.
Definition goal_gui.cpp:311
Goal GUI functions.
Graph GUI functions.
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
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 SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
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.
std::unique_ptr< NWidgetBase > MakeNWidgets(std::span< const NWidgetPart > nwid_parts, std::unique_ptr< NWidgetBase > &&container)
Construct a nested widget tree from an array of parts.
Definition widget.cpp:3431
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FontSize::Normal)
Widget part function for setting the text style.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetAlignment(Alignment align)
Widget part function for setting the alignment of text/images.
static const CursorID SPR_CURSOR_SIGN
Definition sprites.h:1574
static const CursorID SPR_CURSOR_QUERY
Definition sprites.h:1571
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
GUI functions that shouldn't be here.
void ShowStoryBook(CompanyID company, StoryPageID page_id=StoryPageID::Invalid(), bool centered=false)
Raise or create the story book window for company, at page page_id.
void ShowIndustryCargoesWindow()
Open the industry and cargoes window with an industry.
void ShowLandInfo(TileIndex tile)
Show land information window.
Definition misc_gui.cpp:314
void ShowExtraViewportWindowForTileUnderCursor()
Show a new Extra Viewport window.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
void ShowGameOptions()
Open the game options window.
bool LoadHeightmap(DetailedFileType dft, std::string_view filename)
Load a heightmap from file and change the map in its current dimensions to a landscape representing t...
GUI to access manuals and related.
Declaration of functions and types defined in highscore.h and highscore_gui.h.
void ShowHighscoreTable(int difficulty=SP_CUSTOM, int8_t rank=-1)
Show the highscore table for a given difficulty.
Hotkey related functions.
static constexpr int SPECIAL_HOTKEY_BIT
Bit which denotes that hotkey isn't bound to UI button.
Definition hotkeys.h:75
bool IsSpecialHotkey(const int &hotkey)
Checks if hotkey index is special or not.
Definition hotkeys.h:82
Definition of HouseSpec and accessors.
LeagueTable base class.
League table GUI functions.
PoolID< uint8_t, struct LeagueTableIDTag, 255, 0xFF > LeagueTableID
ID of a league table.
Definition league_type.h:35
void ShowLinkGraphLegend()
Open a link graph legend window.
Declaration of linkgraph overlay GUI.
Declaration of link graph schedule used for cargo distribution.
#define Point
Macro that prevents name conflicts between included headers.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition main_gui.cpp:88
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
Miscellaneous command definitions.
void ShowQueryString(std::string_view str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
bool _networking
are we in networking mode?
Definition network.cpp:63
bool _network_server
network-server is active
Definition network.cpp:64
bool NetworkCanJoinCompany(CompanyID company_id)
Returns whether the given company can be joined by this client.
Definition network.cpp:139
Basic functions/variables used all over the place.
void NetworkClientRequestMove(CompanyID company_id)
Notify the server of this client wanting to be moved to another company.
Network functions used by other parts of OpenTTD.
void NetworkServerDoMove(ClientID client_id, CompanyID company_id)
Handle the tid-bits of moving a client from one company to another.
void ShowClientList()
Open the client list window.
GUIs related to networking.
@ Server
Servers always have this ID.
GRFConfigList _grfconfig
First item in list of current GRF set up.
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfigList &config)
Setup the NewGRF gui.
@ Any
Use first found.
Functions/types related to NewGRF debugging.
void ShowSpriteAlignerWindow()
Show the window for aligning sprites.
Functions related to NewGRF objects.
void ShowLastNewsMessage()
Show previous news item.
void ShowMessageHistory()
Display window with news messages history.
GUI functions related to the news.
Functions related to objects.
Window * ShowBuildObjectPicker()
Show our object picker.
@ ShowSigns
Display signs.
Definition openttd.h:48
@ FullDetail
Also draw details of track and roads.
Definition openttd.h:50
@ ShowWaypointNames
Display waypoint names.
Definition openttd.h:51
@ ShowTownNames
Display town names.
Definition openttd.h:46
@ ShowStationNames
Display station names.
Definition openttd.h:47
@ FullAnimation
Perform palette animation.
Definition openttd.h:49
@ ShowCompetitorSigns
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition openttd.h:52
@ Normal
A game normally paused.
Definition openttd.h:72
@ Editor
In the scenario editor.
Definition openttd.h:21
@ Menu
In the main menu.
Definition openttd.h:19
static constexpr PixelColour PC_VERY_DARK_RED
Almost-black red palette colour.
static constexpr PixelColour PC_DARK_RED
Dark red palette colour.
Window * ShowBuildRailToolbar(RailType railtype)
Open the build rail toolbar window for a specific rail type.
Definition rail_gui.cpp:975
DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
Create a drop down list for all the rail types of the local company.
Functions/types etc.
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:26
RoadTypes GetRoadTypes(bool introduces)
Get list of road types, regardless of company availability.
Definition road.cpp:237
Road specific functions.
RoadTypes GetMaskForRoadTramType(RoadTramType rtt)
Get the mask for road types of the given RoadTramType.
Definition road.h:185
Window * ShowBuildRoadScenToolbar(RoadType roadtype)
Show the road building toolbar in the scenario editor.
Window * ShowBuildRoadToolbar(RoadType roadtype)
Open the build road toolbar window.
Functions/types related to the road GUIs.
RoadType
The different roadtypes we support.
Definition road_type.h:24
@ Tram
Tram type.
Definition road_type.h:40
@ Road
Road type.
Definition road_type.h:39
A number of safeguards to prevent using unsafe methods.
void ToggleScreensaverMode()
Enters or exits "Screensaver Mode".
Exports a function to turn on and off a screensaver mode.
void MakeScreenshotWithConfirm(ScreenshotType t)
Make a screenshot.
Functions to make screenshots.
@ SC_VIEWPORT
Screenshot of viewport.
Definition screenshot.h:17
@ SC_ZOOMEDIN
Fully zoomed in screenshot of the visible area.
Definition screenshot.h:19
@ SC_WORLD
World screenshot.
Definition screenshot.h:21
@ SC_DEFAULTZOOM
Zoomed to default zoom level screenshot of the visible area.
Definition screenshot.h:20
GUI functions related to screenshots.
Window * ShowScriptDebugWindow(CompanyID show_company, bool new_window)
Open the Script debug window and select the given company.
Window for configuring the scripts.
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.
Window * ShowSignList()
Open the sign list window.
void ShowSmallMap()
Show the smallmap window.
Smallmap GUI functions.
void SndConfirmBeep()
Play a beep sound for a confirm event if enabled in settings.
Definition sound.cpp:260
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Definition sound.cpp:252
Functions related to sound.
Functions to cache sprites in memory.
static const SpriteID SPR_IMG_PLANTTREES
Definition sprites.h:1260
static const SpriteID SPR_IMG_COMPANY_GENERAL
Definition sprites.h:1253
static const SpriteID SPR_IMG_BUILDAIR
Definition sprites.h:1271
static const SpriteID SPR_IMG_AIRPORT
Definition sprites.h:1458
static const SpriteID SPR_IMG_TRAINLIST
Definition sprites.h:1261
static const SpriteID SPR_IMG_INDUSTRY
Definition sprites.h:1259
static const SpriteID SPR_IMG_BUILDWATER
Definition sprites.h:1270
static const SpriteID SPR_IMG_BUILD_CANAL
Definition sprites.h:1241
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_COMPANY_LIST
Definition sprites.h:1251
static const SpriteID SPR_IMG_MUSIC
Definition sprites.h:1273
static const SpriteID SPR_IMG_GRAPHS
Definition sprites.h:1254
static const SpriteID SPR_IMG_PAUSE
Definition sprites.h:1244
static const SpriteID SPR_IMG_BUILDTRAMS
Definition sprites.h:1269
static const SpriteID SPR_IMG_SAVE
Definition sprites.h:1247
static const SpriteID SPR_IMG_COMPANY_FINANCE
Definition sprites.h:1252
static const SpriteID SPR_COMPANY_ICON
Icon showing company colour.
Definition sprites.h:386
static const SpriteID SPR_IMG_ZOOMIN
Definition sprites.h:1265
static const SpriteID SPR_IMG_MESSAGES
Definition sprites.h:1274
static const SpriteID SPR_LOCK
Lock icon (for password protected servers).
Definition sprites.h:73
static const SpriteID SPR_IMG_TRUCKLIST
Definition sprites.h:1262
static const SpriteID SPR_IMG_ZOOMOUT
Definition sprites.h:1266
static const SpriteID SPR_IMG_AIRPLANESLIST
Definition sprites.h:1264
static const SpriteID SPR_IMG_SUBSIDIES
Definition sprites.h:1250
static const SpriteID SPR_IMG_FASTFORWARD
Definition sprites.h:1245
static const SpriteID SPR_IMG_SHIPLIST
Definition sprites.h:1263
static const SpriteID SPR_IMG_TOWN
Definition sprites.h:1249
static const SpriteID SPR_IMG_SETTINGS
Definition sprites.h:1246
static const SpriteID SPR_IMG_COMPANY_LEAGUE
Definition sprites.h:1255
static const SpriteID SPR_EMPTY
Empty (transparent blue) sprite.
Definition sprites.h:46
static const SpriteID SPR_IMG_QUERY
Definition sprites.h:1275
static const SpriteID SPR_ARROW_DOWN
Definition sprites.h:85
static const SpriteID SPR_ARROW_UP
Definition sprites.h:86
static const SpriteID SPR_IMG_STORY_BOOK
Definition sprites.h:1278
static const SpriteID SPR_IMG_GOAL
Definition sprites.h:1546
static const SpriteID SPR_IMG_SMALLMAP
Definition sprites.h:1248
static const SpriteID SPR_IMG_BUILDROAD
Definition sprites.h:1268
static const SpriteID SPR_IMG_LANDSCAPING
Definition sprites.h:1272
static const SpriteID SPR_IMG_BUILDRAIL
Definition sprites.h:1267
static constexpr StationFacility STATION_FACILITY_GHOST
Fake 'facility' to allow toggling display of recently-removed station signs.
@ Dock
Station with a dock.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ Airport
Station with an airport.
@ BusStop
Station with bus stops.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:261
StoryPage base class.
Parse strings.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
@ CS_NUMERAL
Only numeric ones.
Definition string_type.h:26
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:423
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.
Settings related to the AI.
Dimensions (a width and height) of a rectangle in 2D.
value_type width
The width of the rectangle.
List of hotkeys for a window.
Definition hotkeys.h:44
All data for a single hotkey.
Definition hotkeys.h:20
Struct about custom league tables.
Definition league_base.h:46
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
void OnPaint() override
The window must be repainted.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
Resize window towards the default size.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
const IntervalTimer< TimerWindow > refresh_interval
Refresh the state of pause / game-speed on a regular interval.
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
static Pool::IterateWrapper< LeagueTable > Iterate(size_t from=0)
Specification of a rectangle with absolute coordinates of all edges.
int Height() const
Get height of Rect.
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a 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 OnPaint() override
The window must be repainted.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
void OnTimeout() override
Called when this window's timeout has been reached.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
const IntervalTimer< TimerWindow > refresh_interval
Refresh the state of pause / game-speed on a regular interval.
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
Resize window towards the default size.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
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.
Container with the data associated to a single widget.
High level window description.
Definition window_gui.h:171
Data structure for an opened window.
Definition window_gui.h:272
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:1025
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:792
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:565
uint8_t timeout_timer
Timer value of the WindowFlag::Timeout for flags.
Definition window_gui.h:305
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
Definition window_gui.h:317
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:513
ResizeInfo resize
Resize information.
Definition window_gui.h:313
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
Definition window_gui.h:514
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:490
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
Definition window_gui.h:409
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
Definition window_gui.h:525
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:440
virtual void FindWindowPlacementAndResize(int def_width, int def_height, bool allow_resize)
Resize window towards the default size.
Definition window.cpp:1523
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1879
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
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1869
WindowFlags flags
Window flags.
Definition window_gui.h:299
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:380
int height
Height of the window (number of pixels down in y direction).
Definition window_gui.h:311
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:310
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Definition window_gui.h:449
Window * ShowEditorTerraformToolbar()
Show the toolbar for terraforming in the scenario editor.
Window * ShowTerraformToolbar(Window *link)
Show the toolbar for terraforming in the game.
GUI stuff related to terraforming.
Stuff related to the text buffer GUI.
@ EnableDefault
enable the 'Default' button ("\0" is returned)
Definition textbuf_gui.h:20
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
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
@ HT_RECT
rectangle (stations, depots, ...)
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
Definition of the Window system.
static CallBackFunction MenuClickForest(int index)
Handle click on the entry in the landscaping menu.
SaveLoadEditorMenuEntries
SaveLoad entries in scenario editor mode.
@ LoadScenario
Load a scenario.
@ ExitGame
Exit to desktop.
@ SaveScenario
Save the scenario.
@ LoadHeightmap
Load a heightmap.
@ SaveHeightmap
Save the heightmap.
@ ExitToMainMenu
Exit to main menu.
RailType _last_built_railtype
The most recently used type of rail.
MainToolbarEditorHotkeys
List of hotkeys available in scenario editor.
@ GenerateTown
Open town generation window.
@ GenerateLand
Open land generation window.
@ Pause
(Un)pause the game.
@ Terraform
Open land generation window.
@ Sign
Toggle sign creation tool.
@ SmallMap
Open small map window.
@ GenerateIndustry
Open industry funding window.
@ Music
Open sound end music window.
@ GiantScreenshot
Take detailed screenshot of whole map.
@ BuildWater
Open window for building locks, canals, rivers and aqueducts.
@ ZoomedInScreenshot
Take zoomed in screenshot.
@ DefaultZoomScreenshot
Take screenshot with default zoom.
@ FastForward
Toggle the fast-forward mode.
@ SaveGame
Open save scenario window.
@ SmallScreenshot
Take small screenshot.
@ LandInfo
Toggle land info tool.
@ BuildTram
Open toolbar window with tools for building tramways.
@ BuildTrees
Open tree selection window.
@ BuildRoad
Open toolbar window with tools for building roads.
@ Settings
Open game options window.
@ ExtraViewport
Open new extra viewport window.
static std::string _railtype_filter
Persistent filter text for railtype dropdown menu.
static void PopupMainToolbarMenu(Window *w, WidgetID widget, DropDownList &&list, int def)
Pop up a generic text only menu.
static CallBackFunction MenuClickCompany(int index)
Handle click on the entry in the Company menu.
static std::string _roadtype_filter
Persistent filter text for roadtype dropdown menu.
static CallBackFunction MenuClickStations(int index)
Handle click on the entry in the Stations menu.
static CallBackFunction MenuClickTown(int index)
Handle click on one of the entries in the Town menu.
static const int LTMN_PERFORMANCE_LEAGUE
Show default league table.
ToolbarMode
Toolbar modes.
@ Upper
Toolbar is in split mode and the first part is selected.
@ Normal
Toolbar is in normal mode, in which all 30 buttons are accessible.
@ Lower
Toolbar is in split mode and the second part is selected.
static CallBackFunction MenuClickNewspaper(int index)
Handle click on the entry in the Newspaper menu.
static const int LTMN_PERFORMANCE_RATING
Show detailed performance rating.
CallBackFunction
Callback functions.
@ PlaceSign
A new sign will be placed when tile is selected afterwards.
@ None
No action will happen when tile is selected afterwards.
@ PlaceLandInfo
Land info window will appear when tile is selected afterwards.
static CallBackFunction ToolbarSaveClick(Window *w)
Handle click on Save button in toolbar in normal game mode.
static std::string _tramtype_filter
Persistent filter text for tramtype dropdown menu.
SaveLoadNormalMenuEntries
SaveLoad entries in normal game mode.
@ ExitGame
Exit to desktop.
@ ExitToMainMenu
Exit to main menu.
static CallBackFunction MenuClickShowRoad(int index)
Handle click on the entry in the Road Vehicles menu.
static const int GRMN_DELIVERED_CARGO_GRAPH
Show delivered cargo graph.
static CallBackFunction MenuClickGraphsOrLeague(int index)
Handle click on the entry in the Graphs or CompanyLeague.
static CallBackFunction MenuClickHelp(int index)
Choose the proper callback function for the main toolbar's help menu.
uint _toolbar_width
Width of the toolbar, shared by statusbar.
static const int GRMN_PERFORMANCE_HISTORY_GRAPH
Show performance history graph.
static CallBackFunction ToolbarOptionsClick(Window *w)
Handle click on Options button in toolbar.
static CallBackFunction MenuClickShowShips(int index)
Handle click on the entry in the Ships menu.
static DropDownOptions GetToolbarDropDownOptions(DropDownOptions options={})
Get options for toolbar dropdown menus,.
static std::unique_ptr< NWidgetBase > MakeMainToolbar()
Make widgets for the main toolbar.
static CallBackFunction MenuClickSaveLoad(int index=0)
Handle click on one of the entries in the SaveLoad menu.
RoadType _last_built_tramtype
The most recently used type of tram track.
static const int CTMN_CLIENT_LIST
Indicates the "all connected players" entry.
static const int GRMN_INCOME_GRAPH
Show income graph.
static CallBackFunction MenuClickMusicWindow(int)
Handle click on the entry in the Music menu.
RoadType _last_built_roadtype
The most recently used type of road.
static CallBackFunction ToolbarScenBuildTram(int index)
Handle click on the entry in the Build Tram menu.
static const int GRMN_COMPANY_VALUE_GRAPH
Show company value graph.
TownMenuEntries
Town button menu entries.
@ ShowDirectory
Open window with list of towns.
@ ShowPlaceHouses
Open house selection window.
@ ShowFoundTown
Open town generation window.
void ToggleDirtyBlocks()
Toggle drawing of the dirty blocks.
static WindowDesc _toolb_normal_desc(WindowPosition::Manual, {}, 0, 0, WindowClass::MainToolbar, WindowClass::None, {WindowDefaultFlag::NoFocus, WindowDefaultFlag::NoClose}, _nested_toolbar_normal_widgets, &MainToolbarWindow::hotkeys)
Window definition for the normal (top) toolbar.
static CallBackFunction MenuClickGoal(int index)
Handle click on the entry in the Goal menu.
static WindowDesc _toolb_scen_desc(WindowPosition::Manual, {}, 0, 0, WindowClass::MainToolbar, WindowClass::None, {WindowDefaultFlag::NoFocus, WindowDefaultFlag::NoClose}, _nested_toolb_scen_widgets, &ScenarioEditorToolbarWindow::hotkeys)
Window definition for the scenario editor (top) toolbar window.
static CallBackFunction ToolbarScenBuildRoad(int index)
Handle click on the entry in the Build Road menu.
static CallBackFunction MenuClickBuildRoad(int index)
Handle click on the entry in the Build Road menu.
MapMenuEntries
Map button menu entries.
@ ShowIndustryDirectory
Open window with list of industries.
@ ShowExtraViewport
Open new extra viewport window.
@ ShowSmallMap
Open small map window.
@ ShowLinkGraph
Open cargo flow legend window.
@ ShowTownDirectory
Open window with list of towns.
@ ShowSignList
Open sign list window.
static CallBackFunction _last_started_action
Last started user action.
Dimension GetToolbarMaximalImageSize()
Get maximal square size of a toolbar image.
static CallBackFunction MenuClickShowTrains(int index)
Handle click on the entry in the Train menu.
CallBackFunction(Window *w) ToolbarButtonProc
Callback for when a button is clicked in the given window.
static CallBackFunction MenuClickMap(int index)
Handle click on one of the entries in the Map menu.
static const int GRMN_OPERATING_PROFIT_GRAPH
Enum for the League Toolbar's and Graph Toolbar's related buttons.
static CallBackFunction MenuClickBuildRail(int index)
Handle click on the entry in the Build Rail menu.
static CallBackFunction MenuClickShowAir(int index)
Handle click on the entry in the Aircraft menu.
void AllocateToolbar()
Allocate the toolbar.
static const int GRMN_CARGO_PAYMENT_RATES
Show cargo payment rates graph.
static CallBackFunction ToolbarScenSaveOrLoad(Window *w)
Handle click on SaveLoad button in toolbar in the scenario editor.
static CallBackFunction MenuClickBuildTram(int index)
Handle click on the entry in the Build Tram menu.
static CallBackFunction ToolbarFastForwardClick(Window *)
Toggle fast forward mode.
OptionMenuEntries
Game Option button menu entries.
@ ShowBusStationNames
Toggle visibility of bus station names.
@ FullDetails
Toggle full details.
@ ShowSigns
Toggle visibility of signs.
@ ShowLorryStationNames
Toggle visibility of lorry station names.
@ ShowWaypointNames
Toggle visibility of waypoint names.
@ ShowDockNames
Toggle visibility of dock names.
@ TransparentStationSigns
Toggle transparency of signs and names.
@ ShowGhostStationNames
Toggle visibility of ghost station names.
@ GameScriptSettings
Open GS settings window.
@ ShowTownNames
Toggle visibility of town names.
@ AISettings
Open AI settings window.
@ ShowStationNames
Toggle visibility of station names.
@ TransparentBuildings
Toggle buildings transparency.
@ NewGRFSettings
Open NewGRF settings window.
@ ShowTrainStationNames
Toggle visibility of train station names.
@ Transparencies
Open transparency options window.
@ ShowAirportNames
Toggle visibility of airport names.
@ SandboxOptions
Open sandbox options window.
@ FullAnimation
Toggle full animations.
@ GameOptions
Open game options window.
@ ShowCompetitorSigns
Toggle visibility of competitor signs and names.
static CallBackFunction ToolbarScenDatePanel(Window *w)
Called when clicking at the date panel of the scenario editor toolbar.
static void PopupMainCompanyToolbMenu(Window *w, WidgetID widget, CompanyMask grey={})
Pop up a generic company list menu.
static CallBackFunction MenuClickBuildWater(int)
Handle click on the entry in the Build Waterways menu.
static const int CTMN_SPECTATE
Indicates the "become spectator" entry.
static CallBackFunction MenuClickSubsidies(int)
Handle click on the entry in the Subsidies menu.
void SetStartingYear(TimerGameCalendar::Year year)
Set the starting year for a scenario.
static const int LTMN_HIGHSCORE
Show highscrore table.
static CallBackFunction MenuClickStory(int index)
Handle click on the entry in the Story menu.
void ToggleBoundingBoxes()
Toggle drawing of sprites' bounding boxes.
static CallBackFunction MenuClickBuildAir(int)
Handle click on the entry in the Build Air menu.
void ToggleWidgetOutlines()
Toggle drawing of widget outlines.
static CallBackFunction MenuClickSettings(int index)
Handle click on one of the entries in the Options button menu.
static CallBackFunction MenuClickFinances(int index)
Handle click on the entry in the finances overview menu.
static constexpr std::tuple< WidgetID, WidgetType, SpriteID > _toolbar_button_sprites[]
Sprites to use for the different toolbar buttons.
static CallBackFunction MenuClickIndustry(int index)
Handle click on the entry in the Industry menu.
static const int CTMN_SPECTATOR
Indicates that a window is being opened for the spectator.
Stuff related to the (main) toolbar.
Types related to the toolbar widgets.
@ WID_TE_SMALL_MAP
Small map menu.
@ WID_TE_TREES
Tree building toolbar.
@ WID_TE_TRAMS
Tram building menu.
@ WID_TE_DATE
The date of the scenario.
@ WID_TE_ZOOM_IN
Zoom in the main viewport.
@ WID_TE_DATE_PANEL
Container for the date widgets.
@ WID_TE_HELP
Help menu.
@ WID_TE_ZOOM_OUT
Zoom out the main viewport.
@ WID_TE_INDUSTRY
Industry building window.
@ WID_TE_PAUSE
Pause the game.
@ WID_TE_DATE_FORWARD
Increase the date of the scenario.
@ WID_TE_SPACER
Spacer with "scenario editor" text.
@ WID_TE_WATER
Water building toolbar.
@ WID_TE_MUSIC_SOUND
Music/sound configuration menu.
@ WID_TE_SAVE
Save menu.
@ WID_TE_LAND_GENERATE
Land generation.
@ WID_TE_TOWN_GENERATE
Town building window.
@ WID_TE_SWITCH_BAR
Only available when toolbar has been split to switch between different subsets.
@ WID_TE_ROADS
Road building menu.
@ WID_TE_FAST_FORWARD
Fast forward the game.
@ WID_TE_SIGNS
Sign building.
@ WID_TE_SETTINGS
Settings menu.
@ WID_TE_DATE_BACKWARD
Reduce the date of the scenario.
@ WID_TN_LANDSCAPE
Landscaping toolbar.
@ WID_TN_AIR
Airport building toolbar.
@ WID_TN_SHIPS
Ship menu.
@ WID_TN_SETTINGS
Settings menu.
@ WID_TN_GOAL
Goal menu.
@ WID_TN_MUSIC_SOUND
Music/sound configuration menu.
@ WID_TN_RAILS
Rail building menu.
@ WID_TN_SUBSIDIES
Subsidy menu.
@ WID_TN_BUILDING_TOOLS_START
Helper for the offset of the building tools.
@ WID_TN_TRAMS
Tram building menu.
@ WID_TN_HELP
Help menu.
@ WID_TN_SAVE
Save menu.
@ WID_TN_STORY
Story menu.
@ WID_TN_MESSAGES
Messages menu.
@ WID_TN_ROADVEHS
Road vehicle menu.
@ WID_TN_VEHICLE_START
Helper for the offset of the vehicle menus.
@ WID_TN_FINANCES
Finance menu.
@ WID_TN_GRAPHS
Graph menu.
@ WID_TN_LEAGUE
Company league menu.
@ WID_TN_STATIONS
Station menu.
@ WID_TN_SWITCH_BAR
Only available when toolbar has been split to switch between different subsets.
@ WID_TN_COMPANIES
Company menu.
@ WID_TN_INDUSTRIES
Industry menu.
@ WID_TN_AIRCRAFT
Aircraft menu.
@ WID_TN_ZOOM_OUT
Zoom out the main viewport.
@ WID_TN_FAST_FORWARD
Fast forward the game.
@ WID_TN_ZOOM_IN
Zoom in the main viewport.
@ WID_TN_PAUSE
Pause the game.
@ WID_TN_WATER
Water building toolbar.
@ WID_TN_ROADS
Road building menu.
@ WID_TN_TRAINS
Train menu.
@ WID_TN_TOWNS
Town menu.
@ WID_TN_SMALL_MAP
Small map menu.
@ Forbidden
Forbidden.
Definition town_type.h:105
StationFacilities _facility_display_opt
What station facilities to draw.
void ToggleTransparency(TransparencyOption to)
Toggle the transparency option bit.
bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren't in the game menu (there's never transpar...
DisplayOptions _display_opt
What do we want to draw/do?
@ Houses
town buildings
void ShowTransparencyToolbar()
Show the transparency toolbar.
GUI functions related to transparency.
Base class for all vehicles.
Functions related to the vehicle's GUIs.
VehicleType
Available vehicle types.
@ Ship
Ship vehicle type.
@ Aircraft
Aircraft vehicle type.
@ Road
Road vehicle type.
@ Train
Train vehicle type.
void HandleZoomMessage(Window *w, const Viewport &vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition viewport.cpp:487
Functions related to (drawing on) viewports.
@ ZOOM_IN
Zoom in (get more detailed view).
@ ZOOM_NONE
Hack, used to update the button status.
@ ZOOM_OUT
Zoom out (get helicopter view).
WidgetType
Window widget types, nested widget types, and nested widget part types.
Definition widget_type.h:35
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:41
@ WWT_IMGBTN_2
(Toggle) Button with diff image when clicked
Definition widget_type.h:42
@ 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_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_TEXT
Pure simple text.
Definition widget_type.h:49
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition().
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1228
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition window.cpp:3549
void DeleteAllMessages()
Delete all messages and close their corresponding window (if any).
Definition window.cpp:3452
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.
@ NoClose
This window can't be interactively closed.
Definition window_gui.h:157
@ NoFocus
This window won't get focus/make any other window lose focus when click.
Definition window_gui.h:156
@ WhiteBorder
Window white border counter bit mask.
Definition window_gui.h:231
@ Timeout
Window timeout counter.
Definition window_gui.h:223
@ 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.