39#include "script/script_gui.h"
70#include "table/strings.h"
105 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)
133 if (
string == STR_NULL) {
134 list.push_back(MakeDropDownListDividerItem());
136 list.push_back(MakeDropDownListStringItem(
string, i));
163 list.push_back(MakeDropDownListStringItem(STR_NETWORK_COMPANY_LIST_CLIENT_LIST,
CTMN_CLIENT_LIST));
166 list.push_back(MakeDropDownListStringItem(STR_NETWORK_COMPANY_LIST_SPECTATE,
CTMN_SPECTATE));
170 list.push_back(MakeDropDownListStringItem(STR_STORY_BOOK_SPECTATOR,
CTMN_SPECTATOR));
174 list.push_back(MakeDropDownListStringItem(STR_GOALS_SPECTATOR,
CTMN_SPECTATOR));
178 for (
CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
180 list.push_back(std::make_unique<DropDownListCompanyItem>(c, grey.Test(c)));
195 return CBF_PLACE_SIGN;
232 OME_GAMESCRIPT_SETTINGS,
237 OME_SHOW_STATIONNAMES,
238 OME_SHOW_STATIONNAMES_TRAIN,
239 OME_SHOW_STATIONNAMES_LORRY,
240 OME_SHOW_STATIONNAMES_BUS,
241 OME_SHOW_STATIONNAMES_SHIP,
242 OME_SHOW_STATIONNAMES_PLANE,
243 OME_SHOW_STATIONNAMES_GHOST,
244 OME_SHOW_WAYPOINTNAMES,
246 OME_SHOW_COMPETITOR_SIGNS,
249 OME_TRANSPARENTBUILDINGS,
250 OME_SHOW_STATIONSIGNS,
262 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_GAME_OPTIONS, OME_GAMEOPTIONS));
267 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_AI_SETTINGS, OME_AI_SETTINGS));
268 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_GAMESCRIPT_SETTINGS, OME_GAMESCRIPT_SETTINGS));
270 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_NEWGRF_SETTINGS, OME_NEWGRFSETTINGS));
272 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_SANDBOX_OPTIONS, OME_SANDBOX));
274 list.push_back(MakeDropDownListStringItem(STR_SETTINGS_MENU_TRANSPARENCY_OPTIONS, OME_TRANSPARENCIES));
275 list.push_back(MakeDropDownListDividerItem());
289 list.push_back(MakeDropDownListCheckedItem(
IsTransparencySet(
TO_HOUSES), STR_SETTINGS_MENU_TRANSPARENT_BUILDINGS, OME_TRANSPARENTBUILDINGS));
290 list.push_back(MakeDropDownListCheckedItem(
IsTransparencySet(
TO_SIGNS), STR_SETTINGS_MENU_TRANSPARENT_SIGNS, OME_SHOW_STATIONSIGNS));
322 case OME_SHOW_COMPETITOR_SIGNS:
339 SLEME_SAVE_SCENARIO = 0,
341 SLEME_SAVE_HEIGHTMAP,
342 SLEME_LOAD_HEIGHTMAP,
366 STR_NULL, STR_FILE_MENU_EXIT});
379 STR_SCENEDIT_FILE_MENU_SAVE_HEIGHTMAP, STR_SCENEDIT_FILE_MENU_LOAD_HEIGHTMAP,
380 STR_SCENEDIT_FILE_MENU_QUIT_EDITOR, STR_NULL, STR_SCENEDIT_FILE_MENU_QUIT});
392 if (_game_mode == GM_EDITOR) {
398 case SLEME_EXIT_TOINTRO: AskExitToGameMenu();
break;
399 case SLEME_EXIT_GAME: HandleExitGameRequest();
break;
405 case SLNME_EXIT_TOINTRO: AskExitToGameMenu();
break;
406 case SLNME_EXIT_GAME: HandleExitGameRequest();
break;
414enum MapMenuEntries : uint8_t {
415 MME_SHOW_SMALLMAP = 0,
416 MME_SHOW_EXTRAVIEWPORTS,
419 MME_SHOW_TOWNDIRECTORY,
420 MME_SHOW_INDUSTRYDIRECTORY,
426 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_MAP_OF_WORLD, MME_SHOW_SMALLMAP));
427 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_EXTRA_VIEWPORT, MME_SHOW_EXTRAVIEWPORTS));
428 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_LINGRAPH_LEGEND, MME_SHOW_LINKGRAPH));
429 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_SIGN_LIST, MME_SHOW_SIGNLISTS));
437 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_MAP_OF_WORLD, MME_SHOW_SMALLMAP));
438 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_EXTRA_VIEWPORT, MME_SHOW_EXTRAVIEWPORTS));
439 list.push_back(MakeDropDownListStringItem(STR_MAP_MENU_SIGN_LIST, MME_SHOW_SIGNLISTS));
440 list.push_back(MakeDropDownListStringItem(STR_TOWN_MENU_TOWN_DIRECTORY, MME_SHOW_TOWNDIRECTORY));
441 list.push_back(MakeDropDownListStringItem(STR_INDUSTRY_MENU_INDUSTRY_DIRECTORY, MME_SHOW_INDUSTRYDIRECTORY));
459 case MME_SHOW_TOWNDIRECTORY: ShowTownDirectory();
break;
460 case MME_SHOW_INDUSTRYDIRECTORY: ShowIndustryDirectory();
break;
467enum TownMenuEntries {
468 TME_SHOW_DIRECTORY = 0,
470 TME_SHOW_PLACE_HOUSES,
476 list.push_back(MakeDropDownListStringItem(STR_TOWN_MENU_TOWN_DIRECTORY, TME_SHOW_DIRECTORY));
494 case TME_SHOW_DIRECTORY: ShowTownDirectory();
break;
495 case TME_SHOW_FOUND_TOWN:
498 case TME_SHOW_PLACE_HOUSES:
656static void AddDropDownLeagueTableOptions(
DropDownList &list)
660 list.push_back(MakeDropDownListStringItem(lt->title.GetDecodedString(), lt->index.base()));
664 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_DETAILED_PERFORMANCE_RATING,
LTMN_PERFORMANCE_RATING));
666 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_HIGHSCORE,
LTMN_HIGHSCORE));
676 list.push_back(MakeDropDownListStringItem(STR_GRAPH_MENU_INCOME_GRAPH,
GRMN_INCOME_GRAPH));
682 if (_toolbar_mode != TB_NORMAL) AddDropDownLeagueTableOptions(list);
692 AddDropDownLeagueTableOptions(list);
694 int selected = list[0]->result;
750 case 0: ShowIndustryDirectory();
break;
752 case 2: ShowBuildIndustryWindow();
break;
764 if (c->group_all[veh].num_vehicle == 0) dis.
Set(c->index);
884 _last_built_railtype = (
RailType)index;
905 _last_built_roadtype = (
RoadType)index;
926 _last_built_tramtype = (
RoadType)index;
936 list.push_back(MakeDropDownListIconItem(SPR_IMG_BUILD_CANAL, PAL_NONE, STR_WATERWAYS_MENU_WATERWAYS_CONSTRUCTION, 0));
957 list.push_back(MakeDropDownListIconItem(SPR_IMG_AIRPORT, PAL_NONE, STR_AIRCRAFT_MENU_AIRPORT_CONSTRUCTION, 0));
978 list.push_back(MakeDropDownListIconItem(SPR_IMG_LANDSCAPING, PAL_NONE, STR_LANDSCAPING_MENU_LANDSCAPING, 0));
979 list.push_back(MakeDropDownListIconItem(SPR_IMG_PLANTTREES, PAL_NONE, STR_LANDSCAPING_MENU_PLANT_TREES, 1));
980 list.push_back(MakeDropDownListIconItem(SPR_IMG_SIGN, PAL_NONE, STR_LANDSCAPING_MENU_PLACE_SIGN, 2));
995 case 1: ShowBuildTreesToolbar();
break;
996 case 2:
return SelectSignTool();
1053 return CBF_PLACE_LANDINFO;
1061 STR_ABOUT_MENU_HELP, STR_NULL, STR_ABOUT_MENU_TOGGLE_CONSOLE, STR_ABOUT_MENU_AI_DEBUG,
1062 STR_ABOUT_MENU_SCREENSHOT, STR_ABOUT_MENU_SHOW_FRAMERATE, STR_ABOUT_MENU_ABOUT_OPENTTD,
1063 STR_ABOUT_MENU_SPRITE_ALIGNER, STR_ABOUT_MENU_TOGGLE_BOUNDING_BOXES, STR_ABOUT_MENU_TOGGLE_DIRTY_BLOCKS,
1064 STR_ABOUT_MENU_TOGGLE_WIDGET_OUTLINES});
1067 STR_ABOUT_MENU_HELP, STR_NULL, STR_ABOUT_MENU_TOGGLE_CONSOLE, STR_ABOUT_MENU_AI_DEBUG,
1068 STR_ABOUT_MENU_SCREENSHOT, STR_ABOUT_MENU_SHOW_FRAMERATE, STR_ABOUT_MENU_ABOUT_OPENTTD});
1082 extern bool _draw_bounding_boxes;
1085 _draw_bounding_boxes = !_draw_bounding_boxes;
1099 extern bool _draw_dirty_blocks;
1102 _draw_dirty_blocks = !_draw_dirty_blocks;
1113 extern bool _draw_widget_outlines;
1116 _draw_widget_outlines = !_draw_widget_outlines;
1150 case 0:
return PlaceLandBlockInfo();
1151 case 1: ShowHelpWindow();
break;
1154 case 4: ShowScreenshotWindow();
break;
1156 case 6: ShowAboutWindow();
break;
1169 if (_toolbar_mode != TB_LOWER) {
1170 _toolbar_mode = TB_LOWER;
1172 _toolbar_mode = TB_UPPER;
1235 case 0: ShowFoundTownWindow();
break;
1236 case 1: ShowBuildHousePicker(
nullptr);
break;
1244 ShowBuildIndustryWindow();
1262 _last_built_roadtype = (
RoadType)index;
1281 _last_built_tramtype = (
RoadType)index;
1296 ShowBuildTreesToolbar();
1303 return SelectSignTool();
1313static MenuClickedProc *
const _menu_clicked_procs[] = {
1378 for (
const auto &child_wid : this->
children) {
1379 child_wid->SetupSmallestSize(w);
1380 this->
smallest_y = std::max(this->
smallest_y, child_wid->smallest_y + child_wid->padding.Vertical());
1381 if (this->
IsButton(child_wid->type)) {
1383 this->
smallest_x = std::max(this->
smallest_x, child_wid->smallest_x + child_wid->padding.Horizontal());
1390 for (
const auto &child_wid : this->
children) {
1392 if (!this->
IsButton(child_wid->type)) {
1393 child_wid->current_x = child_wid->smallest_x;
1415 uint arrangeable_count, button_count, spacer_count;
1419 std::map<WidgetID, uint> lookup;
1420 for (
auto it = std::begin(this->
children); it != std::end(this->
children); ++it) {
1425 assert(nwc !=
nullptr);
1426 lookup[nwc->GetIndex()] = std::distance(this->
children.begin(), it);
1431 uint spacer_space = std::max(0, (
int)given_width - (
int)(button_count * this->
smallest_x));
1432 uint button_space = given_width - spacer_space;
1437 const WidgetID *slotp = rtl ? &arrangement[arrangeable_count - 1] : arrangement;
1438 for (uint i = 0; i < arrangeable_count; i++) {
1439 uint slot = lookup[*slotp];
1440 auto &child_wid = this->
children[slot];
1442 if (spacer_space > 0 && slot > 0 && slot < this->
children.size() - 1) {
1443 const auto &possible_spacer = this->
children[slot + (rtl ? 1 : -1)];
1444 if (possible_spacer !=
nullptr && possible_spacer->type ==
NWID_SPACER) {
1445 uint add = spacer_space / (spacer_count - spacer_i);
1447 spacer_space -= add;
1453 if (this->
IsButton(child_wid->type)) {
1454 child_wid->current_x = button_space / (button_count - button_i);
1455 button_space -= child_wid->current_x;
1458 child_wid->current_x = child_wid->smallest_x;
1460 child_wid->AssignSizePosition(sizing, x + position, y, child_wid->current_x, this->current_y, rtl);
1461 position += child_wid->current_x;
1474 const Rect r = this->GetCurrentRect();
1496 static const uint SMALLEST_ARRANGEMENT = 14;
1497 static const uint BIGGEST_ARRANGEMENT = 20;
1505 static const WidgetID arrange14[] = {
1536 static const WidgetID arrange15[] = {
1569 static const WidgetID arrange16[] = {
1604 static const WidgetID arrange17[] = {
1641 static const WidgetID arrange18[] = {
1680 static const WidgetID arrange19[] = {
1721 static const WidgetID arrange20[] = {
1764 static const WidgetID arrange_all[] = {
1798 uint full_buttons = std::max(
CeilDiv(width, this->
smallest_x), SMALLEST_ARRANGEMENT);
1799 if (full_buttons > BIGGEST_ARRANGEMENT) {
1800 button_count = arrangeable_count =
lengthof(arrange_all);
1806 static const WidgetID *
const arrangements[] = { arrange14, arrange15, arrange16, arrange17, arrange18, arrange19, arrange20 };
1808 button_count = arrangeable_count = full_buttons;
1810 return arrangements[full_buttons - SMALLEST_ARRANGEMENT] + ((_toolbar_mode == TB_LOWER) ? full_buttons : 0);
1824 for (
const auto &child_wid : this->
children) {
1825 if (child_wid->type ==
NWID_SPACER || this->IsButton(child_wid->type))
continue;
1828 *it = child_wid->current_x;
1836 static const WidgetID arrange_all[] = {
1857 static const WidgetID arrange_nopanel[] = {
1877 static const WidgetID arrange_switch[] = {
1905 if (width >= min_full_width) {
1907 arrangeable_count =
lengthof(arrange_all);
1908 button_count = arrangeable_count - 2;
1915 if (width > min_small_width) {
1917 arrangeable_count =
lengthof(arrange_nopanel);
1918 button_count = arrangeable_count - 1;
1919 spacer_count = this->
spacers - 1;
1920 return arrange_nopanel;
1925 arrangeable_count =
lengthof(arrange_switch) / 2;
1926 button_count = arrangeable_count - 1;
1928 return arrange_switch + ((_toolbar_mode == TB_LOWER) ? arrangeable_count : 0);
1936static ToolbarButtonProc *
const _toolbar_button_procs[] = {
1943 ToolbarSubsidiesClick,
1944 ToolbarStationsClick,
1945 ToolbarFinancesClick,
1946 ToolbarCompaniesClick,
1951 ToolbarIndustryClick,
1957 ToolbarZoomOutClick,
1958 ToolbarBuildRailClick,
1959 ToolbarBuildRoadClick,
1960 ToolbarBuildTramClick,
1961 ToolbarBuildWaterClick,
1962 ToolbarBuildAirClick,
1965 ToolbarNewspaperClick,
2006 if (_game_mode != GM_MENU && !this->
IsWidgetDisabled(widget)) _toolbar_button_procs[widget](
this);
2019 case MTHK_PAUSE: ToolbarPauseClick(
this);
break;
2025 case MTHK_TOWNDIRECTORY: ShowTownDirectory();
break;
2026 case MTHK_SUBSIDIES: ShowSubsidiesList();
break;
2032 case MTHK_GRAPHS: ShowOperatingProfitGraph();
break;
2033 case MTHK_LEAGUE: ShowFirstLeagueTable();
break;
2034 case MTHK_INDUSTRIES: ShowBuildIndustryWindow();
break;
2039 case MTHK_ZOOM_IN: ToolbarZoomInClick(
this);
break;
2040 case MTHK_ZOOM_OUT: ToolbarZoomOutClick(
this);
break;
2046 case MTHK_BUILD_TREES: ShowBuildTreesToolbar();
break;
2047 case MTHK_MUSIC: ShowMusicWindow();
break;
2056 case MTHK_CLIENT_LIST:
if (
_networking) ShowClientList();
break;
2058 case MTHK_LANDINFO: cbf = PlaceLandBlockInfo();
break;
2068 case CBF_PLACE_SIGN:
2072 case CBF_PLACE_LANDINFO:
2076 default: NOT_REACHED();
2103 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
2105 if (!gui_scope)
return;
2109 static inline HotkeyList hotkeys{
"maintoolbar", {
2110 Hotkey({WKC_F1, WKC_PAUSE},
"pause", MTHK_PAUSE),
2111 Hotkey(0,
"fastforward", MTHK_FASTFORWARD),
2112 Hotkey(WKC_F2,
"settings", MTHK_SETTINGS),
2113 Hotkey(WKC_F3,
"saveload", MTHK_SAVEGAME),
2114 Hotkey(0,
"load_game", MTHK_LOADGAME),
2115 Hotkey({WKC_F4,
'M'},
"smallmap", MTHK_SMALLMAP),
2116 Hotkey(WKC_F5,
"town_list", MTHK_TOWNDIRECTORY),
2117 Hotkey(WKC_F6,
"subsidies", MTHK_SUBSIDIES),
2118 Hotkey(WKC_F7,
"station_list", MTHK_STATIONS),
2119 Hotkey(WKC_F8,
"finances", MTHK_FINANCES),
2120 Hotkey(WKC_F9,
"companies", MTHK_COMPANIES),
2121 Hotkey(0,
"story_book", MTHK_STORY),
2122 Hotkey(0,
"goal_list", MTHK_GOAL),
2123 Hotkey(WKC_F10,
"graphs", MTHK_GRAPHS),
2124 Hotkey(WKC_F11,
"league", MTHK_LEAGUE),
2125 Hotkey(WKC_F12,
"industry_list", MTHK_INDUSTRIES),
2126 Hotkey(WKC_SHIFT | WKC_F1,
"train_list", MTHK_TRAIN_LIST),
2127 Hotkey(WKC_SHIFT | WKC_F2,
"roadveh_list", MTHK_ROADVEH_LIST),
2128 Hotkey(WKC_SHIFT | WKC_F3,
"ship_list", MTHK_SHIP_LIST),
2129 Hotkey(WKC_SHIFT | WKC_F4,
"aircraft_list", MTHK_AIRCRAFT_LIST),
2132 Hotkey(WKC_SHIFT | WKC_F7,
"build_rail", MTHK_BUILD_RAIL),
2133 Hotkey(WKC_SHIFT | WKC_F8,
"build_road", MTHK_BUILD_ROAD),
2134 Hotkey(0,
"build_tram", MTHK_BUILD_TRAM),
2135 Hotkey(WKC_SHIFT | WKC_F9,
"build_docks", MTHK_BUILD_DOCKS),
2136 Hotkey(WKC_SHIFT | WKC_F10,
"build_airport", MTHK_BUILD_AIRPORT),
2137 Hotkey(WKC_SHIFT | WKC_F11,
"build_trees", MTHK_BUILD_TREES),
2138 Hotkey(WKC_SHIFT | WKC_F12,
"music", MTHK_MUSIC),
2139 Hotkey(0,
"ai_debug", MTHK_SCRIPT_DEBUG),
2140 Hotkey(WKC_CTRL |
'S',
"small_screenshot", MTHK_SMALL_SCREENSHOT),
2141 Hotkey(WKC_CTRL |
'P',
"zoomedin_screenshot", MTHK_ZOOMEDIN_SCREENSHOT),
2142 Hotkey(WKC_CTRL |
'D',
"defaultzoom_screenshot", MTHK_DEFAULTZOOM_SCREENSHOT),
2143 Hotkey(0,
"giant_screenshot", MTHK_GIANT_SCREENSHOT),
2144 Hotkey(WKC_CTRL | WKC_ALT |
'C',
"cheats", MTHK_CHEATS),
2145 Hotkey(
'L',
"terraform", MTHK_TERRAFORM),
2146 Hotkey(
'V',
"extra_viewport", MTHK_EXTRA_VIEWPORT),
2147 Hotkey(0,
"client_list", MTHK_CLIENT_LIST),
2148 Hotkey(0,
"sign_list", MTHK_SIGN_LIST),
2149 Hotkey(0,
"land_info", MTHK_LANDINFO),
2156 static const std::tuple<WidgetID, WidgetType, SpriteID> toolbar_button_sprites[] = {
2190 auto hor = std::make_unique<NWidgetMainToolbarContainer>();
2191 for (
const auto &[widget, tp, sprite] : toolbar_button_sprites) {
2199 hor->Add(std::make_unique<NWidgetSpacer>(0, 0));
2202 auto leaf = std::make_unique<NWidgetLeaf>(tp, COLOUR_GREY, widget,
WidgetData{.sprite = sprite}, STR_TOOLBAR_TOOLTIP_PAUSE_GAME + widget);
2203 leaf->SetMinimalSize(20, 20);
2204 hor->Add(std::move(leaf));
2210static constexpr NWidgetPart _nested_toolbar_normal_widgets[] = {
2218 _nested_toolbar_normal_widgets,
2219 &MainToolbarWindow::hotkeys
2225static MenuClickedProc *
const _scen_toolbar_dropdown_procs[] = {
2251static ToolbarButtonProc *
const _scen_toolbar_button_procs[] = {
2258 ToolbarScenDateBackward,
2259 ToolbarScenDateForward,
2260 ToolbarScenMapTownDir,
2262 ToolbarZoomOutClick,
2264 ToolbarScenGenTownClick,
2265 ToolbarScenGenIndustry,
2266 ToolbarScenBuildRoadClick,
2267 ToolbarScenBuildTramClick,
2268 ToolbarScenBuildDocks,
2269 ToolbarScenPlantTrees,
2270 ToolbarScenPlaceSign,
2277enum MainToolbarEditorHotkeys : int32_t {
2292 MTEHK_SMALL_SCREENSHOT,
2293 MTEHK_ZOOMEDIN_SCREENSHOT,
2294 MTEHK_DEFAULTZOOM_SCREENSHOT,
2295 MTEHK_GIANT_SCREENSHOT,
2300 MTEHK_EXTRA_VIEWPORT,
2371 if (_game_mode == GM_MENU)
return;
2387 case MTEHK_PAUSE: ToolbarPauseClick(
this);
break;
2391 case MTEHK_GENLAND: ToolbarScenGenLand(
this);
break;
2392 case MTEHK_GENTOWN: ToolbarScenGenTownClick(
this);
break;
2393 case MTEHK_GENINDUSTRY: ToolbarScenGenIndustry(
this);
break;
2394 case MTEHK_BUILD_ROAD: ToolbarScenBuildRoadClick(
this);
break;
2395 case MTEHK_BUILD_TRAM: ToolbarScenBuildTramClick(
this);
break;
2396 case MTEHK_BUILD_DOCKS: ToolbarScenBuildDocks(
this);
break;
2397 case MTEHK_BUILD_TREES: ToolbarScenPlantTrees(
this);
break;
2398 case MTEHK_SIGN: cbf = ToolbarScenPlaceSign(
this);
break;
2399 case MTEHK_MUSIC: ShowMusicWindow();
break;
2400 case MTEHK_LANDINFO: cbf = PlaceLandBlockInfo();
break;
2405 case MTEHK_ZOOM_IN: ToolbarZoomInClick(
this);
break;
2406 case MTEHK_ZOOM_OUT: ToolbarZoomOutClick(
this);
break;
2419 case CBF_PLACE_SIGN:
2423 case CBF_PLACE_LANDINFO:
2427 default: NOT_REACHED();
2461 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
2463 if (!gui_scope)
return;
2470 if (!str.has_value())
return;
2473 if (!str->empty()) {
2475 if (!val.has_value())
return;
2486 static inline HotkeyList hotkeys{
"scenedit_maintoolbar", {
2487 Hotkey({WKC_F1, WKC_PAUSE},
"pause", MTEHK_PAUSE),
2488 Hotkey(0,
"fastforward", MTEHK_FASTFORWARD),
2489 Hotkey(WKC_F2,
"settings", MTEHK_SETTINGS),
2490 Hotkey(WKC_F3,
"saveload", MTEHK_SAVEGAME),
2491 Hotkey(WKC_F4,
"gen_land", MTEHK_GENLAND),
2492 Hotkey(WKC_F5,
"gen_town", MTEHK_GENTOWN),
2493 Hotkey(WKC_F6,
"gen_industry", MTEHK_GENINDUSTRY),
2494 Hotkey(WKC_F7,
"build_road", MTEHK_BUILD_ROAD),
2495 Hotkey(0,
"build_tram", MTEHK_BUILD_TRAM),
2496 Hotkey(WKC_F8,
"build_docks", MTEHK_BUILD_DOCKS),
2497 Hotkey(WKC_F9,
"build_trees", MTEHK_BUILD_TREES),
2498 Hotkey(WKC_F10,
"build_sign", MTEHK_SIGN),
2499 Hotkey(WKC_F11,
"music", MTEHK_MUSIC),
2500 Hotkey(WKC_F12,
"land_info", MTEHK_LANDINFO),
2501 Hotkey(WKC_CTRL |
'S',
"small_screenshot", MTEHK_SMALL_SCREENSHOT),
2502 Hotkey(WKC_CTRL |
'P',
"zoomedin_screenshot", MTEHK_ZOOMEDIN_SCREENSHOT),
2503 Hotkey(WKC_CTRL |
'D',
"defaultzoom_screenshot", MTEHK_DEFAULTZOOM_SCREENSHOT),
2504 Hotkey(0,
"giant_screenshot", MTEHK_GIANT_SCREENSHOT),
2507 Hotkey(
'L',
"terraform", MTEHK_TERRAFORM),
2508 Hotkey(
'M',
"smallmap", MTEHK_SMALLMAP),
2509 Hotkey(
'V',
"extra_viewport", MTEHK_EXTRA_VIEWPORT),
2513static constexpr NWidgetPart _nested_toolb_scen_inner_widgets[] = {
2548static std::unique_ptr<NWidgetBase> MakeScenarioToolbar()
2550 return MakeNWidgets(_nested_toolb_scen_inner_widgets, std::make_unique<NWidgetScenarioToolbarContainer>());
2553static constexpr NWidgetPart _nested_toolb_scen_widgets[] = {
2561 _nested_toolb_scen_widgets,
2562 &ScenarioEditorToolbarWindow::hotkeys
2572 if (_game_mode == GM_EDITOR) {
void ShowAIConfigWindow()
Open the AI config window.
Window for configuring the AIs
Window * ShowBuildAirToolbar()
Open the build airport toolbar window.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T ToggleBit(T &x, const uint8_t y)
Toggles a bit in a variable.
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 bool None() const
Test if none of the values are set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Flip(Tvalue_type value)
Flip the value-th bit.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Drop down icon component.
Company name list item, with company-colour icon, name, and lock components.
An interval timer will fire every interval, and will continue to fire until it is deleted.
static LinkGraphSchedule instance
Static instance of LinkGraphSchedule.
void ShiftDates(TimerGameEconomy::Date interval)
Shift all dates (join dates and edge annotations) of link graphs and link graph jobs by the number of...
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.
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
The default starting year.
static constexpr TimerGame< struct Calendar >::Year MIN_YEAR
The absolute minimum year in OTTD.
static constexpr TimerGame< struct Calendar >::Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
static Date date
Current date in days (day counter).
static void SetDate(Date date, DateFract fract)
Set the 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.
Window * ShowBuildDocksToolbar()
Open the build water toolbar window.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
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.
@ SLO_SAVE
File is being saved.
@ SLO_LOAD
File is being loaded.
@ FT_SCENARIO
old or new scenario
@ FT_HEIGHTMAP
heightmap file
@ FT_SAVEGAME
old or new savegame
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.
Types for recording game performance data.
Base functions for all Games.
void ShowGSConfigWindow()
Open the GS config window.
Window for configuring the Games
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
bool _ctrl_pressed
Is Ctrl pressed?
bool _left_button_clicked
Is left mouse button clicked?
uint16_t _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
PauseModes _pause_mode
The current pause mode.
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.
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
@ FS_NORMAL
Index of the normal font in the font tables.
@ SA_HOR_CENTER
Horizontally center the text.
@ SA_CENTER
Center both horizontally and vertically.
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
void ShowGoalsList(CompanyID company)
Open a goal list window.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
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.
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.
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.
definition of HouseSpec and accessors
League table GUI functions.
void ShowLinkGraphLegend()
Open a link graph legend window.
Declaration of linkgraph overlay GUI.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
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.
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?
bool _network_server
network-server is active
bool NetworkCanJoinCompany(CompanyID company_id)
Returns whether the given company can be joined by this client.
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.
GUIs related to networking.
@ CLIENT_ID_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.
Functions/types related to NewGRF debugging.
void ShowSpriteAlignerWindow()
Show the window for aligning sprites.
void ShowLastNewsMessage()
Show previous news item.
void ShowMessageHistory()
Display window with news messages history.
GUI functions related to the news.
@ DO_SHOW_TOWN_NAMES
Display town names.
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
@ DO_FULL_DETAIL
Also draw details of track and roads.
@ DO_SHOW_SIGNS
Display signs.
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
@ DO_SHOW_STATION_NAMES
Display station names.
@ DO_FULL_ANIMATION
Perform palette animation.
@ Normal
A game normally paused.
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.
DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
Create a drop down list for all the rail types of the local company.
RailType
Enumeration for all possible railtypes.
RoadTypes GetRoadTypes(bool introduces)
Get list of road types, regardless of company availability.
RoadTypes GetMaskForRoadTramType(RoadTramType rtt)
Get the mask for road types of the given RoadTramType.
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.
@ ROADTYPE_ROAD
Basic road type.
A number of safeguards to prevent using unsafe methods.
void MakeScreenshotWithConfirm(ScreenshotType t)
Make a screenshot.
Functions to make screenshots.
@ SC_VIEWPORT
Screenshot of viewport.
@ SC_ZOOMEDIN
Fully zoomed in screenshot of the visible area.
@ SC_WORLD
World screenshot.
@ SC_DEFAULTZOOM
Zoomed to default zoom level screenshot of the visible area.
GUI functions related to screenshots.
Window * ShowScriptDebugWindow(CompanyID show_company, bool new_window)
Open the Script debug window and select the given company.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
ClientSettings _settings_client
The current settings for this game.
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.
void SndConfirmBeep()
Play a beep sound for a confirm event if enabled in settings.
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Functions related to sound.
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.
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.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
GUISettings gui
settings related to the GUI
Dimensions (a width and height) of a rectangle in 2D.
TownFounding found_town
town founding.
PlaceHouses place_houses
players are allowed to place town houses.
bool UserIsAllowedToChangeNewGRFs() const
Returns true when the user has sufficient privileges to edit newgrfs on a running game.
bool toolbar_dropdown_autoselect
should toolbar dropdown buttons autoselect when releasing the mouse button
bool newgrf_developer_tools
activate NewGRF developer tools and allow modifying NewGRFs in an existing game
TimerGameCalendar::Year starting_year
starting date
EconomySettings economy
settings to change the economy
GameCreationSettings game_creation
settings used during the creation of a game (map)
List of hotkeys for a window.
All data for a single hotkey.
Struct about custom league tables.
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< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static size_t GetNumItems()
Returns number of valid items in the pool.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Specification of a rectangle with absolute coordinates of all edges.
int Height() const
Get height of Rect.
Templated helper to make a type-safe 'typedef' representing a single POD value.
High level window description.
Data structure for an opened window.
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
void DrawWidgets() const
Paint all widgets of a window.
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
uint8_t timeout_timer
Timer value of the WindowFlag::Timeout for flags.
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
ResizeInfo resize
Resize information.
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
virtual void FindWindowPlacementAndResize(int def_width, int def_height, bool allow_resize)
Resize window towards the default size.
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
WindowFlags flags
Window flags.
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
int height
Height of the window (number of pixels down in y direction)
int width
width of the window (number of pixels to the right in x direction)
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Stuff related to the text buffer GUI.
@ EnableDefault
enable the 'Default' button ("\0" is returned)
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.
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...
uint8_t _display_opt
What do we want to draw/do?
@ TO_HOUSES
town buildings
void ShowTransparencyToolbar()
Show the transparency toolbar.
GUI functions related to transparency.
Base class for all vehicles.
Functions related to vehicles.
Functions related to the vehicle's GUIs.
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_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.
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).
Window * GetMainWindow()
Get the main window, i.e.
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
void DeleteAllMessages()
Delete all messages and close their corresponding window (if any).
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...
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.
@ NoFocus
This window won't get focus/make any other window lose focus when click.
@ WhiteBorder
Window white border counter bit mask.
@ Timeout
Window timeout counter.
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_SIGN_LIST
Sign list; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
@ WC_MAIN_TOOLBAR
Main toolbar (the long bar at the top); Window numbers: