Custom UI Layout (Flowgraph Node)

Overview

• Node Name: Custom UI Layout
• Category: provider
• File: extensions/flowgraph/nodes/ui/customUiLayout.lua

Lets you capture, store, and restore a custom UI layout. The layout is serialized with the flowgraph and can be loaded at execution time.

Pin Schema

Output Pins

Internals

Stored State

• self.storedLayout - Array of UI app definitions captured from the current layout.

Key Methods

How It Works

1. In the flowgraph editor, click Capture to save the current in-game UI layout into the node.
2. The node stores the raw app list (storedLayout) and serializes it with the graph.
3. When the flowgraph starts execution, _executionStarted outputs the layout as a layoutData table.
4. Downstream nodes (e.g. a UI Layout node) can apply this layout to the game.

Editor Buttons

• Capture - Triggers guihooks.trigger('getCurrentLayoutToLua', cmd) and stores the result.
• Clear - Removes the stored layout.
• Load Stored Layout - Applies stored layout via core_gamestate.setGameState.
• Load Freeroam layout - Reverts to the default freeroam layout.
• Copy Layout from… - Copies an existing named layout into the node.

Usage Example

-- The node outputs a table like:
{
  apps = { ... },          -- array of app definitions
  layoutName = "procedural Layout 42"
}

-- Downstream, a UI Layout node consumes this to set the game's app layout.

Key Dependencies

• guihooks.trigger('getCurrentLayoutToLua', ...) - requests current layout from the UI layer
• core_gamestate.setGameState() - applies a game state / layout

Previously Undocumented (Added by Audit)

• Parameter fix: getCmd(action) - parameter action used in getCmd

See Also

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