Parameters
Overview
Parameters can be used in any patch in the studio and are used to keep track of global values, i.e., the player's health. There are GLOBAL PARAMETERS that can be accessed from any patch, and PATCH PARAMETERS that can only be accessed locally in the patch where they are created.
Parameter types
- Boolean - Holds the true or false state of the parameter
- Integer (Int) - Holds a whole number value
- Float - Holds a decimal value
- Enum - Holds the current item/state based on an Enum asset. Read more about Enumeration assets here: Enum (Enumeration)
- Pulse - Used to send a pulse to connected nodes and trigger the node chain.
Create a new parameter
Managing global parameters is done from the global parameter tab located above the asset browser. Managing patch parameters is done from the inspector in an open Patch asset.
- Click the add button under GLOBAL or PATCH parameters to select the parameter type
- After the parameter has been added, set a name and a default (initial) value for the parameter.
- You can change the name and default value at any time. Just double-click the parameter to edit.
- You can delete a parameter either via the DEL button or via the context menu (right click)
- You can also rearrange the order of parameters. Just drag n drop a parameter to a new place in the list.
Add a parameter to a patch
- You can find all parameters in the patch context menu. Right-click on the canvas to add a parameter or another node.
- You can also just drag and drop the parameter from the list to the patch.
Filter parameter
- Use the filter to easily find a parameter.
- To clear the filter, just click the X button in the filter field.
Global VS Patch parameters
- Global parameters are found under the Global Parameters tab in the left panel.
- Patch parameters are found in open patches in the right panel inspector.
- When a parameter is added to a patch, you can see that global parameters have a globe icon before it