Mission End Screen (Flowgraph Node)

Overview

• Node Name: Mission End Screen
• Category: once_instant
• File: extensions/flowgraph/nodes/ui/missionEndScreen.lua

Shows the end screen of a scenario/mission with customizable buttons, progress data, and leaderboard information. Supports retry, continue, and user-defined custom buttons.

Pin Schema

Input Pins

Output Pins

Node Data

Internals

How It Works

1. workOnce() - Calls openDialogue() to display the end screen.
2. openDialogue() - Builds the end screen data:
   • Creates default buttons: Retry, Continue at Start, Continue Here, and optionally next-mission buttons.
   • Creates custom buttons from self.options (added via the editor UI).
   • Orders buttons based on customBtnsFirst pin.
   • Builds statsData with fail/pass state and text content.
   • If change pin has data, builds missionData with leaderboard keys, formatted progress, and star data.
   • Triggers guihooks.trigger('ChangeState', {state = 'scenario-end', params = endData}).
3. buttonPushed(action) - Called from UI via Lua command string. Sets the matching output flow pin and closes the dialogue.
4. closeDialogue() - Triggers ChangeState back to 'play' mode.
5. drawCustomProperties() - Editor UI for adding/removing/renaming custom buttons.
6. updateButtons() - Dynamically creates/removes pins for custom buttons while preserving existing links.

Special Cases

• Tutorial mode: If the linear tutorial is incomplete, only the "Continue Here" button is shown.
• Career mode: "Continue Here" only available when using player's own vehicle or career is inactive.
• Scenario mode: Shows "Scenarios" button instead of "Continue at Start".
• onResetGameplay() - Auto-triggers retry if the end screen is open and retry is enabled.

Lua Code Example

-- The end screen is triggered via guihooks:
guihooks.trigger('ChangeState', {
  state = 'scenario-end',
  params = {
    missionData = { ... },
    stats = {
      overall = { failed = false, medal = "none" },
      buttons = {
        { label = 'ui.common.retry', cmd = '...', focus = true, active = true },
        { label = 'missions.missions.general.end.continueHere', cmd = '...' },
      },
      title = "",
      text = "You completed the mission!",
    }
  }
})

Serialization

• _onSerialize() - Saves options (custom button names).
• _onDeserialized() - Restores options and rebuilds dynamic pins.

Key Dependencies

• guihooks.trigger('ChangeState', ...) - State transition to scenario-end screen
• gameplay_missions_progress - Leaderboard and progress formatting
• gameplay_missions_missions - Mission lookup for next-mission buttons
• career_career - Career state checks
• career_modules_linearTutorial - Tutorial state checks

Previously Undocumented (Added by Audit)

• C:getCmd(action) - Function handling getCmd logic
• Input Pin: _active (any)
• Input Pin: timeStr (any)

See Also

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