input

• InputParameter
• Parameter
  • Functions
    • boolean(id : InputParameterId, default : InputParameterBooleanDefault, name : InputParameterName``?, description : InputParameterDescription``?)
    • integer(id : InputParameterId, default : InputParameterIntegerDefault, range : InputParameterIntegerRange``?, name : InputParameterName``?, description : InputParameterDescription``?)
    • number(id : InputParameterId, default : InputParameterNumberDefault, range : InputParameterNumberRange``?, name : InputParameterName``?, description : InputParameterDescription``?)
    • enum(id : InputParameterId, default : InputParameterEnumDefault, values : string[], name : InputParameterName``?, description : InputParameterDescription``?)
  • Aliases
    • InputParameterBooleanDefault
    • InputParameterDescription
    • InputParameterEnumDefault
    • InputParameterId
    • InputParameterIntegerDefault
    • InputParameterIntegerRange
    • InputParameterName
    • InputParameterNumberDefault
    • InputParameterNumberRange

InputParameter

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

Parameter

Contains functions to construct new input parameters. Input parameter values can be accessed via functionn contexts in pattern, gate and emitter functions or generators.

Functions

boolean(id : InputParameterId, default : InputParameterBooleanDefault, name : InputParameterName?, description : InputParameterDescription?)

->InputParameter

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

integer(id : InputParameterId, default : InputParameterIntegerDefault, range : InputParameterIntegerRange?, name : InputParameterName?, description : InputParameterDescription?)

->InputParameter

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

number(id : InputParameterId, default : InputParameterNumberDefault, range : InputParameterNumberRange?, name : InputParameterName?, description : InputParameterDescription?)

->InputParameter

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

enum(id : InputParameterId, default : InputParameterEnumDefault, values : string[], name : InputParameterName?, description : InputParameterDescription?)

->InputParameter

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

Aliases

InputParameterBooleanDefault

boolean

Default boolean value.

InputParameterDescription

string

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

InputParameterEnumDefault

string

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

InputParameterId

string

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

InputParameterIntegerDefault

integer

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

InputParameterIntegerRange

{ 1 : integer, 2 : integer }

Optional value range. When undefined (0.0 - 1.0)

InputParameterName

string

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

InputParameterNumberDefault

number

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

InputParameterNumberRange

{ 1 : number, 2 : number }

Optional value range. When undefined (0 - 100)