Variables are used by module builders to configure how data moves through a Workshop module. A list of available variable types can be found below.
To access existing variables in a Workshop module or define new variables, open the Variables menu found in the left sidebar.
The Variables panel (shown above) displays a list with the current variables that exist within a module, a plus + button to add a new variable, an input to search variables by their name, a button to open the variable dependency graph, and a filter to display variables based on their definition type or what settings are enabled.
Selecting a variable from the list on the left allows you to view and modify the configuration of that variable in a window that opens to the right of the variables list. The following configuration options are available:
The screenshot below shows an example configuration for an Object Set variable:
The screenshot below shows an example configuration for a string array variable:
Workshop supports the following variable types:
true
or false
. Initialized from either a static value or the output of a function, aggregation, or object property.The header of the Variables panel, contains a button with a graph node icon. This button opens the Variable dependency graph. This dependency graph offers a way to debug your variables, showing the dependency graph of variables and widgets within the module. Selecting a variable node in the graph will reveal information about the following:
Notably, next to the variable value configuration is an option to clear value which will reset the variable definition to the empty state.
Widgets are shown as nodes in the graph but offer no additional information when selected.