Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

getParameterNormalized(nameOrID)

Description

Function to read the current value of a parameter in a normalized range from 0 to 1.0. The parameter can be identified by the parameter's name or ID.

The identification by name needs more computing time and might be a disadvantage for timing critical scripts. For the same reason string parameters should not be read in the processor context. To optimize your script, you can read the ID of a parameter with getParameterDefinition during the initialization of the script and use this instead.

Available in: Controller, Processor.

Arguments

nameOrIDThe name or ID of the parameter.

Return Values

Returns the current value of the parameter in a normalized range from 0 to 1.0 or nil if the parameter doesn't exist. The function returns the same as getParameter if the parameter is not numeric.

Example

-- print the value of the level parameter of the parent layer
function onInit()
    print(this.parent:getParameterNormalized("Level")) --via name
    print(this.parent:getParameterNormalized(38)) --via ID
end
  • No labels
Write a comment…