Set UI Layout (Flowgraph Node)

Overview

• Node Name: Set UI Layout
• Category: once_instant
• File: extensions/flowgraph/nodes/ui/setUILayout.lua

Sets the UI app layout and game state. Controls which app layout is displayed (scenario, freeroam, quickrace, etc.) and optionally persists the layout after the flowgraph stops.

Pin Schema

Input Pins

Output Pins

Node Data

How It Works

1. postInit() - Populates hardcoded template options for layout, menu, and appContainerContext pins.
2. workOnce() - Sets the game state:
   • If restrictions are off and useFreeroamMenuWhenUnrestricted is true, forces freeroam menu.
   • Calls self.mgr.modules.ui:setGameState(gameStateName, layout, menu).
   • Calls self.mgr.modules.ui:keepGameState(keepLayout) to persist if requested.
   • If appContainerContext is set, shows that app via ui_gameplayAppContainers.showApp().
3. onClientPostStartMission() - Re-applies the game state (workaround for the game overriding state on mission start).
4. onUiChangedState(cur, prev) - If active and the layout is quickraceScenario, triggers quick race mode and hotlapping reset on menu state.

Lua Code Example

-- What the node does internally:
self.mgr.modules.ui:setGameState("scenario", "scenario", "scenario")
self.mgr.modules.ui:keepGameState(false)

-- Optionally show a specific app container:
ui_gameplayAppContainers.showApp('gameplayApps', 'someAppId')

Key Dependencies

• self.mgr.modules.ui:setGameState() - Flowgraph UI module for game state management
• self.mgr.modules.ui:keepGameState() - Persist layout beyond FG lifetime
• ui_gameplayAppContainers.showApp() - App container visibility
• settings.getValue('restrictScenarios') - Scenario restriction check

See Also

• Medal / Auto Medal (Flowgraph Node) - Related reference
• Clear Messages (Flowgraph Node) - Related reference
• Context Translation (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide