User Parameter
User Parameters allow users to create custom parameters on any object.
Unlike built-in object parameters, user parameters are created manually and can be used to store configuration values, control system behavior, or expose values to other parts of the project.
User Parameters are often used to create custom control interfaces, define configuration values, or store variables that are used by workflows, modifiers, or scripts.
Because they belong to the object, they can be accessed by all systems that interact with that object.
User Parameters behave exactly like built-in parameters and can be used anywhere in the system where parameters are supported.
Creating User Parameters
User Parameters can be created from the Inspector.
To create a user parameter:
Select an object.
Open the Inspector.
Go to the General tab.
Add a new entry under User Parameters.
Once created, the parameter behaves like a regular object parameter and can be edited directly in the Inspector.
Parameter Types
When creating a User Parameter, the parameter type must be selected. The type defines how the value is stored, interpreted, and displayed in the interface.
The following parameter types are available:
Boolean Parameter Stores a true/false value. Typically used for toggles, enable/disable states, or simple conditions.
Color Parameter Stores a color value and provides a color picker in the interface.
Data Parameter Stores structured data values. This type is commonly used when working with datasets or when passing structured data between systems.
Enum Parameter Provides a selectable list of predefined options (dropdown menu).
Float Parameter Stores floating-point numbers and is commonly used for continuous values such as positions, intensities, or percentages.
Integer Parameter Stores whole numbers without decimal places.
Point Parameter Represents a two-dimensional coordinate (X and Y).
String Parameter Stores text values.
Trigger Represents a momentary action rather than a persistent value. Triggers are commonly used to initiate events in workflows.
Vector Parameter Represents a three-dimensional value (X, Y, Z), commonly used for spatial parameters.
Using Parameters in Systems
User Parameters can be accessed by multiple systems inside Grid Studio.
They can be used in:
Workflows Parameters can be read or written using workflow events and actions.
Modifiers Parameter values can be used as node inputs or outputs inside modifiers.
Widgets User Parameters can be connected to widgets to create interactive dashboards or control panels.
Scripting Scripts can read and modify parameter values programmatically.
Typical Use Cases
User Parameters are commonly used for:
defining configuration values
creating control variables for workflows
exposing parameters to user interfaces
storing project-specific values
creating adjustable system settings
Because they are attached to objects, user parameters provide a simple way to extend object functionality without modifying the underlying object type.
Last updated