interface AttributeOptions
Options accepted by the v8-only forms of declareattribute, describing how an attribute is typed, stored, and presented.
Index
Properties
- category
- default
- embed
- enumindex
- enumvals
- getter
- invisible
- label
- max
- min
- name
- paint
- setter
- size
- steps
- style
- type
category string
The attribute's category.
default number | string | (number | string)[]
The default value.
embed number | boolean
Whether to embed the attribute in the patcher file on save.
enumindex string[]
enumvals string[]
getter string
The getter function name.
invisible number | boolean
Whether the attribute is invisible.
label string
A human-readable label.
max number
The maximum value.
min number
The minimum value.
name string
The attribute name. Required when declareattribute is called with a single options object.
paint number | boolean
setter string
The setter function name.
size number
The array size, for array-valued attributes (implicit if default is an array).
steps number
The number of steps.
style "onoff" | "enum" | "rgba"
The attribute's editor style.
type "long" | "float" | "symbol" | "atom"
The attribute's data type.