Start Screen (Flowgraph Node)

Overview

• Node Name: Start Screen
• Category: (once, singleActive)
• File: extensions/flowgraph/nodes/ui/startScreen.lua

Shows the start screen of a scenario/mission with title, description, optional portrait, and a start button. Supports multiple layout modes and mission progress display.

Pin Schema

Input Pins

Output Pins

Internals

How It Works

1. work() - Main loop:
   • If reset impulse: closes dialogue, resets state, clears outputs.
   • If done: returns early (once behaviour).
   • If flow active and not open: calls openDialogue().
2. openDialogue() - Builds start screen data:
   • Sets introType from the layout pin (defaults to "htmlOnly").
   • If text is a table, uses multiDescription; otherwise uses description.
   • Sets button text, title, portrait image.
   • If showProgress is true and there's an active mission, formats progress data via gameplay_missions_progress.
   • Builds a callObj and readyHook Lua string for the UI callback.
   • Triggers guihooks.trigger('ChangeState', {state = 'scenario-start', params = {data = data}}).
3. onScenarioUIReady(state) - Re-sends stored data via guihooks.trigger('ScenarioChange', data) when the UI is ready.
4. started() - Called from the UI button. Closes dialogue, fires flow output, marks as done.
5. closeDialogue() - Resets open/active flags.

Layout Modes

Serialization

• _onDeserialized() - Handles legacy portraitMode boolean format, converting to the new layout string format.

Lua Code Example

-- Trigger a scenario start screen:
guihooks.trigger('ChangeState', {
  state = 'scenario-start',
  params = {
    data = {
      showDataImmediately = true,
      introType = "htmlOnly",
      description = "Complete the race in under 2 minutes.",
      buttonText = "ui.scenarios.start.start",
      name = "Time Trial",
      callObj = 'core_flowgraphManager.getManagerGraphNode(1, 2, 3)',
      readyHook = '...:started()',
    }
  }
})

Key Dependencies

• guihooks.trigger('ChangeState', {state = 'scenario-start', ...}) - Opens the start screen UI
• guihooks.trigger('ScenarioChange', data) - Updates scenario data when UI is ready
• gameplay_missions_progress.formatSaveDataForUi() - Progress formatting
• gameplay_missions_progress.formatStars() - Star display formatting
• core_input_bindings - Listed dependency

Previously Undocumented (Added by Audit)

• C:buttonPushed(action) - Function handling buttonPushed logic
• C:getCmd(action) - Function handling getCmd logic
• C:onFilteredInputChanged(devName, action, value) - Function handling onFilteredInputChanged logic

See Also

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