What is a parameter?
Parameters are used to keep track of global or local values coming from the game engine or other implementation.
Overview
Parameters can be used in any patch in the studio and are used to keep track of global values, for example the player's health. There are GLOBAL parameters that can be accessed from all patches in the project, and LOCAL (or patch) paramaters are only accessible in the patch where they are created.
Parameter types
- Boolean - Holds the true or false state of the parameter
- Integer - Holds a whole number value
- Float - Holds a decimal value
- Enum - Holds the current item or state based on an Enum asset. Read more about Enumeration assets here
- Pulse - Used to send a pulse to connected nodes and trigger the node chain.
Create a new parameter
Global parameter
- Managing global parameters is done from the global parameter tab located above the asset browser.
- When a global parameter is added to a patch, you can see that global parameters have a globe icon before the name.
- Click the add button 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.
Patch parameter
- Managing patch parameters is done from the right side inspector in an open Patch asset.
- Click the add button 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.