API ReferenceGE ExtensionsflowgraphnodesuiupdatedUI
StartScreen Begin (Flowgraph Node)
- **Node Name:** `StartScreen Begin`
Overview
- Node Name:
StartScreen Begin - Category: default (duration-like behavior)
- File:
extensions/flowgraph/nodes/ui/updatedUI/startScreenBegin.lua
Begins building the start screen UI for missions/scenarios. Provides a start button and handles auto-skip for programmatic starts. Use with "StartScreen" content nodes and "Screen Finish" to complete the layout.
Pin Schema
Input Pins
| Pin | Type | Default | Description |
|---|---|---|---|
flow | flow | - | Activates the start screen |
reset | flow (impulse) | - | Resets the node |
triggerStart | flow (impulse) | - | Simulates a click on the start button |
startButtonText | string | "ui.scenarios.start.start" | Text for the start button |
simple | bool | false | Removes replays interaction and panel banner |
Output Pins
| Pin | Type | Description |
|---|---|---|
flow | flow | Fires when the player presses start |
build | flow (chain) | Fires once to build content panels |
Internals
Key Methods
| Method | Description |
|---|---|
work() | Manages build chain, start detection, and auto-skip timer |
startFromUi() | Called when start button is pressed; sets done, triggers hook and state change |
closeDialogue() | Triggers ChangeState('play') |
onNodeReset() | Resets all flags |
How It Works
- When
flowactivates, callsmgr.modules.ui:startUIBuilding('startScreen', self)and adds a header with the manager name. - Sets the start button text and optionally marks the screen as "simple".
- The
buildchain output fires once so downstream nodes can add content panels (intro text, objectives, etc.). - When the player clicks start (or
triggerStartfires),startFromUi()triggersonUIStartButtonClickedhook andChangeState('play'). flowoutput becomes true after the start is confirmed.- If
autoSkipStartScreenis set on the activity, auto-starts after 2 seconds.
Usage Example
-- Flowgraph chain:
-- [StartScreen Begin] → (build) → [StartScreen Intro] → [StartScreen Text] → [Screen Finish]
-- → (flow) → [Start Countdown] → [Race Logic]
-- Programmatic start:
-- Connect a trigger to the triggerStart pin to bypass the UIKey Dependencies
mgr.modules.ui- UI building systemextensions.hook("onUIStartButtonClicked")- notifies other systems of startguihooks.trigger('ChangeState', 'play')- returns to gameplay
See Also
- EndScreen Begin (Flowgraph Node) - Related reference
- EndScreen Drift Stats (Flowgraph Node) - Related reference
- EndScreen Lap Times (Flowgraph Node) - Related reference
- FlowGraph Guide - Guide