parameter

• Parameter
  • Functions
    • boolean(id : ParameterId, default : ParameterBooleanDefault, name : ParameterName``?, description : ParameterDescription``?)
    • integer(id : ParameterId, default : ParameterIntegerDefault, range : ParameterIntegerRange``?, name : ParameterName``?, description : ParameterDescription``?)
    • number(id : ParameterId, default : ParameterNumberDefault, range : ParameterNumberRange``?, name : ParameterName``?, description : ParameterDescription``?)
    • enum(id : ParameterId, default : ParameterEnumDefault, values : string[], name : ParameterName``?, description : ParameterDescription``?)
  • Aliases
    • ParameterBooleanDefault
    • ParameterDescription
    • ParameterEnumDefault
    • ParameterId
    • ParameterIntegerDefault
    • ParameterIntegerRange
    • ParameterName
    • ParameterNumberDefault
    • ParameterNumberRange

Parameter

Opaque parameter user data. Construct new parameters via the parameter.XXX(...) functions.

Functions

boolean(id : ParameterId, default : ParameterBooleanDefault, name : ParameterName?, description : ParameterDescription?)

->Parameter

Creates an Parameter with "boolean" Lua type with the given default value and other optional properties.

integer(id : ParameterId, default : ParameterIntegerDefault, range : ParameterIntegerRange?, name : ParameterName?, description : ParameterDescription?)

->Parameter

Creates an Parameter with "integer" Lua type with the given default value and other optional properties.

number(id : ParameterId, default : ParameterNumberDefault, range : ParameterNumberRange?, name : ParameterName?, description : ParameterDescription?)

->Parameter

Creates an Parameter with "number" Lua type with the given default value and other optional properties.

enum(id : ParameterId, default : ParameterEnumDefault, values : string[], name : ParameterName?, description : ParameterDescription?)

->Parameter

Creates an Parameter with a "string" Lua type with the given default value, set of valid values to choose from and other optional properties.

Aliases

ParameterBooleanDefault

boolean

Default boolean value.

ParameterDescription

string

Optional long description of the parameter describing what the parameter does.

ParameterEnumDefault

string

Default string value. Must be a valid string within the specified value set.

ParameterId

string

Unique id of the parameter. The id will be used in the parameter context table as key.

ParameterIntegerDefault

integer

Default integer value. Must be in the specified value range.

ParameterIntegerRange

{ 1 : integer, 2 : integer }

Optional value range. When undefined (0.0 - 1.0)

ParameterName

string

Optional name of the parameter as displayed to the user. When undefined, the id is used.

ParameterNumberDefault

number

Default number value. Must be in the specified value range.

ParameterNumberRange

{ 1 : number, 2 : number }

Optional value range. When undefined (0 - 100)