Addressing Parameters by Name
Please do not mix up the parameter's label on the UI with its name in the engine. Sometimes, the label and the name of a parameter are the same, but most of the time they are different.
Throughout this documentation "name of parameter..." refers to its name in the engine and not its label on the UI.
The name of a parameter can be found in HALion's Parameter List. The Parameter List gives you a detailed overview of the parameters of the currently selected element in the Program Tree. The following screenshot shows parts of the parameters of a zone.
The Parameter column lists the names of the parameters. Parameters that belong together can be grouped into functional sections, represented by the folders in the Parameter column.
- Parameters that do not belong to a section can be addressed directly. In the screenshot above, "UserAttOffset" addresses the attack offset of the user envelope in the zone, for example.
- Parameters that belong to a section need the name of the section as prefix, for example, the shape parameter of LFO 1 in the zone has the name "LFO 1.Shape".
Addressing a parameter by its name is case sensitive.
Addressing Parameters by ID
The ID of a parameter can also be found in the Parameter List. By default, the Parameter List does not show the ID.
- To add the ID column to the Parameter List, right-click a column header and select ID (Dec).
The ID of "LFO 1.Shape" is 65542, for example.
Addressing parameters by name needs more computing time and might be a disadvantage for timing critical scripts. To optimize your script, you can read the ID of a parameter with getParameterDefinition during the initialization of the script and use this instead.