Dynamic variables, commonly shorted to dyn vars or dynvars, is a system of data storage wherein one can store arbitrary, scoped data under slot hierarchies with arbitrary names, akin to that of an associative array. Their usage is usually found in large systems with many moving parts, but can nonetheless be useful as easy "global" values that can be changed on an object.
For a quick-start guide on using dynamic variables, the How To Use Dynamic Variables page serves to be a how-to.
Overview
Dynamic variables are managed with two parts: dynamic variable spaces and dynamic variables. Dynamic variables live under a dynamic variable space, and can be created, modified, and destroyed dynamically.
Variable Spaces
By adding a DynamicVariableSpace to a slot, the slot and all of its children become a part of the named variable space. This does not necessarily mean that every dynamic variable under this slot is "attached" to the space. This is explained further in #Binding.
A slot can be part of multiple spaces at once. Spaces under child slots are not nested with respect to parent spaces in any form, meaning it is advised to make unique names for variable spaces.
Dynamic Variables
To create a dynamic variable, attach any one of the following components to a slot that is part of a variable space:
- DynamicValueVariable, for working with value types (int, string, float3, etc.).
- DynamicReferenceVariable, for working with reference types (Slot, User, etc.).
- DynamicTypeVariable, for working with the Type type.
Dynamic variables have a name and a value. A variable's name is its unique identifier within the variable space, while its value is the value of the dynamic variable.
Dynamic Fields
It is possible to "transform" an existing IField on a component into a dynamic variable. This is done by any one of the following components:
- DynamicField, for working with value types.
- DynamicReference, for working with reference types.
- DynamicTypeField, for working with the Type type.
Upon attaching the component and dragging the field to convert into TargetField, the pointed field can then be interfaced with like any other dynamic variable.
Naming Restrictions
The names of dynamic variables and dynamic variable spaces must not contain symbols, punctuation, or whitespace, except for period (.), underscore (_), space ( ), and hyphen (-). To check if a character is unable to be used in a dynamic variable name, one can use the Is Symbol, Is Punctuation, and Is White Space ProtoFlux nodes, taking care of the aforementioned exceptions.
Binding
The process of a dynamic variable being associated with a given space is called binding. A dynamic variable component will traverse up the slot hierarchy, including its current slot, looking for an applicable variable space to bind to. If a dynamic variable does not find a dynamic variable space that it can bind to, it will not be accessible outside of the component itself, essentially reducing to a glorified ValueField. A dynamic variable will go through this binding process every time any part of the component changes.
Direct Vs Indirect Binding
When making a dynamic variable, the VariableName of a dynamic variable component can be one of the following two forms: VariableName or VariableSpaceName/VariableName. The former represents indirect binding, while the latter represents direct binding.
If a dynamic variable is indirectly binding, it will bind to the first dynamic variable space that does not have OnlyDirectBinding set to True. If a dynamic variable is directly binding, it will bind to the first dynamic variable space that matches VariableSpaceName.
Binding Examples
In the following setup:
└─ Foo - Variable Space "test"
└─ Bar - Variable Space "test2"
└─ Baz - Dynamic Variable "test/var"
The dynamic variable test/var will bind to the variable space test. If the variable was instead named var, it will bind to the variable space test2. If the variable was named var and test2 has OnlyDirectBinding enabled, it would bind to test.
Binding Delay Warning
As of the time of writing, there exist a few instances where created variables do not instantly bind/rebind to a dynamic variable space, requiring a Delay Updates of 2 or more updates. These include:
- Creating new dynamic reference variables.
- Deleting dynamic variables.
- Changing the name of a dynamic variable or dynamic variable space.
- Any instance where there is a dynamic variable space change without a component update, such as:
- duplicating slots containing a dynamic variable space.
- Reparenting a slot containing a dynamic variable under a new dynamic variable space.
If you find dynamic variables to be behaving weirdly, and you are doing any of these operations, try adding a delay of 2 or more updates between such operations.
Interfacing
A variable space can be interfaced with any slot that resides within the variable space, even if the slot is not part of the hierarchy containing the exact dynamic variable being interfaced with.
Reading Dynvars
In ProtoFlux, the Read Dynamic Variable node and Dynamic Variable Input nodes exist to read dynamic variables from a slot.
The Read Dynamic Variable node takes in a Source Slot and a Path variable name, and is marked as ContinuouslyChanging. The Dynamic Variable Input node uses a Global for Path and binds to spaces in the slot hierarchy it exists in. Therefore, when reading constant-name dynamic variables within the same dynamic variable space of the slot the node exists in, the Dynamic Variable Input node is preferred. When reading dynamic variables from a space outside the node's slot hierarchy, the Read Dynamic Variable node must be used.
It is also possible to read dynamic variables by sourcing the Value or Reference field of the component directly. This is not recommended, as if the dynamic variable ever gets deleted and remade, the source will break, removing half the functionality of a dynamic variable.
Driving from Dynvars
By using a DynamicValueVariableDriver or DynamicReferenceVariableDriver component, fields can be driven using the value of a dynamic variable. This is recommended over traditional methods of driving by virtue of its flexibility and compactness.
Writing to Dynvars
Dynamic variables should be written to via the Write Dynamic Variable or Write Or Create Dynamic Variable ProtoFlux nodes. The former will write to existing dynamic variables, while the latter will create the dynamic variable if it doesn't exist already.
Driving Dynvars
Driving dynamic variables must be done with caution. If a dynamic variable is being driven, it is crucial that all instances of the same dynamic variable are driven by the same value. Otherwise, clients will fight over which value is the "true" value of the dynamic variable and cause inconsistent behavior. The other caution relates to how driving is essentially a local write each frame, which is expanded on in #Writing/Driving_Delay_Warning.
Writing/Driving Delay Warning
If dynamic variables are written to via sourcing the component field and writing, it will incur a delay of 1 frame before the value is propagated to any read nodes. As such, it is highly not recommended to directly write to dynamic variable components, and always recommended to use the proper ProtoFlux nodes.
When driving the value of a dynamic variable, it is essentially a local write to the component every frame. As such, the 1 frame of delay will apply there too. There is currently no good way to avoid this.
Best Practices
Even though dynamic variables allow for a wide array of freedom, there are a few practices generally considered to be favorable when working with dynamic variables:
- It is highly recommended to have only one instance of a dynamic variable (dynamic variable component with the same name and bound to the same space) at any given time.
- There aren't any huge problems with having multiple dynamic variable instances if none or all of the instances are being driven, but it allows for cleaner organization of variables.
- Using variable names that directly bind allows for a clearer overview of what space the variables should be bound to. Indirectly binding variable names are more suited for variables that are dynamically created and/or destroyed as part of an object's function.
- Using
OnlyDirectBindingon a DynamicVariableSpace strictly enforces this behavior, which can prevent misbindings and catch errors earlier.
- Using
- Dynamic variable spaces are not nested. If a system is complex enough, or if a DynamicVariableSpace is being shared by multiple objects, using periods (
.) to pseudo-isolate objects or systems from one another is encouraged.- e.g. an avatar and all of its features could contain the dynamic variables
User/Avatar.Systems.Grabbable.Enabled,User/Avatar.Blendshapes.Blep.MaxClamp,User/Avatar.Systems.Flight.Drag, etc.
- e.g. an avatar and all of its features could contain the dynamic variables
Default Spaces
As of the time of writing, there are three dynamic spaces that exist "by default":
World, which exists under the Root of any created world. This space is marked asOnlyDirectBinding.User, which exists under every User's User Root Slot. This space isOnlyDirectBinding.- Useful for systems that affect avatars, as outside objects can rely on a standardized space being available for each user to read and write variables on.
Dash, which exists under the slot containing the UserspaceRadiantDash in userspace.
Example Usage
One Contained System
Say you are working on a large and complicated system. In lieu of trying to manage "global" settings by sourcing ValueField components, you can use dynamic variables to help assign names to settings or other useful values. This is usually accomplished by placing a DynamicVariableSpace on the root of your object (or root of your "library") and having a specialized dynamic variable slot for containing the dynamic variables. Depending on how many dynamic variables are used, it may be beneficial to delegate them to multiple slots.
A screenshot showing a simple setup like this is shown below. Note the use of Dynamic Variable Input nodes for performance sake.
Controlling Another System
Say that you want to make an external controller for a system on an avatar. This system uses the default User dynamic variable space and namespaces itself with User/CoolAvatarSystem..
The simplest way to get a slot to interface with this system can be obtained by getting the User in some fashion and plugging it into the User Root Slot node. Reading with this system should be done with the Read Dynamic Variable node, as the controller is not part of the dynamic variable space on the user.
From there, it's simply a matter of knowing the right variable names and types (e.g. User/CoolAvatarSystem.Enabled being a bool). Plugging the previously obtained slot into the Source of a Read Dynamic Variable of the matching type and path will get you the current value, while using a Write Dynamic Variable will allow you to write to it.