index / content / gui / menu / main_menu

Module content.gui.menu.main_menu🔗

global record CampaignParam campaign: string mission: string showEditorsNote: boolean end
global record CommonMenuParams setPage: function(Page, any) windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI> calloutContainerRef: ReactRefWrapApi0<CalloutApi> setBlockedForModal: function(boolean) onClose: function() inGame: boolean getDLCModState: function(): GameEditionTextParam triggerBackgroundEvent: function(Vec2f, boolean, boolean, boolean, boolean) triggerBackgroundEventBig: function(Vec2f)
enum FadeInMode "FadeIn" "Invisible" end
fadeIn: FadeInMode end
global record GameEditionTextParam hasDeluxeDLC: boolean hasPreorderDLC: boolean end
global record GroupId name: string prefix: string end
global interface IMenuPageParam commonParams: CommonMenuParams
interface ISpecificParamend
params: ISpecificParam end
global record MenuPageParam<P is IMenuPageParam.ISpecificParam> is IMenuPageParamend
global record MissionPageContentParam campaign: string mission: string onLoad: function(function()) end
global enum NewOrLoadPage "NewOrLoadAdvanced" "NewOrLoadMain" "NewOrLoadMods" end
global enum Page "Achievements" "Campaign" "Credits" "LicensePage" "LoadGame" "Main" "MapEditor" "ModManager" "NewGame" "NewGameOrMapSettings" "ProgressPage" "ReleaseNotes" "SaveGame" "Settings" "Tutorial" end
global record ProgressData mission: ResName saveGameId: SaveGameId end
global record ProgressPageMissionParam mission: ResName saveGameId: SaveGameId onMount: function() end
global record ReleaseNoteData
record InfoItem title: string description: string image: string preferShaderQuadOverImage: boolean leftImage: boolean filterOutVendor: {string} filterOutPlatform: {string} alignment: string scrollable: boolean end
infoItemsPerPage: integer updateMessageID: integer title: string infoItems: {InfoItem} end
global record SaveGroup mostRecent: SaveGameInfo mostRecentIndex: integer saves: {SaveGameInfo} groupName: GroupId end

Category: globals🔗

CampaignParam🔗

global record CampaignParam campaign: string mission: string showEditorsNote: boolean end

CampaignParam.campaign🔗

CampaignParam.campaign: string

CampaignParam.mission🔗

CampaignParam.mission: string

CampaignParam.showEditorsNote🔗

CampaignParam.showEditorsNote: boolean

CommonMenuParams🔗

global record CommonMenuParams setPage: function(Page, any) windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI> calloutContainerRef: ReactRefWrapApi0<CalloutApi> setBlockedForModal: function(boolean) onClose: function() inGame: boolean getDLCModState: function(): GameEditionTextParam triggerBackgroundEvent: function(Vec2f, boolean, boolean, boolean, boolean) triggerBackgroundEventBig: function(Vec2f)
enum FadeInMode "FadeIn" "Invisible" end
fadeIn: FadeInMode end

CommonMenuParams.setPage🔗

function CommonMenuParams.setPage(Page, any)
Parameters
  • Page
  • any

CommonMenuParams.windowContainer🔗

CommonMenuParams.windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>

CommonMenuParams.calloutContainerRef🔗

CommonMenuParams.calloutContainerRef: ReactRefWrapApi0<CalloutApi>

CommonMenuParams.setBlockedForModal🔗

function CommonMenuParams.setBlockedForModal(boolean)
Parameters
  • boolean

CommonMenuParams.onClose🔗

function CommonMenuParams.onClose()

CommonMenuParams.inGame🔗

CommonMenuParams.inGame: boolean

CommonMenuParams.getDLCModState🔗

function CommonMenuParams.getDLCModState(): GameEditionTextParam
Returns
  1. GameEditionTextParam

CommonMenuParams.triggerBackgroundEvent🔗

function CommonMenuParams.triggerBackgroundEvent(Vec2f, boolean, boolean, boolean, boolean)
Parameters
  • Vec2f
  • boolean
  • boolean
  • boolean
  • boolean

CommonMenuParams.triggerBackgroundEventBig🔗

function CommonMenuParams.triggerBackgroundEventBig(Vec2f)
Parameters
  • Vec2f

CommonMenuParams.FadeInMode🔗

enum CommonMenuParams.FadeInMode "FadeIn" "Invisible" end

CommonMenuParams.FadeInMode."FadeIn"🔗

CommonMenuParams.FadeInMode."Invisible"🔗

CommonMenuParams.fadeIn🔗

CommonMenuParams.fadeIn: FadeInMode

GameEditionTextParam🔗

global record GameEditionTextParam hasDeluxeDLC: boolean hasPreorderDLC: boolean end

GameEditionTextParam.hasDeluxeDLC🔗

GameEditionTextParam.hasDeluxeDLC: boolean

GameEditionTextParam.hasPreorderDLC🔗

GameEditionTextParam.hasPreorderDLC: boolean

GroupId🔗

global record GroupId name: string prefix: string end

GroupId.name🔗

GroupId.name: string

GroupId.prefix🔗

GroupId.prefix: string

IMenuPageParam🔗

global interface IMenuPageParam commonParams: CommonMenuParams
interface ISpecificParamend
params: ISpecificParam end

IMenuPageParam.commonParams🔗

IMenuPageParam.commonParams: CommonMenuParams

IMenuPageParam.ISpecificParam🔗

interface IMenuPageParam.ISpecificParamend

IMenuPageParam.params🔗

IMenuPageParam.params: ISpecificParam

MenuPageParam🔗

global record MenuPageParam<P is IMenuPageParam.ISpecificParam> is IMenuPageParamend
Type Parameters
  • P ( is IMenuPageParam.ISpecificParam)

MissionPageContentParam🔗

global record MissionPageContentParam campaign: string mission: string onLoad: function(function()) end

MissionPageContentParam.campaign🔗

MissionPageContentParam.campaign: string

MissionPageContentParam.mission🔗

MissionPageContentParam.mission: string

MissionPageContentParam.onLoad🔗

function MissionPageContentParam.onLoad(function())
Parameters
  • function()

NewOrLoadPage🔗

global enum NewOrLoadPage "NewOrLoadAdvanced" "NewOrLoadMain" "NewOrLoadMods" end

NewOrLoadPage."NewOrLoadAdvanced"🔗

NewOrLoadPage."NewOrLoadMain"🔗

NewOrLoadPage."NewOrLoadMods"🔗

Page🔗

global enum Page "Achievements" "Campaign" "Credits" "LicensePage" "LoadGame" "Main" "MapEditor" "ModManager" "NewGame" "NewGameOrMapSettings" "ProgressPage" "ReleaseNotes" "SaveGame" "Settings" "Tutorial" end

Page."Achievements"🔗

Page."Campaign"🔗

Page."Credits"🔗

Page."LicensePage"🔗

Page."LoadGame"🔗

Page."Main"🔗

Page."MapEditor"🔗

Page."ModManager"🔗

Page."NewGame"🔗

Page."NewGameOrMapSettings"🔗

Page."ProgressPage"🔗

Page."ReleaseNotes"🔗

Page."SaveGame"🔗

Page."Settings"🔗

Page."Tutorial"🔗

ProgressData🔗

global record ProgressData mission: ResName saveGameId: SaveGameId end

ProgressData.mission🔗

ProgressData.mission: ResName

ProgressData.saveGameId🔗

ProgressData.saveGameId: SaveGameId

ProgressPageMissionParam🔗

global record ProgressPageMissionParam mission: ResName saveGameId: SaveGameId onMount: function() end

ProgressPageMissionParam.mission🔗

ProgressPageMissionParam.mission: ResName

ProgressPageMissionParam.saveGameId🔗

ProgressPageMissionParam.saveGameId: SaveGameId

ProgressPageMissionParam.onMount🔗

function ProgressPageMissionParam.onMount()

ReleaseNoteData🔗

global record ReleaseNoteData
record InfoItem title: string description: string image: string preferShaderQuadOverImage: boolean leftImage: boolean filterOutVendor: {string} filterOutPlatform: {string} alignment: string scrollable: boolean end
infoItemsPerPage: integer updateMessageID: integer title: string infoItems: {InfoItem} end

ReleaseNoteData.InfoItem🔗

record ReleaseNoteData.InfoItem title: string description: string image: string preferShaderQuadOverImage: boolean leftImage: boolean filterOutVendor: {string} filterOutPlatform: {string} alignment: string scrollable: boolean end

ReleaseNoteData.InfoItem.title🔗

ReleaseNoteData.InfoItem.title: string

ReleaseNoteData.InfoItem.description🔗

ReleaseNoteData.InfoItem.description: string

ReleaseNoteData.InfoItem.image🔗

ReleaseNoteData.InfoItem.image: string

ReleaseNoteData.InfoItem.preferShaderQuadOverImage🔗

ReleaseNoteData.InfoItem.preferShaderQuadOverImage: boolean

ReleaseNoteData.InfoItem.leftImage🔗

ReleaseNoteData.InfoItem.leftImage: boolean

ReleaseNoteData.InfoItem.filterOutVendor🔗

ReleaseNoteData.InfoItem.filterOutVendor: {string}

ReleaseNoteData.InfoItem.filterOutPlatform🔗

ReleaseNoteData.InfoItem.filterOutPlatform: {string}

ReleaseNoteData.InfoItem.alignment🔗

ReleaseNoteData.InfoItem.alignment: string

ReleaseNoteData.InfoItem.scrollable🔗

ReleaseNoteData.InfoItem.scrollable: boolean

ReleaseNoteData.infoItemsPerPage🔗

ReleaseNoteData.infoItemsPerPage: integer

ReleaseNoteData.updateMessageID🔗

ReleaseNoteData.updateMessageID: integer

ReleaseNoteData.title🔗

ReleaseNoteData.title: string

ReleaseNoteData.infoItems🔗

ReleaseNoteData.infoItems: {InfoItem}

SaveGroup🔗

global record SaveGroup mostRecent: SaveGameInfo mostRecentIndex: integer saves: {SaveGameInfo} groupName: GroupId end

SaveGroup.mostRecent🔗

SaveGroup.mostRecent: SaveGameInfo

SaveGroup.mostRecentIndex🔗

SaveGroup.mostRecentIndex: integer

SaveGroup.saves🔗

SaveGroup.saves: {SaveGameInfo}

SaveGroup.groupName🔗

SaveGroup.groupName: GroupId
Transport Fever 3 Wiki
Gameplay ReferenceComing soon
●
Modding Manual
  • api
  • api.cmd
  • api.engine
  • api.engine.system
  • api.engine.util
  • api.gui
  • api.res
  • api.type
  • api.type.mod
  • api.type.modhub
  • api.type.transformator
  • app
  • main
  • content
    • base
      • difficulty_util
      • model_metadata_util
      • post_run_util
    • climates
      • gen
        • map_gen_util_serialized
    • game_mechanics
      • achievements
        • sound
          • achievement_sfx
      • celebrations
        • celebration_react_util
        • gui
          • sound
            • celebration_sfx
      • company
        • company
        • company_metadata
        • company_progression_util
        • company_react_util
        • company_static_util
        • company_util
        • explorations
          • exploration_plane
        • prospection_metadata
        • sound
          • company_sfx
      • emission
        • emission_config_metadata
        • emission_metadata
        • emissions
      • finance
        • account
        • finances_react_util
        • finances_util
        • loan
        • loan_util
        • sound
          • finance_sfx
      • fun_elements
        • blimp_util
        • custom_entity_util
        • fun_elements
        • rocket_util
        • ufo_util
      • game_time
        • game_time
      • industries
        • industries
      • notifications
        • gui
          • notification_colors
          • sound
            • notification_sfx
        • notification_legacy_util
        • notification_util
        • notifications
        • types
          • notification_react_util
          • notification_types
      • subventions
        • specific_subvention
        • subvention
        • subvention_legacy_util
        • subvention_util
        • subventions_gui
      • towns
        • district_colors
        • sound
          • town_sfx
        • town_cargo
        • town_growth_metadata
        • town_marketing_metadata
        • town_react_util
        • town_util
        • town_util_parallel
        • towns
    • gui
      • construction
        • construction_colors
        • construction_desc_react_util
        • construction_menu
        • construction_react_util
        • sound
          • construction_sfx
        • track_description_metadata
        • track_modifier_metadata
      • context_helper
        • context_helper
      • entity_window
        • animal
          • animal_eow
        • empty_construction
          • empty_construction_eow
        • entity_window_hud
        • entity_window_util
        • eow_extension_util
        • fun_elements
          • fun_elements_eow
        • gameplay_colors
        • industry
          • industry_eow
        • industry_react_util
        • line
          • line_eow
        • maintenance_station
          • maintenance_station_eow
        • perk
          • perk_eow
        • sim_person
          • sim_person_eow
        • station_group
          • station_group_eow
        • town
          • town_eow
        • town_building
          • town_building_eow
        • vehicle
          • vehicle_eow
        • view_manager
        • view_manager_util
        • warehouse
          • warehouse_eow
      • game_bar
        • game_bar
        • game_bar_widgets
      • guidesystem
        • sound
          • guidesystem_sfx
      • hud
        • hud_gui_config
        • hud_react_util
      • layers
        • layer_cargo
        • layer_cargo_flow
        • layer_colors
        • layer_noise
        • layer_pollution
        • layer_public_transport
        • layer_react_util
        • layer_traffic
        • layers_button_ridge
      • line_vehicle_mgmt
        • cargofilter_window
        • feedback_list_util
        • line
        • line_react_util
        • line_util
        • manager_hud_util
        • manager_tooltips_util
        • manager_window
        • sound
          • lvm_sfx
        • vehicle_list_react_util
        • vehicle_react_util
        • vehicle_store
        • vehicle_store_table
        • vehicle_store_util
        • vehicle_store_window
        • vehicle_util
      • main
        • button_react_util
        • callout_react_util
        • cargo_react_util
        • cargo_util
        • collapsible_checkbox_list
        • content_card
        • credits_react_util
        • default_colors
        • disable_features
        • engine_react_util
        • free_cam_options
        • game_context
        • game_react_globals
        • game_tooltips
        • game_windows
        • gui_react_util
        • gui_res_modding
        • hud_icon_toolbox
        • industry_util
        • input_action_colors
        • main_mod_button_area
        • menu_category_util
        • mod_entry_point
        • particle_colors
        • particle_react_util
        • popover_react_util
        • radial_menu_extension
        • script_param_util
        • selection_colors
        • selector
        • selector_react_util
        • styleutil
        • tile_list_react_util
        • tool_react_util
        • town_hud_react_util
      • map_editor
        • map_editor
      • menu
        • dialog_react_util
        • difficulty_react_util
        • graphics_presets_util
        • main_menu
        • map_preview_colors
        • menu_icon_react_util
        • menu_util
        • mod_colors
        • mod_manager_react_util
        • mod_util
        • new_game_react_util
        • paradox_react_util
        • releasenotes_util
        • savegame_react_util
        • sound
          • main_menu_sfx
      • sound
        • gui_comp_sfx
      • statistics
        • statistics
        • statistics_react_util
    • industries
      • industry_productivity_util
      • industry_workers
    • infrastructure
      • traffic_light
        • traffic_light
    • landmarks
      • hq
        • headquarter_util_serialized
      • landmark
      • landmark_util
      • landmark_util_serialized
    • mission
      • arrival_tracker
      • builder_util
      • calendar
      • guide_system
        • guide_system_react
        • guides
          • guide_event
          • guide_generic
          • guide_state
          • guide_timer
          • guide_ui_event
      • mission_boot_util
      • mission_colors
      • mission_framework
        • mission_end_window_util
        • mission_framework_react
        • mission_framework_react_util
        • mission_framework_util
        • mission_framework_util_entity
        • mission_framework_util_line
        • mission_interface
      • mission_pathfinding_util
      • mission_react_util
      • mission_task_util
      • mission_types
      • modifier
      • name_util
      • tasks
        • assign_vehicle
          • mission_task_assign_vehicle
          • mission_task_visit_stations_ordered
        • auto_builder
          • mission_task_electrify
          • mission_task_track_builder
          • prepare_track_building_util
        • build_construction
          • mission_task_build_construction
          • mission_task_build_construction_util
          • mission_task_build_construction_variant
        • build_path
          • mission_task_build_path
        • bulldoze
          • mission_task_auto_bulldoze
          • mission_task_bulldoze
        • buy_vehicle
          • mission_task_buy_vehicle
          • mission_task_clone_vehicle
        • click_and_collect_custom_entity
          • mission_task_collect_entity
          • mission_task_spawn_entity
        • click_entity
          • mission_task_click_entity
        • connect_nodes
          • mission_task_connect_nodes
        • create_line
          • mission_task_create_line
          • mission_task_create_line_for_towns
          • mission_task_stop_config
        • cutscene
          • mission_task_cutscene
        • dialogue
          • mission_task_dialogue
        • finish
          • mission_task_finish
        • guide
          • mission_task_guide
          • mission_task_guide_collect_entity
        • join
          • mission_task_join
        • mission_dialogue_data
        • non_bulldozable
          • mission_task_non_bulldozable
        • observe_entity
          • mission_task_observe_entity
        • page
          • mission_task_page
        • spawn_sims
          • mission_task_spawn_sims
          • sampling_util
        • subsidies
          • mission_task_guide_subsidies
          • mission_task_subsidies
        • task_decorator
        • town_rating
          • mission_task_town_rating
          • mission_task_town_rating_observer
        • town_size
          • mission_task_town_size
        • transfer_ownership
          • mission_task_transfer_ownership
          • transfer_ownership_util
        • transport_cargo
          • mission_task_empty_stocks
          • mission_task_industry_boosted
          • mission_task_transport_cargo
          • mission_task_transport_cargo_faster
          • mission_task_transport_cargo_observer
          • mission_task_transport_passengers
        • utility
          • mission_task_cargo_needs
          • mission_task_check_entities
          • mission_task_check_landmark_level
          • mission_task_clouds
          • mission_task_highlight
          • mission_task_industry_activity
          • mission_task_landmark_requirements
          • mission_task_play_sound
          • mission_task_protected_entities
          • mission_task_relay_update
          • mission_task_send_command
          • mission_task_send_event
          • mission_task_store_any
          • mission_task_substitute_constructions
          • mission_task_time_of_day
          • mission_task_town_development
          • mission_town_util
        • vehicle_util
          • mission_task_replace_vehicles
          • mission_task_sell_vehicles
          • mission_task_start_vehicles
          • mission_task_vehicle_modifier
          • mission_task_vehicle_position
          • mission_vehicle_util
        • wait
          • mission_task_wait
          • mission_task_wait_event
          • mission_task_wait_for
          • mission_task_wait_ui_event
        • waypoints
          • mission_task_waypoints
      • tutorial
        • tasks
          • mission_task_tutorial_init
        • tutorial_story_util
    • scripts
      • app_util
      • audio_util
      • builtin
      • construction
        • asset_util
        • collider_util_serialized
        • construction_config_metadata
        • construction_specialization_metadata
        • construction_util_serialized
        • lane_util_serialized
        • modules_util_serialized
        • param_util
        • street_util_serialized
      • entity_util
      • gamescript
      • journal
      • lang_util
      • log
      • mat4
      • math_util
      • metadata_util
      • polygon_util
      • random_util
      • react
      • soundset
      • string_util
      • table_util
      • tex_util
      • transformator_util
      • util
        • config_util
        • listutil
        • romberg_util
        • town_growth_function
      • vec2
      • vec3
      • vec4
    • stations
      • station_metadata
    • vehicle
      • vehicle_modifier

Generated 19-08-2026

Transport Fever 3 ● Urban Games © 2026