GameStateTransitions Interface Reference

Static Public Member Functions
static proto bool	IsTransitionRequested ()
	Check whether transition to different game state has been requested this frame and will start next frame.
static proto bool	IsTransitionInProgress ()
	Check whether transition to different game state is currently happening.
static proto bool	IsTransitionRequestedOrInProgress ()
static proto bool	RequestPublicServerTransition (JsonApiStruct config)
	Request transition from main menu to hosted multiplayer session (registered in server browser).
static proto bool	RequestConnectViaRoom (Room room)
	Request transition from main menu to gameplay as client connected to server in multiplayer session.
static proto bool	RequestScenarioChangeTransition (ResourceName missionOrWorld, ResourceName worldSystemsConfig, string addonList)
	Request change of scenario.
static proto bool	RequestScenarioRestart ()
	Request restart of scenario in both SP and MP.
static proto bool	RequestServerConfigChange (notnull ServerConfigMeta configMeta)
	Request server config change and reload the game.
static proto void	RequestGameplayEndTransition (KickCauseCode code=KickCauseCode.NONE)
	Request transition from whatever is current multiplayer session mode back to main menu.
static proto void	RequestGameTerminateTransition ()
	Request graceful shut down of the game from whatever is current game state (eg. online vs. offline).
static proto bool	RequestStartEditorTransition (string resourceStr, string addonList, bool createSubScene=false)
static proto bool	RequestLoadEditorWorld (string resourceStr, bool createSubScene=false)
	Used when you are inside the editor, and you want to load a world.
static proto bool	RequestNewSubscene ()
	Used when you are inside the editor, and you want to create a subscene.
static proto bool	IsInsideMainMenu ()
	Return true if in main menu is loaded for the first time.
static proto bool	IsFirstMainMenu ()
	Return true if in main menu is loaded for the first time.

Member Function Documentation

IsFirstMainMenu()

static proto bool GameStateTransitions.IsFirstMainMenu ( )

static

Return true if in main menu is loaded for the first time.

IsInsideMainMenu()

static proto bool GameStateTransitions.IsInsideMainMenu ( )

static

Return true if in main menu is loaded for the first time.

IsTransitionInProgress()

static proto bool GameStateTransitions.IsTransitionInProgress ( )

static

Check whether transition to different game state is currently happening.

IsTransitionRequested()

static proto bool GameStateTransitions.IsTransitionRequested ( )

static

Check whether transition to different game state has been requested this frame and will start next frame.

IsTransitionRequestedOrInProgress()

static proto bool GameStateTransitions.IsTransitionRequestedOrInProgress ( )

static

RequestConnectViaRoom()

static proto bool GameStateTransitions.RequestConnectViaRoom ( Room room )

static

Request transition from main menu to gameplay as client connected to server in multiplayer session.

RequestGameplayEndTransition()

static proto void GameStateTransitions.RequestGameplayEndTransition ( KickCauseCode code = KickCauseCode.NONE )

static

Request transition from whatever is current multiplayer session mode back to main menu.

RequestGameTerminateTransition()

static proto void GameStateTransitions.RequestGameTerminateTransition ( )

static

Request graceful shut down of the game from whatever is current game state (eg. online vs. offline).

RequestLoadEditorWorld()

static proto bool GameStateTransitions.RequestLoadEditorWorld ( string resourceStr, bool createSubScene = false )

static

Used when you are inside the editor, and you want to load a world.

RequestNewSubscene()

static proto bool GameStateTransitions.RequestNewSubscene ( )

static

Used when you are inside the editor, and you want to create a subscene.

RequestPublicServerTransition()

static proto bool GameStateTransitions.RequestPublicServerTransition ( JsonApiStruct config )

static

Request transition from main menu to hosted multiplayer session (registered in server browser).

RequestScenarioChangeTransition()

static proto bool GameStateTransitions.RequestScenarioChangeTransition ( ResourceName missionOrWorld, ResourceName worldSystemsConfig, string addonList )

static

Request change of scenario.

Parameters

missionOrWorld	MissionHeader or World resource to transition into.
worldSystemsConfig	Config file for initializing world systems. Leave empty to use default.
addonList	List of addons to load. Leave empty for vanilla.

RequestScenarioRestart()

static proto bool GameStateTransitions.RequestScenarioRestart ( )

static

Request restart of scenario in both SP and MP.

Must be called on server in case of MP game.

RequestServerConfigChange()

static proto bool GameStateTransitions.RequestServerConfigChange ( notnull ServerConfigMeta configMeta )

static

Request server config change and reload the game.

RequestStartEditorTransition()

static proto bool GameStateTransitions.RequestStartEditorTransition ( string resourceStr, string addonList, bool createSubScene = false )

static

---

The documentation for this interface was generated from the following file:

• Game/generated/GameStateTransitions/GameStateTransitions.c