Moving Light Assistant - User contributions [en-gb]

PresetDocView:GetSelectedChannelCount

2019-01-22T00:00:29Z

Andyv wiki admin: Added Page.

===GetSelectedChannelCount()===
:''Returns an integer.''

This function will return the number of selected channel rows displayed in the Preset Documentation channel list.

''Example.''

:<code>numSelected = PresetDocView:GetSelectedChannelCount()</code>
This would assign to the variable ''numSelected'' the number of channels selected in the channel list.

''Available in MLA v1.3.2 Beta 5 onwards.''

PresetDocView:GetSelectedPresetCount

2019-01-21T23:59:20Z

Andyv wiki admin:

===GetSelectedPresetCount()===
:''Returns an integer.''

This function will return the number of selected preset rows displayed in the Preset Documentation preset list.

''Example.''

:<code>numSelected = PresetDocView:GetSelectedPresetCount()</code>
This would assign to the variable ''numSelected'' the number of presets selected in the preset list.

''Available in MLA v1.3.2 Beta 5 onwards.''

PresetDocView:GetSelectedPresetCount

2019-01-21T23:58:41Z

Andyv wiki admin: Added Page.

Preset Documentation View

2019-01-21T23:55:56Z

Andyv wiki admin: Added GetSelectedPresetCount & GetSelectedChannelCount

This page shows the functions that can be used within the Preset Documentation view, The Preset Documentation view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[DispatchAction]]
* [[PresetDocView:IsLastChannelRowSelected|IsLastChannelRowSelected]]
* [[PresetDocView:IsLastPresetRowSelected|IsLastPresetRowSelected]]
* [[PresetDocView:GetPhotoCountForSelectedPreset|GetPhotoCountForSelectedPreset]]
* [[PresetDocView:GetPhotoCountForSelectedChannel|GetPhotoCountForSelectedChannel]]
* [[PresetDocView:GetPresetCount|GetPresetCount]]
* [[PresetDocView:GetChannelCount|GetChannelCount]]
* [[PresetDocView:GetSelectedPresetCount|GetSelectedPresetCount]]
* [[PresetDocView:GetSelectedChannelCount|GetSelectedChannelCount]]
|}

CueInfo

2017-12-18T00:06:29Z

Andyv wiki admin:

The CueInfo class represents MLA specific data about a cue in the Cue List View. A CueInfo instance is stored independently of the imported console data and will not be modified or deleted by the importing of console data.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[CueInfo:GetSelectedCueInfo|GetSelectedCueInfo]]
* [[CueInfo:SaveCueInfo|SaveCueInfo]]
|}
{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Properties'''
|- border="0"
|
* [[CueInfo:Action|Action]]
* [[CueInfo:ActNumber|ActNumber]]
* [[CueInfo:CueNumber|CueNumber]]
* [[CueInfo:CueNumberAsNumeric|CueNumberAsNumeric]]
* [[CueInfo:Description|Description]]
* [[CueInfo:Image1Caption|Image1Caption]]
* [[CueInfo:Image1FileName|Image1FileName]]
* [[CueInfo:Image1UseReference|Image1UseReference]]
* [[CueInfo:Image1VectorData|Image1VectorData]]
* [[CueInfo:Image2Caption|Image2Caption]]
* [[CueInfo:Image2FileName|Image2FileName]]
* [[CueInfo:Image2UseReference|Image2UseReference]]
* [[CueInfo:Image2VectorData|Image2VectorData]]
|
* [[CueInfo:Image3Caption|Image3Caption]]
* [[CueInfo:Image3FileName|Image3FileName]]
* [[CueInfo:Image3UseReference|Image3UseReference]]
* [[CueInfo:Image3VectorData|Image3VectorData]]
* [[CueInfo:Image4Caption|Image4Caption]]
* [[CueInfo:Image4FileName|Image4FileName]]
* [[CueInfo:Image4UseReference|Image4UseReference]]
* [[CueInfo:Image4VectorData|Image4VectorData]]
* [[CueInfo:Notes|Notes]]
* [[CueInfo:Page|Page]]
* [[CueInfo:Part|Part]]
* [[CueInfo:SceneNumber|SceneNumber]]
* [[CueInfo:Scenery|Scenery]]
* [[CueInfo:SceneText|SceneText]]
|}

CueInfo

2017-12-18T00:05:54Z

Andyv wiki admin: Added additional properties

The CueInfo class represents MLA specific data about a cue in the Cue List View. A CueInfo instance is stored independently of the imported console data and will not be modified or deleted by the importing of console data.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[CueInfo:GetSelectedCueInfo|GetSelectedCueInfo]]
* [[CueInfo:SaveCueInfo|SaveCueInfo]]
|}
{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Properties'''
|- border="0"
|
* [[CueInfo:Action|Action]]
* [[CueInfo:ActNumber|ActNumber]]
* [[CueInfo:CueNumber|CueNumber]]
* [[CueInfo:CueNumberAsNumeric|CueNumberAsNumeric]]
* [[CueInfo:Description|Description]]
* [[CueInfo:Image1Caption|Image1Caption]]
* [[CueInfo:Image1FileName|Image1FileName]]
* [[CueInfo:Image1UseReference|Image1UseReference]]
* [[CueInfo:Image1VectorData|Image1VectorData]]
* [[CueInfo:Image2Caption|Image2Caption]]
* [[CueInfo:Image2FileName|Image2FileName]]
* [[CueInfo:Image2UseReference|Image2UseReference]]
* [[CueInfo:Image2VectorData|Image2VectorData]]
|
* [[CueInfo:Image3Caption|Image3Caption]]
* [[CueInfo:Image3FileName|Image3FileName]]
* [[CueInfo:Image3UseReference|Image3UseReference]]
* [[CueInfo:Image3VectorData|Image3VectorData]]
* [[CueInfo:Image4Caption|Image4Caption]]
* [[CueInfo:Image4FileName|Image4FileName]]
* [[CueInfo:Image4UseReference|Image4UseReference]]
* [[CueInfo:Image4VectorData|Image4VectorData]]
* [[CueInfo:Notes|Notes]]
* [[CueInfo:Page|Page]]
* [[CueInfo:Part|Part]]
* [[CueInfo:SceneNumber|SceneNumber]
* [[CueInfo:Scenery|Scenery]]
* [[CueInfo:SceneText|SceneText]
|}

CueInfo:SaveCueInfo

2017-12-18T00:00:41Z

Andyv wiki admin:

===SaveCueInfo(cueinfo)===
:''cueInfo is the CueInfo structure to save.''

Note this function is only available in MLA v1.3.1 Beta 14 and onwards.

This function will store the passed CueInfo structure. This is useful when the structure has been modified and the changes need storing. For every call to SaveCueInfo, an entry in the applications Undo/Redo stack will be created so that it is possible to Undo the action after the script has finished.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfo()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueinfo.Image1Caption = "Photo 1 Caption"</code>
::<code>SaveCueInfo(cueinfo)</code>
:<code>end</code>

CueInfo:GetSelectedCueInfo

2017-12-17T23:59:53Z

Andyv wiki admin:

===GetSelectedCueInfo()===
:''Returns an CueInfo structure.''

Note this function has a bug and does not work correctly prior to MLA v1.3.1 Beta 14.

This function will return a CueInfo structure for the currently selected cue in the Cue List view. It will return nil if no cue is selected. It is worth adding checking for this situation.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfo()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueNumber = cueinfo.CueNumber</code>
:<code>end</code>

CueInfo:SaveCueInfo

2017-12-17T23:59:07Z

Andyv wiki admin: Added Page.

===SaveCueInfo(cueinfo)===
:''cueInfo is the CueInfo structure to save.''

Note this function is only available in MLA v1.3.1 Beta 14 and onwards.

This function will store the passed CueInfo structure. This is useful when the structure has been modified and the changes need storing. For every call to SaveCueInfo, an entry in the applications Undo/Redo stack will be created so that it is possible to Undo the action after the script has finished.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfo()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueinfo.Notes = "Some cue notes"</code>
::<code>SaveCueInfo(cueinfo)</code>
:<code>end</code>

CueInfo:GetSelectedCueInfo

2017-12-17T23:52:50Z

Andyv wiki admin: Added page.

===GetSelectedCueInfo()===
:''Returns an CueInfo structure.''

Note this function has a bug and does not work correctly prior to MLA v1.3.1 Beta 14.

This function will return a CueInfo structure for the currently selected cue in the Cue List view. It will return nil if no cue is selected. It is worth adding checking for this situation.

''Example.''

:<code>cueinfo = CueInfo:GetSelectedCueInfot()</code>
:<code>if cueinfo ~= nil then</code>
::<code>cueNumber = cueinfo.CueNumber</code>
:<code>end</code>

CueInfo

2017-12-17T23:48:19Z

Andyv wiki admin: Updated CueInfo properties entries to open correct linked pages.

CueInfo

2017-12-17T23:40:38Z

Andyv wiki admin: Added Fuctions

RunAppleScript

2017-11-12T09:09:22Z

Andyv wiki admin: Page Added

===RunAppleScript( scriptString )===
:''scriptString is a string. The string is the text of the script.''
:''No Return value''
'''THIS FUNCTION WILL ONLY WORK ON macOS.''' 
'''This function is only available in MLA v1.3.1 Beta 7 onwards.'''

This function will run an Apple Script to allow control of the Finder and other applications. 

''Example..''. 
<code>-- This script will bring Image Capture to the front and simulate pressing the space bar</code> 
<code>-- to capture an image from the tethered camera.</code> 
<code>photoScript = "tell application \"Image Capture\"\n"</code> 
<code>photoScript = photoScript .. "activate\n"</code> 
<code>photoScript = photoScript .. "tell application \"System Events\"\n"</code> 
<code>photoScript = photoScript .. "key code 49\n"</code> 
<code>photoScript = photoScript .. "end tell\n"</code> 
<code>photoScript = photoScript .. "end tell\n"</code> 
<code>RunAppleScript(photoScript)</code> 
<code>Wait(0.5)</code> 
<code>-- We need MLA to be at the front to wait for image to arrive.</code> 
<code>mlaScript = "tell application \"Moving Light Assistant\"\n"</code> 
<code>mlaScript = mlaScript .. "activate\n"</code> 
<code>mlaScript = mlaScript .. "end tell\n"</code> 
<code>RunAppleScript(mlaScript)</code> 
<code>Wait(0.5)</code> 
Note that any quote character needs to be 'escaped', i.e. <code>tell application "Image Capture"</code> would need to have a '\' character before the quote to become <code>tell application \"Image Capture\"</code>

General

2017-11-12T09:01:05Z

Andyv wiki admin: Added RunAppleScript

These functions are general utility functions that extend the functionality of LUA scripting.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[MessageDialog]]
* [[PromptInputDialog]]
* [[PromptChoiceDialog]]
* [[Wait]]
* [[RunScript]]
* [[FormatTimecode]]
* [[FormattedTimeToMilliseconds]]
* [[FormattedTimeToSeconds]]
* [[TimecodeToMA2TCTime]]
* [[SendAppleEvent]]
* [[SendVx76AppleEvent]]
* [[RunAppleScript]]
|}

TimecodeToMA2TCTime

2017-02-20T23:17:21Z

Andyv wiki admin:

===TimecodeToMA2TCTime( timecodeString, fpsString )===
:''timecodeString is a string. This is a timecode string, i.e. 10.00.03.15''
:''fpsString is a string. This is the timecode base the timecodeString is in, i.e. 24, 25, 29.97, 30 or 100''
:''Returns an integer. This is the value of the timecodeString string in 30ths of a second''
'''This function is only available in MLA v1.3 onwards.'''

This function is used to convert a timecode string into an integer value that the grandMA2 console understands. The integer value is the timecode string as a value of 30ths of a second. The timecode string can have any separator between the hours, minutes, seconds and frames, as long as there is a separator.

''Code Example..''. 
<code>a = FormattedTimeToSeconds("00.00.05.00", "25")</code> 
The variable ''a'' would be assigned the value <code>150</code>

TimecodeToMA2TCTime

2017-02-20T23:16:31Z

Andyv wiki admin: Added Page.

===TimecodeToMA2TCTime( timecodeString, fpsString )===
:''timecodeString is a string. This is a timecode string, i.e. 10.00.03.15''
:''fpsString is a string. This is the timecode base the timecodeString is in, i.e. 24, 25, 29.97, 30 or 100''
:''Returns a integer. This is the value of the timecodeString string in 30ths of a second''
'''This function is only available in MLA v1.3 onwards.'''

This function is used to convert a timecode string into an integer value that the grandMA2 console understands. The integer value is the timecode string as a value of 30ths of a second. The timecode string can have any separator between the hours, minutes, seconds and frames, as long as there is a separator.

''Code Example..''. 
<code>a = FormattedTimeToSeconds("00.00.05.00", "25")</code> 
The variable ''a'' would be assigned the value <code>150</code>

General

2017-02-20T23:07:35Z

Andyv wiki admin: Added TimecodeToMA2TCTime

CueListView:DispatchAction

2016-12-19T14:15:27Z

Andyv wiki admin:

CueListView:DispatchAction

2016-12-19T12:00:11Z

Andyv wiki admin: Added Goto Cue

PresetInfo:GetSelectedChannel

2016-12-07T11:10:12Z

Andyv wiki admin: Added Page.

===GetSelectedChannel()===
:''Returns an PresetInfo structure.''

This function will return a PresetInfo structure for the currently selected channel in the channel list on the right in the main Preset Documentation view. It will return nil if no channel is selected. It is worth adding checking for this situation.

''Example.''

:<code>preset = PresetInfo:GetSelectedChannel()</code>
:<code>if preset ~= nil then</code>
::<code>presetName = preset.PresetName</code>
:<code>end</code>

PresetInfo:GetSelectedPreset

2016-12-07T11:07:59Z

Andyv wiki admin: Added Page - In Progress.

===GetSelectedPreset()===
:''Returns an PresetInfo structure.''

This function will return a PresetInfo structure for the currently selected preset in the preset list on the left in the main Preset Documentation view. If you want to access the channels in a preset, you should use PresetInfo:GetSelectedChannel(). It will return nil if no preset is selected. It is worth adding checking for this situation.

''Example.''

:<code>preset = PresetInfo:GetSelectedPreset()</code>
:<code>if preset ~= nil then</code>
::<code>presetName = preset.PresetName</code>
:<code>end</code>

PresetInfo

2016-12-07T10:54:37Z

Andyv wiki admin: Added Functions section

The PresetInfo class represents Presets and Channels in the Preset Documentation view. The class can represent a Preset or a Channel in a Preset. The PresetInfo class is stored independently of the imported console data.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[PresetInfo:GetSelectedPreset|GetSelectedPreset]]
* [[PresetInfo:GetSelectedChannel|GetSelectedChannel]]
|}

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Properties'''
|- border="0"
|
* [[PresetInfo:AutoPhotograph|AutoPhotograph]]
* [[PresetInfo:ChannelNumber|ChannelNumber]]
* [[PresetInfo:ChannelsUsePreset|ChannelsUsePreset]]
* [[PresetInfo:Cue|Cue]]
* [[PresetInfo:CueAsNumeric|CueAsNumeric]]
* [[PresetInfo:CueIsChannelSpecific|CueIsChannelSpecific]]
* [[PresetInfo:FixtureNumber|FixtureNumber]]
* [[PresetInfo:FixtureType|FixtureType]]
* [[PresetInfo:Image1Caption|Image1Caption]]
* [[PresetInfo:Image1FileName|Image1FileName]]
* [[PresetInfo:Image1UseReference|Image1UseReference]]
* [[PresetInfo:Image1VectorData|Image1VectorData]]
|
* [[PresetInfo:Image2Caption|Image2Caption]]
* [[PresetInfo:Image2FileName|Image2FileName]]
* [[PresetInfo:Image2UseReference|Image2UseReference]]
* [[PresetInfo:Image2VectorData|Image2VectorData]]
* [[PresetInfo:Image3Caption|Image3Caption]]
* [[PresetInfo:Image3FileName|Image3FileName]]
* [[PresetInfo:Image3UseReference|Image3UseReference]]
* [[PresetInfo:Image3VectorData|Image3VectorData]]
* [[PresetInfo:Image4Caption|Image4Caption]]
* [[PresetInfo:Image4FileName|Image4FileName]]
* [[PresetInfo:Image4UseReference|Image4UseReference]]
* [[PresetInfo:Image4VectorData|Image4VectorData]]
|
* [[PresetInfo:IsChannelEntry|IsChannelEntry]]
* [[PresetInfo:IsFocused|IsFocused]]
* [[PresetInfo:Notes|Notes]]
* [[PresetInfo:PresetID|PresetID]]
* [[PresetInfo:PresetIDAsNumeric|PresetIDAsNumeric]]
* [[PresetInfo:PresetName|PresetName]]
* [[PresetInfo:PresetOrder|PresetOrder]]
* [[PresetInfo:PresetType|PresetType]]
* [[PresetInfo:PresetUnused|PresetUnused]]
* [[PresetInfo:Priority|Priority]]
* [[PresetInfo:PriorityName|PriorityName]]
* [[PresetInfo:Scenery|Scenery]]
* [[PresetInfo:SequenceID|SequenceID]]
* [[PresetInfo:UseImage1|UseImage1]]
* [[PresetInfo:UseImage2|UseImage2]]
* [[PresetInfo:UseImage3|UseImage3]]
* [[PresetInfo:UseImage4|UseImage4]]
|}

PresetDocFixtureView:DispatchAction

2016-09-29T23:12:30Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===
Where a preset/channel has multiple photos, this will display the next photo.

===Display Previous Photo===
Where a preset/channel has multiple photos, this will display the previous photo.

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===
Will increment the channel/fixture number and display the relevant presets for the channel/fixture.

===Display Previous Channel/Fixture===
Will decrement the channel/fixture number and display the relevant presets for the channel/fixture.

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).

Will set if the preset list displays ignored presets.

===Set Channel Focussed===
:parameter (string) = ''Focussed'' checkbox state for presets displayed (True or False).

SUBJECT TO CHANGE !
Will set or clear the ''Focussed'' flag for the channel in all the presets displayed in the preset list.
Note, while the word ''Channel'' is used, it will apply if a fixture is displayed.

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

===Order By===
:parameter (string) = sort by item.

Will set the Order for the Fixtures Preset list. Works the same as ''Sort By'' but provided for consistency with the fixture view user interface. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:DispatchAction

2016-09-29T22:15:36Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===

===Display Previous Photo===

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===
Will increment the channel/fixture number and display the relevant presets for the channel/fixture.

===Display Previous Channel/Fixture===
Will decrement the channel/fixture number and display the relevant presets for the channel/fixture.

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).

Will set if the preset list displays ignored presets.

===Set Channel Focussed===
:parameter (string) = ''Focussed'' checkbox state for presets displayed (True or False).

Will set or clear the ''Focussed'' flag for the channel in all the presets displayed in the preset list.
Note, while the word ''Channel'' is used, it will apply if a fixture is displayed.

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

===Order By===
:parameter (string) = sort by item.

Will set the Order for the Fixtures Preset list. Works the same as ''Sort By'' but provided for consistency with the fixture view user interface. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:DispatchAction

2016-09-29T22:13:44Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===

===Display Previous Photo===

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===
Will increment the channel/fixture number and display the relevant presets for the channel/fixture.

===Display Previous Channel/Fixture===
Will decrement the channel/fixture number and display the relevant presets for the channel/fixture.

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).

Will set if the preset list displays ignored presets.

===Set Channel Focussed===
:parameter (string) = ''Focus'' checkbox state for presets displayed (True or False).

Will set or clear the ''Focus'' flag for the channel in all the presets displayed in the preset list.
Note, while the word ''Channel'' is used, it will apply if a fixture is displayed.

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

===Order By===
:parameter (string) = sort by item.

Will set the Order for the Fixtures Preset list. Works the same as ''Sort By'' but provided for consistency with the fixture view user interface. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:DispatchAction

2016-09-29T22:08:08Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===

===Display Previous Photo===

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===

===Display Previous Channel/Fixture===

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).
Will set if the preset list displays ignored presets.

===Set Channel Focussed===
:parameter (string) = ''Focus'' checkbox state for presets displayed (True or False).
Will set or clear the ''Focus'' flag for the channel in all the presets displayed in the preset list.
Note, while the word ''Channel'' is used, it will apply if a fixture is displayed.

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:DispatchAction

2016-09-29T17:50:30Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Next Photo===

===Display Previous Photo===

===Display Channel===
:parameter (string) = channel number.

===Display Fixture===
:parameter (string) = fixture number.

===Display Next Channel/Fixture===

===Display Previous Channel/Fixture===

===Set Hide Ignored===
:parameter (string) = checkbox state (True or False).

===Sort By===
:parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list. 
Sort Items... 
:<code>Focus Order</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Priority</code> 

Example. 
:<code>PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")</code>

DispatchAction

2016-09-29T17:41:22Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''

This function sends a user interface action to the Preset Documentation view. These actions would normally by triggered by clicking on the user interface, i.e. clicking on a toolbar button, or selecting a Preset in the Preset table.

''Example.''

:<code>PresetDocView:DispatchAction("Take Photo")</code>
This would send an action that would be the same as clicking on the camera (Take Photo) button.

:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>
This function with an optional parameter would be the same as clicking on the focussed checkbox for a channel, in this case setting the checkbox to it's True state (on).

==Action Strings==

===Take Photo===
This action would be the same as clicking on the camera (Take Photo) button. It will behave in the same way, in that it will add the photo to the Preset if the photo mode is set to Preset, and to a Channel if the photo mode is set to Channel. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Channel Photo===
This action will take a Channel photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Channel that was selected at the time the Take Channel Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Preset Photo===
This action will take a Preset photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Preset that was selected at the time the Take Preset Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Select First Preset===
Will select the first Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Presets===
Will select all the Presets in the Preset table on the left in the Preset Documentation view.

===Deselect All Presets===
Will deselect all the Presets in the Preset table on the left in the Preset Documentation view.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
''Available in MLA v1.3 onwards.'' 
Will select the specified Preset in the Preset table in the Preset Documentation view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Set Preset Name Text===
:parameter (string) = Preset Name text. i.e.<code>DS Back</code>.
Will set the 'Note' field for the selected Presets to the string sent as the parameter.

===Set Preset ID Text===
:parameter (string) = Preset ID text. i.e.<code>10.1</code>.
Will set the 'Preset ID' field for the selected Presets to the string sent as the parameter.

===Set Preset Type Text===
:parameter (string) = Preset Type text. i.e.<code>Colour</code>.
Will set the 'Preset Type' field for the selected Presets to the string sent as the parameter.

===Set Preset Focus Cue Text===
:parameter (string) = Preset Focus Cue text. i.e.<code>155</code>.
Will set the 'Focus Cue' field for the selected Presets to the string sent as the parameter.

===Set Preset Set Text===
:parameter (string) = Preset Set text. i.e.<code>Open Stage</code>.
Will set the 'Set' field for the selected Presets to the string sent as the parameter.

===Select First Channel===
Will select the first Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the first channel in the channel table. Note that table will not scroll to show the selection.

===Select Last Channel===
Will select the last Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the last Channel in the Channel table. Note that table will not scroll to show the selection.

===Select Next Channel===
Will select the next Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will select the first Channel. Note that table will not scroll to show the selection.

===Select Previous Channel===
Will select the previous Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Channels===
Will select all the Channels in the Channel table on the right in the Preset Documentation view.

===Deselect All Channels===
Will deselect all the Channels in the Channel table on the right in the Preset Documentation view.

===Set Preset Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Preset as opposed to the Channel.

===Set Channel Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Channel as opposed to the Preset.

===Set Channel Focused Flag===
:parameter as string = <code>True</code> or <code>False</code>
Will set the 'Focussed' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Auto Flag===
:parameter (string) = <code>True</code> or <code>False</code>
Will set the 'Auto' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Focus Cue===
:parameter (string) = Cue Number text. i.e.<code>424</code>.
Will set the 'Focus Cue' field of the selected Channels to the string sent as the parameter.

===Set Channel Note===
:parameter (string) = Note text to set from Channel. i.e.<code>Downstage Backlight</code>.
Will set the 'Note' field for the selected Channels to the string sent as the parameter.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Channel Photo===
:parameter (string) = Photo number (1-4).
Will display the specified channel photo for the selected channel. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Channel Photo===
Will display the first channel photo for the selected channel.

===Display Last Channel Photo===
Will display the last channel photo for the selected channel.

===Sort By===
:parameter (string) = sort by item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Sort for the preset list. 
Sort Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 
The name of user created sort may also be used. 
Example. 
:<code>PresetDocView:DispatchAction("Sort By", "Preset ID")</code>

===Filter By===
:parameter (string) = filter item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Filter for the preset list. 
Filter Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Preset Name</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 

===Filter Text===
:parameter (string) = The text to filter by.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the text to be used by the filter. 
Example. 
:<code>PresetDocView:DispatchAction("Filter By", "Set")</code>
:<code>PresetDocView:DispatchAction("Filter Text", "Courtyard")</code>

==Examples==
===Setting all channels focused flags to true===
The example below will simply set all channels for the selected preset to focused.
:<code>PresetDocView:DispatchAction("Select All Channels")</code>
:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>

===Removing all channel photos===
The example below will remove all the channel photos for the selected preset.
:<code>numChannels = PresetDocView:GetChannelCount()</code>
:<code>if numChannels > 0 then</code>
::<code>PresetDocView:DispatchAction("Select First Channel")</code>
::<code>currentChannel = 1</code>
::<code>while currentChannel <= numChannels do</code>
:::<code>numPhotos = PresetDocView:GetPhotoCountForSelectedChannel()</code>
:::<code>if numPhotos > 0 then</code>
::::<code>while numPhotos > 0 do</code>
:::::<code>PresetDocView:DispatchAction("Display Channel Photo", numPhotos)</code>
:::::<code>PresetDocView:DispatchAction("Remove Displayed Channel Photo")</code>
:::::<code>numPhotos = numPhotos - 1</code>
::::<code>end</code>
:::<code>end</code>
:::<code>PresetDocView:DispatchAction("Select Next Channel")</code>
:::<code>currentChannel = currentChannel + 1</code>
::<code>end</code>
:<code>end</code>

DispatchAction

2016-09-29T17:40:18Z

Andyv wiki admin:

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''

This function sends a user interface action to the Preset Documentation view. These actions would normally by triggered by clicking on the user interface, i.e. clicking on a toolbar button, or selecting a Preset in the Preset table.

''Example.''

:<code>PresetDocView:DispatchAction("Take Photo")</code>
This would send an action that would be the same as clicking on the camera (Take Photo) button.

:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>
This function with an optional parameter would be the same as clicking on the focussed checkbox for a channel, in this case setting the checkbox to it's True state (on).

==Action Strings==

===Take Photo===
This action would be the same as clicking on the camera (Take Photo) button. It will behave in the same way, in that it will add the photo to the Preset if the photo mode is set to Preset, and to a Channel if the photo mode is set to Channel. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Channel Photo===
This action will take a Channel photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Channel that was selected at the time the Take Channel Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Preset Photo===
This action will take a Preset photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Preset that was selected at the time the Take Preset Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Select First Preset===
Will select the first Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Presets===
Will select all the Presets in the Preset table on the left in the Preset Documentation view.

===Deselect All Presets===
Will deselect all the Presets in the Preset table on the left in the Preset Documentation view.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
''Available in MLA v1.3 onwards.'' 
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Set Preset Name Text===
:parameter (string) = Preset Name text. i.e.<code>DS Back</code>.
Will set the 'Note' field for the selected Presets to the string sent as the parameter.

===Set Preset ID Text===
:parameter (string) = Preset ID text. i.e.<code>10.1</code>.
Will set the 'Preset ID' field for the selected Presets to the string sent as the parameter.

===Set Preset Type Text===
:parameter (string) = Preset Type text. i.e.<code>Colour</code>.
Will set the 'Preset Type' field for the selected Presets to the string sent as the parameter.

===Set Preset Focus Cue Text===
:parameter (string) = Preset Focus Cue text. i.e.<code>155</code>.
Will set the 'Focus Cue' field for the selected Presets to the string sent as the parameter.

===Set Preset Set Text===
:parameter (string) = Preset Set text. i.e.<code>Open Stage</code>.
Will set the 'Set' field for the selected Presets to the string sent as the parameter.

===Select First Channel===
Will select the first Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the first channel in the channel table. Note that table will not scroll to show the selection.

===Select Last Channel===
Will select the last Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the last Channel in the Channel table. Note that table will not scroll to show the selection.

===Select Next Channel===
Will select the next Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will select the first Channel. Note that table will not scroll to show the selection.

===Select Previous Channel===
Will select the previous Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Channels===
Will select all the Channels in the Channel table on the right in the Preset Documentation view.

===Deselect All Channels===
Will deselect all the Channels in the Channel table on the right in the Preset Documentation view.

===Set Preset Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Preset as opposed to the Channel.

===Set Channel Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Channel as opposed to the Preset.

===Set Channel Focused Flag===
:parameter as string = <code>True</code> or <code>False</code>
Will set the 'Focussed' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Auto Flag===
:parameter (string) = <code>True</code> or <code>False</code>
Will set the 'Auto' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Focus Cue===
:parameter (string) = Cue Number text. i.e.<code>424</code>.
Will set the 'Focus Cue' field of the selected Channels to the string sent as the parameter.

===Set Channel Note===
:parameter (string) = Note text to set from Channel. i.e.<code>Downstage Backlight</code>.
Will set the 'Note' field for the selected Channels to the string sent as the parameter.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Channel Photo===
:parameter (string) = Photo number (1-4).
Will display the specified channel photo for the selected channel. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Channel Photo===
Will display the first channel photo for the selected channel.

===Display Last Channel Photo===
Will display the last channel photo for the selected channel.

===Sort By===
:parameter (string) = sort by item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Sort for the preset list. 
Sort Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 
The name of user created sort may also be used. 
Example. 
:<code>PresetDocView:DispatchAction("Sort By", "Preset ID")</code>

===Filter By===
:parameter (string) = filter item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Filter for the preset list. 
Filter Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Preset Name</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 

===Filter Text===
:parameter (string) = The text to filter by.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the text to be used by the filter. 
Example. 
:<code>PresetDocView:DispatchAction("Filter By", "Set")</code>
:<code>PresetDocView:DispatchAction("Filter Text", "Courtyard")</code>

==Examples==
===Setting all channels focused flags to true===
The example below will simply set all channels for the selected preset to focused.
:<code>PresetDocView:DispatchAction("Select All Channels")</code>
:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>

===Removing all channel photos===
The example below will remove all the channel photos for the selected preset.
:<code>numChannels = PresetDocView:GetChannelCount()</code>
:<code>if numChannels > 0 then</code>
::<code>PresetDocView:DispatchAction("Select First Channel")</code>
::<code>currentChannel = 1</code>
::<code>while currentChannel <= numChannels do</code>
:::<code>numPhotos = PresetDocView:GetPhotoCountForSelectedChannel()</code>
:::<code>if numPhotos > 0 then</code>
::::<code>while numPhotos > 0 do</code>
:::::<code>PresetDocView:DispatchAction("Display Channel Photo", numPhotos)</code>
:::::<code>PresetDocView:DispatchAction("Remove Displayed Channel Photo")</code>
:::::<code>numPhotos = numPhotos - 1</code>
::::<code>end</code>
:::<code>end</code>
:::<code>PresetDocView:DispatchAction("Select Next Channel")</code>
:::<code>currentChannel = currentChannel + 1</code>
::<code>end</code>
:<code>end</code>

DispatchAction

2016-09-29T17:39:40Z

Andyv wiki admin: Added Select Preset

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''

This function sends a user interface action to the Preset Documentation view. These actions would normally by triggered by clicking on the user interface, i.e. clicking on a toolbar button, or selecting a Preset in the Preset table.

''Example.''

:<code>PresetDocView:DispatchAction("Take Photo")</code>
This would send an action that would be the same as clicking on the camera (Take Photo) button.

:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>
This function with an optional parameter would be the same as clicking on the focussed checkbox for a channel, in this case setting the checkbox to it's True state (on).

==Action Strings==

===Take Photo===
This action would be the same as clicking on the camera (Take Photo) button. It will behave in the same way, in that it will add the photo to the Preset if the photo mode is set to Preset, and to a Channel if the photo mode is set to Channel. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Channel Photo===
This action will take a Channel photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Channel that was selected at the time the Take Channel Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Preset Photo===
This action will take a Preset photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Preset that was selected at the time the Take Preset Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Select First Preset===
Will select the first Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Presets===
Will select all the Presets in the Preset table on the left in the Preset Documentation view.

===Deselect All Presets===
Will deselect all the Presets in the Preset table on the left in the Preset Documentation view.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
''Available in MLA v1.3 onwards.''
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Set Preset Name Text===
:parameter (string) = Preset Name text. i.e.<code>DS Back</code>.
Will set the 'Note' field for the selected Presets to the string sent as the parameter.

===Set Preset ID Text===
:parameter (string) = Preset ID text. i.e.<code>10.1</code>.
Will set the 'Preset ID' field for the selected Presets to the string sent as the parameter.

===Set Preset Type Text===
:parameter (string) = Preset Type text. i.e.<code>Colour</code>.
Will set the 'Preset Type' field for the selected Presets to the string sent as the parameter.

===Set Preset Focus Cue Text===
:parameter (string) = Preset Focus Cue text. i.e.<code>155</code>.
Will set the 'Focus Cue' field for the selected Presets to the string sent as the parameter.

===Set Preset Set Text===
:parameter (string) = Preset Set text. i.e.<code>Open Stage</code>.
Will set the 'Set' field for the selected Presets to the string sent as the parameter.

===Select First Channel===
Will select the first Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the first channel in the channel table. Note that table will not scroll to show the selection.

===Select Last Channel===
Will select the last Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the last Channel in the Channel table. Note that table will not scroll to show the selection.

===Select Next Channel===
Will select the next Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will select the first Channel. Note that table will not scroll to show the selection.

===Select Previous Channel===
Will select the previous Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Channels===
Will select all the Channels in the Channel table on the right in the Preset Documentation view.

===Deselect All Channels===
Will deselect all the Channels in the Channel table on the right in the Preset Documentation view.

===Set Preset Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Preset as opposed to the Channel.

===Set Channel Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Channel as opposed to the Preset.

===Set Channel Focused Flag===
:parameter as string = <code>True</code> or <code>False</code>
Will set the 'Focussed' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Auto Flag===
:parameter (string) = <code>True</code> or <code>False</code>
Will set the 'Auto' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Focus Cue===
:parameter (string) = Cue Number text. i.e.<code>424</code>.
Will set the 'Focus Cue' field of the selected Channels to the string sent as the parameter.

===Set Channel Note===
:parameter (string) = Note text to set from Channel. i.e.<code>Downstage Backlight</code>.
Will set the 'Note' field for the selected Channels to the string sent as the parameter.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Channel Photo===
:parameter (string) = Photo number (1-4).
Will display the specified channel photo for the selected channel. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Channel Photo===
Will display the first channel photo for the selected channel.

===Display Last Channel Photo===
Will display the last channel photo for the selected channel.

===Sort By===
:parameter (string) = sort by item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Sort for the preset list. 
Sort Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 
The name of user created sort may also be used. 
Example. 
:<code>PresetDocView:DispatchAction("Sort By", "Preset ID")</code>

===Filter By===
:parameter (string) = filter item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Filter for the preset list. 
Filter Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Preset Name</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 

===Filter Text===
:parameter (string) = The text to filter by.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the text to be used by the filter. 
Example. 
:<code>PresetDocView:DispatchAction("Filter By", "Set")</code>
:<code>PresetDocView:DispatchAction("Filter Text", "Courtyard")</code>

==Examples==
===Setting all channels focused flags to true===
The example below will simply set all channels for the selected preset to focused.
:<code>PresetDocView:DispatchAction("Select All Channels")</code>
:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>

===Removing all channel photos===
The example below will remove all the channel photos for the selected preset.
:<code>numChannels = PresetDocView:GetChannelCount()</code>
:<code>if numChannels > 0 then</code>
::<code>PresetDocView:DispatchAction("Select First Channel")</code>
::<code>currentChannel = 1</code>
::<code>while currentChannel <= numChannels do</code>
:::<code>numPhotos = PresetDocView:GetPhotoCountForSelectedChannel()</code>
:::<code>if numPhotos > 0 then</code>
::::<code>while numPhotos > 0 do</code>
:::::<code>PresetDocView:DispatchAction("Display Channel Photo", numPhotos)</code>
:::::<code>PresetDocView:DispatchAction("Remove Displayed Channel Photo")</code>
:::::<code>numPhotos = numPhotos - 1</code>
::::<code>end</code>
:::<code>end</code>
:::<code>PresetDocView:DispatchAction("Select Next Channel")</code>
:::<code>currentChannel = currentChannel + 1</code>
::<code>end</code>
:<code>end</code>

PresetDocFixtureView:DispatchAction

2016-09-29T17:37:32Z

Andyv wiki admin: Added Page - In Progress.

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''
''Available in MLA v1.3 onwards.''

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

:<code>PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")</code>
This function with an optional parameter would be the same as clicking on the ''Hide Ignored'' checkbox. In this case, the it will set to False (off).

==Action Strings==

===Select First Preset===
Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select Preset===
:parameter (string) = Preset Type and/or Preset ID. i.e.<code>Preset,27</code>.
Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

:''Examples.''
:<code>PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")</code>
:This will select specifically Preset Type <code>Preset</code> with the Preset ID of <code>27</code>.

:<code>PresetDocFixtureView:DispatchAction("Select Preset", "46")</code>
:This will select the first Preset, regardless of Preset Type with a Preset ID of <code>46</code>.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Sort By===
:parameter (string) = sort by item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Sort for the preset list. 
Sort Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 
The name of user created sort may also be used. 
Example. 
:<code>PresetDocView:DispatchAction("Sort By", "Preset ID")</code>

PresetDocFixtureView:GetPresetCount

2016-09-29T17:03:08Z

Andyv wiki admin: Added Page.

===GetPresetCount()===
:''Returns an integer.''
:''Available in MLA v1.3 onwards.''

This function will return the number of preset rows displayed in the Preset Documentation Fixture preset list.

''Example.''

:<code>numPresets = PresetDocFixtureView:GetPresetCount()</code>
This would assign to the variable ''numPresets'' the number of presets displayed in the fixture preset list.

Preset Documentation Fixture View

2016-09-29T17:00:31Z

Andyv wiki admin:

''Available in MLA v1.3 onwards.'' 
This page shows the functions that can be used within the Preset Documentation Fixture view. The Preset Documentation Fixture view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[PresetDocFixtureView:DispatchAction|DispatchAction]]
* [[PresetDocFixtureView:IsLastPresetRowSelected|IsLastPresetRowSelected]]
* [[PresetDocFixtureView:GetPresetCount|GetPresetCount]]
|}

PresetDocFixtureView:IsLastPresetRowSelected

2016-09-29T16:58:56Z

Andyv wiki admin: Added Page.

===IsLastPresetRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last preset is selected in the fixture preset list, otherwise will return false. Useful when iterating through the preset list.

''Example.''

:<code>PresetDocFixtureView:DispatchAction("Select First Preset")</code>
:<code>presetListFinished = false</code>

:<code>while presetListFinished == false do</code>
::<code> -- Insert code here to do what you want with the preset.</code>
::<code> -- Continue to next preset, or are we done.</code>
::<code> if PresetDocFixtureView:IsLastPresetRowSelected() == true then</code>
:::<code> presetListFinished = true</code>
::<code> else</code>
:::<code> PresetDocFixtureView:DispatchAction("Select Next Preset")</code>
::<code> end</code>
:<code>end</code>
This will select the first preset in the preset list and step through all the displayed presets.

Preset Documentation Fixture View

2016-09-29T16:56:08Z

Andyv wiki admin: Added Page.

This page shows the functions that can be used within the Preset Documentation Fixture view, The Preset Documentation Fixture view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[PresetDocFixtureView:DispatchAction|DispatchAction]]
* [[PresetDocFixtureView:IsLastPresetRowSelected|IsLastPresetRowSelected]]
* [[PresetDocFixtureView:GetPresetCount|GetPresetCount]]
|}

Main Page

2016-09-29T16:53:33Z

Andyv wiki admin: /* Functions */ Added Preset Documentation Fixture View

'''MOVING LIGHT ASSISTANT WIKI'''
----
= Scripting Documentation =
''Moving Light Assistant'' version 1.2 onwards has support for running scripts to automate actions within Moving Light Assistant and to extend the functionality of the application.
* [[Scripting Language]]
* [[Scripting Implementation]]
* [[Copyright & Legal Notices]]
* [[MLA Specific Global Variables]]
== Functions ==
* [[Document]]
* [[Rig Data View]]
* [[Preset Documentation View]]
* [[Preset Documentation Fixture View]]
* [[Cue List View]]
* [[Telnet]]
* [[General]]
* [[OSC]]

== Classes ==
* [[PresetInfo]]
* [[CueInfo]]
* [[Cue]]
* [[Fixture]]

== Comment Options ==
Comment options are text in a script that is commented and set options for the script. For example this could be how the script is triggered of if the script should display its output window.
* [[TriggerType]]
* [[TriggerKey]]
* [[Macro]]
* [[DisplayOutputWindow]]
* [[OutputFileType]]

[[Martin's Sandpit]]

Copyright & Legal Notices

2016-09-22T06:36:42Z

Andyv wiki admin: Edited copyright dates.

= Moving Light Assistant =
The Moving Light Assistant application, logo and documentation are Copyright © 2016 Andrew Voller Lighting Design Limited.

= LUA =
Copyright © 1994–2016 Lua.org, PUC-Rio.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

PresetDocView:IsLastChannelRowSelected

2016-09-22T06:27:52Z

Andyv wiki admin: Page created.

===IsLastChannelRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last channel is selected in the channel list for the selected preset, otherwise will return false. Useful when iterating through the channel list.

''Example.''

:<code>PresetDocView:DispatchAction("Select First Channel")</code>
:<code>channelListFinished = false</code>

:<code>while channelListFinished == false do</code>
::<code> -- Insert code here to do what you want with the channel.</code>
::<code> -- Continue to next channel, or are we done.</code>
::<code> if PresetDocView:IsLastChannelRowSelected() == true then</code>
:::<code> channelListFinished = true</code>
::<code> else</code>
:::<code> PresetDocView:DispatchAction("Select Next Channel")</code>
::<code> end</code>
:<code>end</code>
This select the first channel in the channel list and step through all the displayed channels.

PresetDocView:IsLastPresetRowSelected

2016-09-22T06:21:17Z

Andyv wiki admin: Page created.

===IsLastPresetRowSelected()===
:''Returns a boolean.''
''Available in MLA v1.3 onwards.''

This function will return true if the last preset is selected in the preset list, otherwise will return false. Useful when iterating through the preset list.

''Example.''

:<code>PresetDocView:DispatchAction("Select First Preset")</code>
:<code>presetListFinished = false</code>

:<code>while presetListFinished == false do</code>
::<code> -- Insert code here to do what you want with the preset.</code>
::<code> -- Continue to next preset, or are we done.</code>
::<code> if PresetDocView:IsLastPresetRowSelected() == true then</code>
:::<code> presetListFinished = true</code>
::<code> else</code>
:::<code> PresetDocView:DispatchAction("Select Next Preset")</code>
::<code> end</code>
:<code>end</code>
This select the first preset in the preset list and step through all the displayed presets.

OutputFileType

2016-06-20T09:59:57Z

Andyv wiki admin: Added Page.

All comments in LUA start with a <code>--</code> 
When you are using the Output window to save the output of a script, you can automatically specify the type of file the Output window will save the script output as. It will set the File Type popup menu which adds the correct file type ending to the file name when you save. 
To save as a plain text file use...
:<code>-- OutputFileType=Text</code>
To save as a CSV text file use...
:<code>-- OutputFileType=CSV</code>
To save as a XML text file use...
:<code>-- OutputFileType=XML</code>

Main Page

2016-06-20T09:54:40Z

Andyv wiki admin: Added OutputFileType

'''MOVING LIGHT ASSISTANT WIKI'''
----
= Scripting Documentation =
''Moving Light Assistant'' version 1.2 onwards has support for running scripts to automate actions within Moving Light Assistant and to extend the functionality of the application.
* [[Scripting Language]]
* [[Scripting Implementation]]
* [[Copyright & Legal Notices]]
* [[MLA Specific Global Variables]]
== Functions ==
* [[Document]]
* [[Rig Data View]]
* [[Preset Documentation View]]
* [[Cue List View]]
* [[Telnet]]
* [[General]]
* [[OSC]]

== Classes ==
* [[PresetInfo]]
* [[CueInfo]]
* [[Cue]]
* [[Fixture]]

== Comment Options ==
Comment options are text in a script that is commented and set options for the script. For example this could be how the script is triggered of if the script should display its output window.
* [[TriggerType]]
* [[TriggerKey]]
* [[Macro]]
* [[DisplayOutputWindow]]
* [[OutputFileType]]

[[Martin's Sandpit]]

SendAppleEvent

2015-12-29T16:57:29Z

Andyv wiki admin: Added Page.

===SendAppleEvent( eventClass, eventID, bundleID, actionString )===
:''eventClass is a string. This is the four character AppleEvent class code.''
:''eventID is a string. This is the four character AppleEvent ID.''
:''bundleID is a string. This identifies the target application for the AppleEvent.''
:''actionString is a string. This is the event action to send to the target application.''
:''No Return value''
'''THIS FUNCTION WILL ONLY WORK ON MAC OS X.''' 
'''This function is only available in MLA v1.2.1 Beta 6 onwards.'''

This function will send an Apple Event to another application running on the same computer. If the target application supports Apple Events, you may be able to remote control the application from a script. 

''Example..''. 
<code>SendAppleEvent("VIRT", "Even", "com.PRG.Vx76", "Select + Channel 1")</code> 
This will send an Apple Event to the PRG Vx76 application telling it to add channel 1 to the selection currently on the console.

SendVx76AppleEvent

2015-12-29T16:45:52Z

Andyv wiki admin: Added Page.

===SendVx76AppleEvent( actionString )===
:''actionString is a string. This is the event to send to the console.''
:''No Return value''
'''THIS FUNCTION WILL ONLY WORK ON MAC OS X.''' 
'''This function is only available in MLA v1.2.1 Beta 6 onwards.'''

This function will send an Apple Event to the PRG Vx76 application with the action in the supplied string. Many actions are the same as the commands used on the command line of the console. This can allow remote control of the console. 

''Example..''. 
<code>SendVx76AppleEvent("Select + Channel 1")</code> 
This will add channel 1 to the selection currently on the console.

General

2015-12-29T16:38:48Z

Andyv wiki admin: Added SendAppleEvent and SendVx76AppleEvent.

Cue List View

2015-12-28T16:13:05Z

Andyv wiki admin:

This page shows the functions that can be used within the Cue List view, The Cue List view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[CueListView:DispatchAction|DispatchAction]]
* [[CueListView:GetCueRowCount|GetCueRowCount]]
* [[CueListView:GetPhotoCountForSelectedCue|GetPhotoCountForSelectedCue]]
* [[CueListView:IsLastCueRowSelected|IsLastCueRowSelected]]
|}

Cue List View

2015-12-28T16:12:40Z

Andyv wiki admin: Added IsLastCueRowSelected

Rig Data View

2015-12-28T16:11:27Z

Andyv wiki admin: Added IsLastFixtureRowSelected.

This page shows the functions that can be used within the Rig Data view, The Rig Data view does not need to be visible at the time these functions are called from a script.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Functions'''
|- border="0"
|
* [[RigDataView:DispatchAction|DispatchAction]]
* [[RigDataView:GetFixtureCount|GetFixtureCount]]
* [[RigDataView:IsLastFixtureRowSelected|IsLastFixtureRowSelected]]
|}

Preset Documentation View

2015-12-28T16:09:49Z

Andyv wiki admin: Added IsLastChannelRowSelected and IsLastPresetRowSelected.

DispatchAction

2015-12-28T16:05:32Z

Andyv wiki admin: Added Sort By, Filter By and Filter Text.

===DispatchAction( action, optionalParameter )===
:''action is a string.''
:''optionalParameter is a string (only some actions require the optionalParameter).''

This function sends a user interface action to the Preset Documentation view. These actions would normally by triggered by clicking on the user interface, i.e. clicking on a toolbar button, or selecting a Preset in the Preset table.

''Example.''

:<code>PresetDocView:DispatchAction("Take Photo")</code>
This would send an action that would be the same as clicking on the camera (Take Photo) button.

:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>
This function with an optional parameter would be the same as clicking on the focussed checkbox for a channel, in this case setting the checkbox to it's True state (on).

==Action Strings==

===Take Photo===
This action would be the same as clicking on the camera (Take Photo) button. It will behave in the same way, in that it will add the photo to the Preset if the photo mode is set to Preset, and to a Channel if the photo mode is set to Channel. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Channel Photo===
This action will take a Channel photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Channel that was selected at the time the Take Channel Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Take Preset Photo===
This action will take a Preset photo regardless of the Channel/Preset photo mode radio buttons. The advantage of this method of taking photos is that the taken photo will always be saved to the Preset that was selected at the time the Take Preset Photo command is sent. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a Preset or a Channel). :There is no optional parameter.

===Select First Preset===
Will select the first Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Last Preset===
Will select the last Preset in the Preset table on the left in the Preset Documentation view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

===Select Next Preset===
Will select the next Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

===Select Previous Preset===
Will select the previous Preset in the Preset table on the left in the Preset Documentation view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Presets===
Will select all the Presets in the Preset table on the left in the Preset Documentation view.

===Deselect All Presets===
Will deselect all the Presets in the Preset table on the left in the Preset Documentation view.

===Set Preset Name Text===
:parameter (string) = Preset Name text. i.e.<code>DS Back</code>.
Will set the 'Note' field for the selected Presets to the string sent as the parameter.

===Set Preset ID Text===
:parameter (string) = Preset ID text. i.e.<code>10.1</code>.
Will set the 'Preset ID' field for the selected Presets to the string sent as the parameter.

===Set Preset Type Text===
:parameter (string) = Preset Type text. i.e.<code>Colour</code>.
Will set the 'Preset Type' field for the selected Presets to the string sent as the parameter.

===Set Preset Focus Cue Text===
:parameter (string) = Preset Focus Cue text. i.e.<code>155</code>.
Will set the 'Focus Cue' field for the selected Presets to the string sent as the parameter.

===Set Preset Set Text===
:parameter (string) = Preset Set text. i.e.<code>Open Stage</code>.
Will set the 'Set' field for the selected Presets to the string sent as the parameter.

===Select First Channel===
Will select the first Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the first channel in the channel table. Note that table will not scroll to show the selection.

===Select Last Channel===
Will select the last Channel in the Channel table on the right in the Preset Documentation view. It is the same as if you had clicked on the last Channel in the Channel table. Note that table will not scroll to show the selection.

===Select Next Channel===
Will select the next Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will select the first Channel. Note that table will not scroll to show the selection.

===Select Previous Channel===
Will select the previous Channel in the Channel table on the right in the Preset Documentation view. If no Channel was previously selected, it will not do anything. Note that table will not scroll to show the selection.

===Select All Channels===
Will select all the Channels in the Channel table on the right in the Preset Documentation view.

===Deselect All Channels===
Will deselect all the Channels in the Channel table on the right in the Preset Documentation view.

===Set Preset Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Preset as opposed to the Channel.

===Set Channel Photo Mode===
This will set the photo mode so that any image adding, deletion, edit, capture or photo display are for the Channel as opposed to the Preset.

===Set Channel Focused Flag===
:parameter as string = <code>True</code> or <code>False</code>
Will set the 'Focussed' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Auto Flag===
:parameter (string) = <code>True</code> or <code>False</code>
Will set the 'Auto' checkbox for the selected Channel to on (True) or off (False).

===Set Channel Focus Cue===
:parameter (string) = Cue Number text. i.e.<code>424</code>.
Will set the 'Focus Cue' field of the selected Channels to the string sent as the parameter.

===Set Channel Note===
:parameter (string) = Note text to set from Channel. i.e.<code>Downstage Backlight</code>.
Will set the 'Note' field for the selected Channels to the string sent as the parameter.

===Display Preset Photo===
:parameter (string) = Photo number (1-4).
Will display the specified preset photo for the selected preset. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Preset Photo===
Will display the first preset photo for the selected preset.

===Display Last Preset Photo===
Will display the last preset photo for the selected preset.

===Display Channel Photo===
:parameter (string) = Photo number (1-4).
Will display the specified channel photo for the selected channel. If the photo number is greater than the number of photos, then the last photo will be displayed.

===Display First Channel Photo===
Will display the first channel photo for the selected channel.

===Display Last Channel Photo===
Will display the last channel photo for the selected channel.

===Sort By===
:parameter (string) = sort by item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Sort for the preset list. 
Sort Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 
The name of user created sort may also be used. 
Example. 
:<code>PresetDocView:DispatchAction("Sort By", "Preset ID")</code>

===Filter By===
:parameter (string) = filter item.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the Filter for the preset list. 
Filter Items... 
:<code>Preset Type</code> 
:<code>Preset ID</code> 
:<code>Preset Name</code> 
:<code>Focus Cue</code> 
:<code>Set</code> 
:<code>Focussed</code> 
:<code>Priority</code> 

===Filter Text===
:parameter (string) = The text to filter by.
'''Only version 1.2.1 Beta 6 onwards.''' 
Will set the text to be used by the filter. 
Example. 
:<code>PresetDocView:DispatchAction("Filter By", "Set")</code>
:<code>PresetDocView:DispatchAction("Filter Text", "Courtyard")</code>

==Examples==
===Setting all channels focused flags to true===
The example below will simply set all channels for the selected preset to focused.
:<code>PresetDocView:DispatchAction("Select All Channels")</code>
:<code>PresetDocView:DispatchAction("Set Channel Focused Flag", "True")</code>

===Removing all channel photos===
The example below will remove all the channel photos for the selected preset.
:<code>numChannels = PresetDocView:GetChannelCount()</code>
:<code>if numChannels > 0 then</code>
::<code>PresetDocView:DispatchAction("Select First Channel")</code>
::<code>currentChannel = 1</code>
::<code>while currentChannel <= numChannels do</code>
:::<code>numPhotos = PresetDocView:GetPhotoCountForSelectedChannel()</code>
:::<code>if numPhotos > 0 then</code>
::::<code>while numPhotos > 0 do</code>
:::::<code>PresetDocView:DispatchAction("Display Channel Photo", numPhotos)</code>
:::::<code>PresetDocView:DispatchAction("Remove Displayed Channel Photo")</code>
:::::<code>numPhotos = numPhotos - 1</code>
::::<code>end</code>
:::<code>end</code>
:::<code>PresetDocView:DispatchAction("Select Next Channel")</code>
:::<code>currentChannel = currentChannel + 1</code>
::<code>end</code>
:<code>end</code>

PresetInfo

2015-12-27T23:21:57Z

Andyv wiki admin: Added PriorityName

The PresetInfo class represents Presets and Channels in the Preset Documentation view. The class can represent a Preset or a Channel in a Preset. The PresetInfo class is stored independently of the imported console data.

{| style="border: 1px solid darkgray;" cellpadding="5" cellspacing="0" width="600"
|-
| colspan="3" align="left" style="background:#efefef;"| '''Properties'''
|- border="0"
|
* [[PresetInfo:AutoPhotograph|AutoPhotograph]]
* [[PresetInfo:ChannelNumber|ChannelNumber]]
* [[PresetInfo:ChannelsUsePreset|ChannelsUsePreset]]
* [[PresetInfo:Cue|Cue]]
* [[PresetInfo:CueAsNumeric|CueAsNumeric]]
* [[PresetInfo:CueIsChannelSpecific|CueIsChannelSpecific]]
* [[PresetInfo:FixtureNumber|FixtureNumber]]
* [[PresetInfo:FixtureType|FixtureType]]
* [[PresetInfo:Image1Caption|Image1Caption]]
* [[PresetInfo:Image1FileName|Image1FileName]]
* [[PresetInfo:Image1UseReference|Image1UseReference]]
* [[PresetInfo:Image1VectorData|Image1VectorData]]
|
* [[PresetInfo:Image2Caption|Image2Caption]]
* [[PresetInfo:Image2FileName|Image2FileName]]
* [[PresetInfo:Image2UseReference|Image2UseReference]]
* [[PresetInfo:Image2VectorData|Image2VectorData]]
* [[PresetInfo:Image3Caption|Image3Caption]]
* [[PresetInfo:Image3FileName|Image3FileName]]
* [[PresetInfo:Image3UseReference|Image3UseReference]]
* [[PresetInfo:Image3VectorData|Image3VectorData]]
* [[PresetInfo:Image4Caption|Image4Caption]]
* [[PresetInfo:Image4FileName|Image4FileName]]
* [[PresetInfo:Image4UseReference|Image4UseReference]]
* [[PresetInfo:Image4VectorData|Image4VectorData]]
|
* [[PresetInfo:IsChannelEntry|IsChannelEntry]]
* [[PresetInfo:IsFocused|IsFocused]]
* [[PresetInfo:Notes|Notes]]
* [[PresetInfo:PresetID|PresetID]]
* [[PresetInfo:PresetIDAsNumeric|PresetIDAsNumeric]]
* [[PresetInfo:PresetName|PresetName]]
* [[PresetInfo:PresetOrder|PresetOrder]]
* [[PresetInfo:PresetType|PresetType]]
* [[PresetInfo:PresetUnused|PresetUnused]]
* [[PresetInfo:Priority|Priority]]
* [[PresetInfo:PriorityName|PriorityName]]
* [[PresetInfo:Scenery|Scenery]]
* [[PresetInfo:SequenceID|SequenceID]]
* [[PresetInfo:UseImage1|UseImage1]]
* [[PresetInfo:UseImage2|UseImage2]]
* [[PresetInfo:UseImage3|UseImage3]]
* [[PresetInfo:UseImage4|UseImage4]]
|}