Page tree

Versions Compared

Key

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

Anchor
top
top

The Element class is the base class for the classes Bus, Instance, Layer, Effect, MidiModule, ModulationMatrixRowSlot and Zone.

Panel
bgColor#ffffff
borderStylenone
titleOn this page:

Excerpt

Table of Contents
indent25px
maxLevel2
minLevel2
typeflat
absoluteUrltrue
separator,

Panel

Class Hierarchy

Children Display
pageClass Reference
alltrue

Classes

Panel
bgColor#ffffff
borderColor#bbbbbb

Element Class

Description

The different types of elements are InstanceSlot, Program, Layer, ZoneModulationMatrixRow, MidiModule, Bus and Effect. The properties of an Element object are described by the following fields.

Available in: Controller, Processor.

Fields

.nameReturns the name of the element.string
.idReturns the unique ID of the element.string
.typeReturns the type of the element.string
.numParamsReturns the number of parameters.number.parameterDefinitionsReturns an array with all ParameterDefinition objects of the element.table
.parentReturns the parent element in the Program Tree. This evaluates to nil if the element is the program.Element or nil
.programReturns the program element in the Program Tree.Program
.levelReturns the level in the Program Tree hierarchy. The program equals level 1. Each sublayer adds +1 to the level.number

Example

Code Block
-- print information about the script module
print(this.name)
print(this.id)
print(this.type)
print(this.name)
print(this.numParams)
print(this.parent.name)
print(this.program.name)
print(this.level)

-- print the names of all parameters of the parent element
defs = this.parent.parameterDefinitions

for i, def in ipairs(defs) do
    print(def.name)
end

Jump to Top

Methods

Excerpt include halion
pagefindChildren

Jump to Top

Excerpt include halion
pagegetChild

Jump to Top

Excerpt include halion
pagegetParameter

Jump to Top

Excerpt include halion
pagegetParameterDefinition

Jump to Top

Excerpt include halion
pagegetParameterNormalized

Jump to Top

Excerpt include halion
pagehasParameter

Jump to Top

Excerpt include halion
pageremoveFromParent

Jump to Top

Excerpt include halion
pagesetName

Jump to Top

Excerpt include halion
pagesetParameter

Jump to Top

Excerpt include halion
pagesetParameterNormalized

Jump to Top