Advanced Variables
Jump to navigation
Jump to search
Advanced Variables
| Node Details | |
|---|---|
| Logic Type: | Variable |
| Menu Location: | Logic > Variable Nodes > Advanced Variables |
| PI Score: | N/A |
Requirements to Function (if applicable)
N/A
Limitations to Function (if applicable)
N/A
Attributes (if applicable)
| Name | Option | Description |
|---|---|---|
| Variable Name | String | Defines which variable instances reference to the same value. Having an empty name will create a unique variable. Note: duplicating Advanced Variable nodes will append _Copy. |
| Description | String | Optional field to describe what the variable represents. |
| Value Mode | Enum: Per ARC / Per Player | Defines if the variable is global to the Arc or should be indexed by Player Id. |
| Persistency Mode | Enum: Offline / Online | Whether the value of the variable will persist between instances of the room. Online variables will trigger extra events (On Online Value Ready, On Get Online Value Not Ready) |
| Default Value | Default value of the variable on start. For variables with online persistency mode it will apply the first time the Arc loads (or the first time a player joins the room in the case of a per player variable) | |
| Receive Notification On Update | Boolean | Whether the specific instance of the advanced variable will work as a listener node. On Value Updated will be triggered every time the variable is set, including on start or on player join (for per arc and per player variables respectively). Only works with named variables. |
Logic Linking
Outgoing Events
| Name | Description |
|---|---|
| On Get Value | Triggered from Get Value function. Includes Outputted Value and Player Id (if Per Player) data events. |
| On Value Updated | Triggered from Update Value function of the same node instance or any other instance with the same variable name if Receive Notification On Update is set. Includes Outputted Value and Player Id (if Per Player) data events. |
| On Online Value Ready | Triggered when the online value for this variable is loaded. Online values are loaded as soon as the Arc starts or as soon as the player joins (if Per Player). Requires a Variable Name. |
| On Get Online Value Not Ready | Triggered when Get Value or Update Value are triggered before the required online value was loaded. |
| Outputted Value | Data value of the variable. |
| Player Id | Id of the player the variable value belongs to when set to Per Player. |
Incoming Functions
| Name | Description |
|---|---|
| Get Value | Retrieves the variable value. Requires Player Id function if Per Player. Triggers On Get Value. |
| Update Value | Updates the variable value to the given Overwrite Value. Requires Player Id function if Per Player. Triggers On Value Updated. |
| Overwrite Value | Value used for overriding the variable using Update Value. |
| Player Id | Id of the player to get/update variable from. Only used for Per Player variables. |
Common Use Cases
Advanced variables are the basic block for building complex logic. If you need to have access to a value at different point in your arc, consider using advanced variables as it will greatly simplify the linking and updating of your logic. Advanced variables allow you to save values online, which can be used to add progression to your experiences and incentivize player to come back to your arcs.
Similar Logic Objects and Variants
N/A
Patch Updates
| Patch (hyperlink) | Change | Note |
|---|---|---|
| N/A | N/A | N/A |
Asset Library Links
N/A