API ReferenceGE Extensionsflowgraphnodesui
Fade Sequence (Flowgraph Node)
- **Node Name:** `Fade Sequence`
Overview
- Node Name:
Fade Sequence - Category:
once_f_duration - File:
extensions/flowgraph/nodes/ui/fadeSequence.lua
Fades the screen to black, pauses, then fades back from black. Provides a faded impulse when the screen is fully black. Obsolete - use Fade To Black and Fade From Black nodes instead.
Pin Schema
Input Pins
| Pin | Type | Default | Description |
|---|---|---|---|
startDuration | number | 0.75 | Duration of fade to black (hardcoded) |
pauseDuration | number | 0 | Duration of pause at black (hardcoded) |
endDuration | number | 0.75 | Duration of fade from black (hardcoded) |
Output Pins
| Pin | Type | Description |
|---|---|---|
faded | flow (impulse) | Fires once when screen reaches full black |
complete | flow | Fires when entire sequence finishes (inherited) |
Internals
Key Methods
| Method | Description |
|---|---|
workOnce() | Starts the fade sequence via ui_fadeScreen.fadeSequence() |
work() | Manages the faded impulse - ensures it only fires for one frame |
onScreenFadeState(state) | State 1 = fully black (sets faded), state 3 = sequence complete |
_executionStopped() | Resets all state |
onNodeReset() | Resets all state |
How It Works
workOnce()callsui_fadeScreen.fadeSequence(startDuration, pauseDuration, endDuration).- When the screen reaches full black,
onScreenFadeState(1)fires and setsfadedoutput to true. - The
work()method ensuresfadedis an impulse (true for exactly one frame). - After the pause and fade-back complete,
onScreenFadeState(3)fires and sets duration tofinished.
Usage Example
-- Fade to black over 1s, hold for 0.5s, fade back over 1s:
ui_fadeScreen.fadeSequence(1, 0.5, 1)
-- In a flowgraph, connect:
-- [Trigger] → [Fade Sequence] → (faded) → [Do something while screen is black]
-- → (complete) → [Continue after fade]Key Dependencies
ui_fadeScreen.fadeSequence()- performs the three-phase fadeonScreenFadeStatehook - states: 1 = fully black, 3 = complete
See Also
- Medal / Auto Medal (Flowgraph Node) - Related reference
- Clear Messages (Flowgraph Node) - Related reference
- Context Translation (Flowgraph Node) - Related reference
- FlowGraph Guide - Guide