01_user_documentation:05_object:08_parameter:01_parameter
Table of Contents
Parameter
Parameters map an attribute from RGG objects to the parameter manager. It grants the parameter manager access to the attribute accessors. Thus, enabling to set or get its value.
Only attributes from RGG can be linked to parameters (for instance fields at root of .rgg files can, but fields in module cannot).
Declare parameters
Parameters are declared with the annotations @IsParameter, and @AllAsParameter.
Explicitly use PM
By default, parameter are added to the default parameter manager. It is possible to link them to a specific parameter manager either by:
- Creating a new one based on a type
- Referring to an existing one by name
Set value
It is possible to set the value of a parameter through either:
- The GUI attribute editor
- The parameter manager (e.g. with
savePMs)
Get value
The value of a parameter can be loaded by the parameter manager with loadPMs. Or more specific method from the parameter manager.
01_user_documentation/05_object/08_parameter/01_parameter.txt · Last modified: 2025/09/08 12:42 by gaetan