GE Lua Documentation

requestMainMenuState

Definition

-- @/lua/ge/extensions/core/gamestate.lua:47

-- UI state === to main menu or not to main menu
-- This is a state for the ui, so it knows if it should show the main menu or the side menu
-- important: this is not meant to change the router state, but only a variable change.
local function sendShowMainMenu ()
  -- TODO: check if getter setter is needed or if this is enough and always correct -yh
  local mainMenu = getMissionFilename() == ''
  log('D', logTag, 'show main menu (' .. tostring(mainMenu) .. ')')
  guihooks.trigger('ShowEntertainingBackground', mainMenu)

  return mainMenu
end

Callers

      bngApi.engineLua("settings.notifyUI()")
      bngApi.engineLua("core_gamestate.requestMainMenuState()")
      bngApi.engineLua("core_gamestate.requestGameState()")