Properties

Properties can be accessed from a PresetData class obtained from a specified Preset using the PresetData:GetPresetObject() function. Note that several properties are used internally by Moving Light Assistant and may not be of much use to users.

To read a ‘member’ property of a PresetData class, a dot separator is used between the _PresetData_class object and the property.

channelNum = preset.Channel

Gets the Channel property from a previously retrieved PresetData class called preset and assigns it to the variable channelNum.

*There is no ability to save changes to a PresetData class, so assigning values to a PresetData property is of no use.

Channel

Numeric(integer) value

The Channel property is the channel number for the preset.

ConsoleFixtureID

String value

The ConsoleFixtureID property is an identifier the console uses to identify a channel. This is used for Hog2 data.

Fixture

Numeric(integer) value

The Fixture property is the fixture number for the preset.

FixtureName

String value

The FixtureName property is the fixture name for the channel/fixture.

FixtureType

String value

The FixtureType property is the fixture type for the channel/fixture.

Mode

String value

The Mode property is the mode for the preset i.e. Selective, Global, Universal.

NumParameters

Numeric(integer) value

The NumParameters property is the number of parameters in the preset.

*Note that the parameter data is stored as an array of parameter data. The parameter access functions have the parameter number as a part of the property name. Parameter numbers start at 1 up to the maximum supported number of parameters, which is currently 100. The array will be of a variable length (the NumParameters will let you know how many parameters are in the array).

ParameterEffectX (where X is a number 1 to 100)

String value

The ParameterEffectX property contains effect data information for parameter X. Note that which parameter is which number will not be same between presets as it is dependant of which parameters are actually store in the preset.

Example.

effectData = preset.ParameterEffect9

ParameterNameX (where X is a number 1 to 100)

String value

The ParameterNameX property contains the parameter name i.e. DIM, PAN, TILT for parameter X. Note that which parameter is which number will not be same between presets as it is dependant of which parameters are actually store in the preset.

Example.

name = preset.ParameterName9

ParameterNestedX (where X is a number 1 to 100)

String value

The ParameterNestedX property contains information (name and ID) if the parameter for a preset is nested/embedded for parameter X. Note that which parameter is which number will not be same between presets as it is dependant of which parameters are actually store in the preset.

Example.

nested = preset.ParameterNested9

ParameterValueX (where X is a number 1 to 100)

String value

The ParameterValueX property contains the value stored for parameter X. Note that which parameter is which number will not be same between presets as it is dependant of which parameters are actually store in the preset. The value format will vary from console to console and depend in what format the data is exported.

Example.

value = preset.ParameterValue9

PresetID

String value

The PresetID property is the preset identifier i.e. number.

PresetIDNumber

Numeric(integer) value

The PresetIDNumber property is the preset identifier i.e. number as an integer.

PresetName

String value

The PresetName property is the preset name.

PresetType

String value

The PresetType property is the preset type i.e. 10.All, Preset etc.