Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

The ParameterDefinition class describes the properties of parameters.

On this page:

Table of Contents
maxLevel2
minLevel2
indent25px
exclude\d
typeflat
separator,


Panel

Class Hierarchy

Children Display
alltrue
pageClass Reference


Classes

Panel
borderColor#bbbbbb
bgColor#ffffff

ParameterDefinition Class

Description

The ParameterDefinition object describes the properties of a parameter.

Available in: Controller, Processor

Fields

.nameReturns the name of the parameter.string
.longNameReturns the long name of the parameter.string
.idReturns the ID of the parameter.number
.typeReturns the data type of the parameter.string
.defaultReturns the default value of the parameter.number
.minReturns the minimum value of the parameter.number
.maxReturns the maximum value of the parameter.number
.readOnlyReturns true if the value of the parameter is read-only and false if it is not.boolean
.writeAlwaysReturns true if the value is always set and false if it is not. If this returns true, the parameter sends a changed message even if the actual value did not change when it was set.boolean
.automatableReturns true if the parameter can be automated and false if it cannot.boolean
.persistentReturns true if the parameter restores from the VST preset and false if it does not.boolean
.unitReturns the unit of the parameter value, for example, dB.string

Example

Code Block
-- print the parameter definition with corresponding data type of the parent layer's level parameter
function onLoadIntoSlot()

    local def = this.parent:getParameterDefinition("Level")

    print("Name = "..def.name..", "..type(def.name))
    print("Long Name = "..def.longName..", "..type(def.longName))
    print("ID = "..def.id..", "..type(def.id))
    print("Type = "..def.type..", "..type(def.type))
    print("Default = "..def.default..", "..type(def.default))
    print("Min = "..def.min..", "..type(def.min))
    print("Max = "..def.max..", "..type(def.max))
    print("Read Only = "..tostring(def.readOnly)..", "..type(def.readOnly))
    print("Write Always = "..tostring(def.writeAlways)..", "..type(def.writeAlways))
    print("Automatable = "..tostring(def.automatable)..", "..type(def.automatable))
    print("Persistent = "..tostring(def.persistent)..", "..type(def.persistent))
    print("Unit = "..def.unit..", "..type(def.unit).."\n")

end


Jump to Top

Methods

Excerpt include halion
pagegetDisplayString

Jump to Top