Overlay Variable
Runs on: Backend — reads the overlay variable from the database.
The Overlay Variable node fetches the stored value of a variable that belongs to one of your overlays and passes it downstream. Select the overlay and variable from the dropdowns — the overlay must already exist in the overlay editor, and the variable must be defined within it.
The output type adjusts automatically based on the variable's configured type: a number variable produces a number, a boolean variable produces a boolean, and everything else produces a string. Array-type variables produce the corresponding array type. If you change the variable selection, any existing connections on the output handle are removed to prevent type mismatches.
Use this node to read the current state of an overlay variable before deciding what to write to it, or to feed its value into other parts of your flow for computation or display.
Outputs
| Name | Type | Description |
|---|---|---|
output | string, number, boolean, or array | The current value of the selected overlay variable. |
Configuration
- Overlay: The overlay that owns the variable you want to read.
- Variable: The specific variable within the chosen overlay to read.
Example
A flow that manages a "viewer streak" counter reads the current streak value using an Overlay Variable node, adds one to it with a Math node, and then writes the result back using a Set Overlay Variable effect — all triggered by a chat event.