Differences

This shows you the differences between two versions of the page.

--- beyond:pangoscript_commands [2026/02/24 10:42] – Bob Varkevisser
+++ beyond:pangoscript_commands [2026/02/27 12:51] (current) – Bob Varkevisser
@@ Line 8: / Line 8: @@
-Information below this line is being rewritten
 ----
-Intro
+Information below is being rewritten
+<code>
+==== Intro ====
 Currently, the main purpose of "scripting" is ability to add custom relation on various events, like a MIDI, DMX, ArtNet, Channels. The script typically has a few lines, and a line has one Command. Command may have a parameters. Typically parameter is a number (constant).
-Numbers
+==== Numbers ====
 Supported float point , integer and hexadecimal numbers. As example:
@@ Line 30: / Line 40: @@
-Special characters (separators)
+==== Special characters (separators) ====
  '.', ';', ',', ':', '!', '�', '''', '^', '+', '-', '*', '\', ' ',
@@ Line 37: / Line 48: @@
-Predefined constants
+==== Predefined constants ====
 There are a few constants mostly for readability of the code. Each constant will be transformed to a number
@@ Line 54: / Line 66: @@
   WaitForMidi 0x90, 10, Any
-Math operations (expressions)
+==== Math operations (expressions) ====
@@ Line 66: / Line 79: @@
-Operators
+==== Operators ====
@@ Line 83: / Line 97: @@
 operator will be executed if condition gets non-zero result. If you want to place other operator after "if (condition) operator" - it must be divided with ";" - but it's better to place next operator on the next line ;-)
-GOTO operator
+=== GOTO operator ===
 Syntax:  goto label
@@ Line 110: / Line 125: @@
-VAR operator
+=== VAR operator ===
 PangoScript allow define local variables. The lifetime for the local variable defined by lifetime of the Scripter that execute PangoScript. As soon as the Scripter freed, all its local variables are removed as well.
@@ Line 134: / Line 150: @@
-General functions
+==== General functions ====
 intstr(value:number):string - transform number to string
@@ Line 194: / Line 211: @@
 invert(value:number):integer - invert value. Boolean operation, but can be used with float point numbers. If value more than 0.5 then function return 0, otherwise return 1.
-Date and Time
+==== Date and Time ====
 now:float - date&time, calls now() function of Delphi
@@ Line 224: / Line 242: @@
 dayofweeklong(now:float):string - long version day of the week
-String functions
+==== String functions ====
 uppercase(string):string  - transform input string to upper case. Result is a string.
@@ Line 234: / Line 253: @@
-Clock And Metronome
+==== Clock And Metronome ====
 b2s(beats) - transform beats to seconds
@@ Line 245: / Line 265: @@
-Functions
+==== Functions ====
 There are a few functions for access of incoming data
@@ Line 344: / Line 365: @@
-Timecode input
+==== Timecode input ====
 GetTimeCode - return latest timecode value as a float point value, value in seconds
@@ Line 350: / Line 372: @@
 GetTimeCodeTick - return the tick when the last timecode value arrived. Use function GetTick for getting the current tick value.
-Cue related functions
+==== Cue related functions ====
 CuePlaying( PageIndex, CueIndex) - function return 1 if cue is currently playing in the Grid, otherwise return 0. Indexing of page and cue starts from 1.
@@ Line 360: / Line 383: @@
-Misc
+==== Misc ====
 GetBeyondBuild - return integer value, build of BEYOND application.
@@ Line 368: / Line 392: @@
 GetMidiDeviceLayer - return current layer of MIDI device mapping.  Indexing from 1. Layering introduced because BEYOND has big number of functions, and at the same time, MIDI device has limited number of sliders and buttons. MIDI settings allow to organize several layers, and as a result, MIDI controller will do several functions (depending on current layer). GetMidiDeviceLayer return currently active layer of MIDI device associated with this script.
-User Interface
+==== User Interface ====
 GetLcTabMode:integer - function return mode (destination of control) of Live Control tab. Basically, it tell what button selected - Master, Cue, Zone or ProTrack
@@ Line 392: / Line 417: @@
-Timeline mode functions
+==== Timeline mode functions ====
 GetTimelinePos:float - function return time position of current timeline. Value in seconds. Fractional part contain millisecond part.
@@ Line 408: / Line 434: @@
+==== FX and Live Control commands ====
-General commands
-StartCue  Page, Cell  or  StartCue  "cue name"
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..100;
-Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid.
-Purpose: Start the cue. If cue already started the no action
-StopCue Page, Cell  or  StopCue  "cue name"
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..100;
-Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid.
-Purpose: Stop the cue. If cue is not started then no action.
-ToggleCue Page, Cell  or  Toggle  "cue name"
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..100;
-Parameters: "cue name" is a string that define cue name as we see it in the grid. At first BEYOND search for cue name in the current page. If not found than the search starting from the first page of the grid.
-Purpose: Start cue if it is not currently playing, or stop a cue if it is currently playing.
-StopCueType mask, time
-mask:
--Image
--Timeline
--DMX
--Fixture Sequence
--Beams
--Capture
-time � optional value, this is for soft stop. Zero means "right now".
-PauseCue Page, Cell, State
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..60; State - recommended to use predefined constants OFF, ON or  TOGGLE. Values - 0,1,2
-Purpose: allow to pause or unpause the cue
-RestartCue
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..60;
-Purpose: restart the cue if it already playing. Otherwise, no action.
-CueDown Page, Cell
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..60;
-Purpose: does a "mouse down" on the cue
-CueUp Page, Cell
-Parameters: Page  - page index, 1..100,. Cell - cell index, 1..60;
-Purpose: does a "mouse up" on the cue
-StopCueNow Page, Cell
-Parameters: - page index, 1..100,. Cell - cell index, 1..60;
-Purpose:  Stop cue immediatelly without soft ending what is default option
-StopCueSync Page, Cell
-Parameters: page index, 1..100,. Cell - cell index, 1..60;
-Purpose:  Stop cue softly and wait for completion
-HoldClick state
-Parameters: state - 0,1,2 or the constants ON, OFF, TOGGLE
-Purpose: This is additional modifier for coming "click" command. It allow to start the Cue in "HOLD" mode. HoldClick  command designed for with MIDI. You can use a special button on MIDI Controller and inside the button down you will enable hold mode, and on button release you will disable hold mode.
-StopAllNow
-Parameters: none
-Purpose: Stop all running cues. Equal to click on menu "Run" -> "Stop All Cues". This version stop all cues immediately
-Example: StopAllNow
-StopAllSync Time
-Parameters: time in seconds.
-Purpose: Stop all running cues with specified soft-stop time. Also, wait for completion
-Example: StopAllSync 0.2
-StopAllAsync Time
-Parameters: time in seconds.
-Purpose: Stop all running cues with specified soft-stop time. Do not wait for command completion
-Example: StopAllAsync 0.5
-BlackOut
-Parameters: none
-Purpose: The same action as click on "Blackout" button on a mail toolbar of BEYOND
-Example: Blackout
-EnableLaserOutput
-Parameters: none
-Purpose: Access to "Enable Laser Output" button on mail toolbar. This command enable output :-)
-Example: EnableLaserOutput
-DisableLaserOutput
-Parameters: none
-Purpose: Access to "Enable Laser Output" button on main toolbar. This command enable output :-). There is no "toggle" version.
-Example: DisableLaserOutput
-MasterPause
-Parameters: On  or Off or Toggle
-Purpose: Control of "Pause" button on main toolbar. Of course it does an action same as a button.
-Example:
-MasterPause On
-MasterPause Toggle
-MasterSpeed Speed
-Parameter: Speed, normalized value in range from 0 to 1. 0 represent full stop, 1 means normal speed
-Purpose: It is global speed multiplier for players from Grid
-VirtualLJ
-Parameters: On  or Off or Toggle
-Purpose: Control of "Virtual LJ" button on main toolbar. Of course it does an action same as a button.
-Example: VirtualLJ OFF
-VLJFX
-OneCue
-Parameters: none
-Purpose: Control of "One Cue" button on main toolbar. This command enable "One cue" mode
-Example: OneCue
-OnePer
-Parameters: none
-Purpose: Control of "One Per Zone" button on main toolbar. This command enable "One Per Zone" mode. Note, this mode share the button with OneCue mode
-Example: OnePer
-MultiCue
-Parameters: none
-Purpose: Control of "Multi Cue" button on main toolbar. This command enable "Multi cue" mode
-Example: MultiCue
-Transition
-Parameters: On  or Off or Toggle
-Purpose: Control of "Transition" button on main toolbar. This command enable or disable the transition.
-Example: Transition On
-ClickSelect
-Parameters: none
-Purpose: Control of "Select" button on main toolbar. This command enable "Select" mode.
-Example: ClickSelect
-ClickToggle
-Parameters: none
-Purpose: Control of "Toggle" button on main toolbar. This command enable "Toggle" mode.
-Example: ClickToggle
-ClickRestart
-Parameters: none
-Purpose: Control of "Restart" button on main toolbar. This command enable "Restart" mode.
-Example: ClickRestart
-ClickFlash
-Parameters: none
-Purpose: Control of "Flash" button on main toolbar. This command enable "Flash" mode.
-Example: ClickFlash
-ClickSoloFlash
-Parameters: none
-Purpose: Control of "SoloFlash" button on main toolbar. This command enable "SoloFlash" mode.
-Example: ClickSoloFlash
-ClickLive
-Parameters: none
-Purpose: This button is currently invisible, but t active mode of LivePRO - like tracks.
-Example: ClickLive
-ClickTrack - enable ProTrack click mode.
-StartPrevious - start previously started cue. Command is for button Back of the main toolbar (Grid mode).
-TogglePrevious - stop current cue and start previously stated cue. Command is for button Swap of the main toolbar (Grid mode).
-TimerBeat
-Parameters: none
-Purpose: Simulate Timer beat (BPM timer on the main toolbar)
-Example: TimerBeat
-AudioBeat
-Parameters: none
-Purpose: Simulate Audio beat what usualy comes from AudioIn and FFT.
-Example: AudioBeat
-ManualBeat
-Parameters: none
-Purpose: Manual beam comes from keyboard. Now it is possibl to initiate it from code.
-Example: ManualBeat
-SetBPM value- set master Beat timer value in BPM (beat per minute). The talk about BPM (Metronome) panel on the main toolbar in the Grid mode.
-SetBpmDelta value  - increase or decrease the BPM. This is relative version of SetBPM command. It designed for use with MIDI controllers, where MIDI button can be used for change of tempo.
-BeatTap
-Parameters: none
-Purpose: This is tap-tempo. It work in BPM panel in a main toolbar and allow enter beat-per-minute by means of tapping. Command work same as click on BMP panel. Or "space" key.
-Example: BeatTap
-BeatResync
-Parameters: none
-Purpose: Synchronize Beat timer to the moment of this command execution. Same as "backspace" key
-Example: BeatResync
-FX and Live Control commands
@@ Line 634: / Line 456: @@
-ControlMaster
-Parameters: none
-Purpose: Select Master LiveControl as a destination for Live Control commands
-ControlCue PageIndex, CellIndex
+==== WaitFor command group ====
-Parameters: PageIndex (1..PageNumber) and Cell Index 1..100. By default the grid has 60 cells (10x6 mode). But the grid may have another dimension with 100 cells as max.
-Purpose: Select Cue LiveControl as a destination for Live Control commands
-ControlZone ZoneIndex
-Parameters: Zone index, 1..ZoneNumber;
-Purpose: Select Zone LiveControl as a destination for Live Control commands
-ControlProTrack ProTrackIndex
-Parameters: Iindex, 1 to number of ProTracks created in the BEYOND/
-Purpose: Select ProTrack LiveControl as a destination for Live Control commands. Possible to select only one ProTrack
-ControlSelZones
-Parameters: none
-Purpose: In opposite to ConrolSelZones, this command address all selected zones of BEYOND. BEYOND keep the zones in list and each zone has Selected property. The command normally goes to only one destination - one zone, one cue, one track. But specially for external  control, added ability to send the Live Control command to multiple destinations. Technically, BEYOND will send many command, by one for each selected zones.
-Also, this command address selected ProTracks.
-ControlSelCues
-Parameters: none
-Purpose: Control currently selected Cues. This command allow to address Live Control to multiple (currently selected) cues. The action of command limited to one page only. If BEYOND in Grid mode, then will be used the page of Main grid. If BEYOND in Timeline/PlayList mode, then will be used page from bottom side grid.
-ControlFromUI
-Note: commands above are local commands, and modify internal register of interpreter that execute this code. It means, that the setting work only for this code, and till
-FX Control
-FX Index1, (Index2,...)
-Parameters: At least one argument that define  state of FX layer. Number of arguments should be equal, but can be less than number of layers in FX grid.
-Command designed to setting all FX layers at once, by means of one command. For setting each Layer separately use SetFX
-Purpose: Control of FX register of cues, zones, and master
-- stop.
-..100: Effect indexing start from zero and in current version up to 100
-Example:
-FX 0,0,0,0 // stop four FX layers
-FX 10 // set 1st later to effect number 10.
-Example:
- FX 2,3,4,5 // lineary select 2th, 3rd, 4th, 5th FXs
- FX  0,0,0,0 // stop all
-FXAction Action1, (Action2,...)
-Parameters: At least one argument that define  state of FX layer action. "Action" define a morph between original frame and frame after effects. Number of arguments should be equal, but can be less than number of layers in FX grid. Command designed to setting all FX layers at once, by means of one command. For setting each Layer separatelly ise SetFXAction
-- OFF, no action at all
-- norma;. full action.
-Example:
-FXAction 0,0,0,0 // set action for four FX layers
-Note: Action parameter is not same as "stop" effect. It relatively slow operation because of calculation of morph, extra buffers, and relating calculations.
-SetFX  LayerIndex,  EffectIndex,[EffectIndex,EffectIndex...]
-A bit more compact version. First parameter index of layer 1 to 4, and Effect index of 1..100.
-Set state of one layer.
-If EffectIndex is not defined, then command will stop the layer
-If there are multiple Effectindex then command will activate multiple effects in this layer
-SetFXAction LayerIndex, Action
-Purpose: set Action parameter of one layer
-Layer index - index of FX layer, 1..N
-Action - 0..100, in percents
-SetFXAction1 ActionValue
-SetFXAction2 ActionValue
-SetFXAction3 ActionValue
-SetFXAction4 ActionValue
-Purpose: set Action parameter of one layer
-Action - 0..100, in percents
-SetFXActionDelta ActionDelta1, [ActionDelta2,..]
-Shift the action value bu delta. For each layer value of delta is personal.  At least one argument required, Starts from 1st layer and up.
-FXTimeScale Layer, ClockSale, BeatScale
-FXTimeScaleDelta Layer, ClockSale, BeatScale
-FXTimeShift Layer, ClockValue, BeatValue
-FXTimeShiftDelta Layer, ClockValue, BeatValue
-ShiftFX LayerIndex,  Direction
-Delta version of control. Allow to shift effect index on N
-ToggleFX LayerIndex
-Toggle between internal LC register and current state. Layer index is optional. If Layer not defined that will be swapped all layers
-ShiftFX  LayerIndex, IndexDelta
-LayerIndex - 1..N
-IndexDelta - how to shift current index
-DropFX Layer, Effect, DurationMS
-Layer - index of effect later in grid
-Effect - inded of effec in grid
-DurationMS - define how long effect will be executed
-FXClick Layer, Index - click on effect of FX grid, with absolute effect index, 1..N
-FXCellClick Layer, CellIndex - click on effect of FX grid, but effect index based on left corner, so, click on visible area
-FXScroll BaseIndex
-Base index - control scrollbar of FX gird, define left corner. 0 - default state.
-Live Control
-Size X, Y, Z
-Parameters: X, Y and Z are size in %. 100% means a full size. Max value 400%.
-Purpose: Access to Size of LiveControl object.
-Example: Size 100,100,100
-SizeDelta X, Y, Z
-Parameters: X, Y and Z are deltas that will be added to Size values. Value in %.
-Purpose: Access to Size of LiveControl object. Good to incrementive control
-Example: SizeDelta 0,1,0
-Zoom 100
-Parameter - zoom value, 0..100
-ZoomDelta 0
-Parameter - zoom delta,
-Position X,Y,Z
-Parameters: X, Y and Z are value of Position. Value in %. 0,0,0 is a center :-), 100% is boundary. Max value 400%.
-Purpose: Access to Position of LiveControl object.
-Example: Position 100,0,0  // move to teh right corner
-PositionDelta X,Y,Z
-Parameters: X, Y and Z are deltas for Position. Value in %
-Purpose: Access to Positiion of LiveControl object.
-Example: PositionDelta -5,0,0  // move to the left on 5%
-PositionIndex AxisIndex, Value
-Parameters: Axis Index means: 0 is X, 1 is Y, 2 is Z. Value is value of position, in %, as usual :-)
-Purpose: Access to Position of LiveControl object.
-Example: PositionDelta  2, 1  // move by Z axis on 1%
-AngleX angle
-Parameters: Angle in degrees
-Purpose: Access to Rotation of LiveControl object.
-Example: AngleX 45
-AngleY angle
-Parameters: Angle in degrees
-Purpose: Access to Rotation of LiveControl object.
-Example: AngleY 0
-AngleZ angle
-Parameters: Angle in degrees
-Purpose: Access to Rotation of LiveControl object.
-Example: AngleZ 180
-Angle X, Y, Z
-Parameters: X,Y ans Z are angle in degrees. Directly define a value of rotation angles
-Purpose: Access to Rotation of LiveControl object.
-Example: Angle 0, 0, 90
-AngleDelta  X, Y, Z
-Parameters: X,Y ans Z are deltas of angle in degrees.
-Purpose: Access to Rotation of LiveControl object.
-Example: AngleDelta 0, 0, 5 // increment Z rotation angle
-RotoSpeedX  Value
-Parameters: Value - speed. Degrees per second.
-Purpose: Access to Rotation of LiveControl object.
-Example: RotoSpeedX 0
-RotoSpeedY Value
-Parameters: Value - speed. Degrees per second.
-Purpose: Access to Rotation of LiveControl object.
-Example: RotoSpeedY 0
-RotoSpeedZ Value
-Parameters: Value - speed. Degrees per second.
-Purpose: Access to Rotation of LiveControl object.
-Example: RotoSpeedX 0
-RotoSpeed X, Y, Z
-Parameters: X,Y and Z are rotation speed for corresponding axis
-Purpose: Access to Rotation of LiveControl object.
-Example: RotoSpeed 0, 0, 0   // turn off rotation
-RotoSpeedDelta X, Y, Z
-Parameters: X,Y and Z are deltas of rotation speed.
-Purpose: Access to Rotation of LiveControl object.
-Example: RotoSpeedDelta 0,0, -1 // decrement of rotation speed
-Brightness Value
-Parameters: Brightness, 0..100%
-Purpose: Access to Brightness of LiveControl object.
-Example: Brightness 50  // half dimmed image
-BrightnessDelta Value
-Parameters: delta-version of brightnes control
-Purpose: Access to Brightness of LiveControl object.
-Example: BrightnessDelta +1 // positive increment
-VisiblePoints Value
-Parameters: percentage of visible points, 0%..100%.
-Purpose: Access to VisiblePoints of LiveControl object.
-Example: VisiblePoints 100
-VisiblePointsDelta Value
-Parameters: delta-version of brightnes control
-Purpose: Access to VisiblePoints of LiveControl object.
-Example: VisiblePointsDelta 0
-ColorSlider Value
-Parameters: Value range is 0..255.
-Purpose: Access to Color Slider of LiveControl object.
-Example: ColorSlider 0
-ColorSliderDelta Value
-Parameters: Value is delta to be added to ColorSlider
-Purpose: Access to Color Slider of LiveControl object.
-Example: ColorSliderDelta 5
-AnimationSpeed Value
-Parameters: Value range is 25..200
-Purpose: Access to AnimationSpeed Slider of LiveControl object.
-Example: AnimationSpeed 100 // defaul value
-AnimationSpeedDelta Value
-Parameters: Value is delta to be added to AnimationSpeed
-Purpose: Access to AnimationSpeed Slider of LiveControl object.
-Example: AnimationSpeedDelta -10
-ScanRate Value
-Parameters: Value range is 25..200
-Purpose: Access to ScanRate Slider of LiveControl object.
-Example: ScanRate 100 // defauul state
-ScanRateDelta Value
-Parameters: Value is delta to be added to ScanRate
-Purpose: Access to ScanRate Slider of LiveControl object.
-Example: ScanRateDelta 10
-RGBA  Red, Green, Blue, Alpha
-RGBA Red, Green, Blue
-RGBA Index, Value
-If 4 parameters: Red, Green, Blue are color channels, values 0..255. Alpha is transparency control, range 0..255
-If 3 parameters: Red, Green, Blue are color channels, values 0..255. Same as four parameters, but alpha channel stay unchanged
-If 2 parameters then Index define what parameter to change, and Value define the value of corresponding channel.
-Index values are
--  Red
-- Green
-- Blue
-- Alpha
-Purpose: Direct color control of  of LiveControl object. RGBA is additional and independent layer to ColorSlider parameter
-Example: RGBA 255, 255, 0, 128  // makes image yellow-shaded (on 50%)
-RGBADelta Red, Green, Blue, Alpha
-RGBADelta Red, Green, Blue
-RGBADelta Index, Value
-If 4 parameters: Delta (relative change) by Red, Green, Blue and Alpha channels
-If 3 parameters: Delta (relative change) by Red, Green, Blue and Alpha channels
-If 2 parameters then Index define what parameter to change, and Value define the delta of value of corresponding channel.
-Index values are
--  Red
-- Green
-- Blue
-- Alpha
-Example: RGBADelta 0, 0, 0, -16   decrease alpha channel value
-ResetAllRoto
-Parameters: none
-Purpose: reset all rotation to zero, and clear accumulator
-Example: ResetAllRoto
-ResetLiveControl
-Parameters: none
-Purpose: reset all sparameters of LiveControl object to default
-Example: ResetLiveControl
-Live Control - UI surface
-Live Control tab contain a sliders like a Size, Color, etc. Each such slider has two button that scroll the slider to minimum or to maximum value.  What the button does - define a speed of motion. As soon as slider hit the boundary, motion will stop. Speed means a shift of slider during one iteration. Speed can be positive, or negative. Value zero means stop the motion now. In total, we have 11 functions, each
-ClickScrollZoom speed.
-ClickScrollSize speed.
-ClickScrollFade speed
-ClickScrollVPoints speed
-ClickScrollScanRate speed
-ClickScrollColor speed
-ClickScrollAniSpeed speed
-ClickScrollR speed
-ClickScrollG speed
-ClickScrollB speed
-ClickScrollA speed
-Each function control corresponding slider in Live Control tab. Note, that this is control of UI slider. This is not a control of some exact LiveControl object.
-ClickLCTabMode Index
-Parameters: Index represent mode of Live Control tab. (In UI mode controlled by Master,Cue,Zone, and Protrack buttons on toolbar. Values of Index are:
-- Master
-- Cue
-- Zone
-- ProTrack
-Purpose: Control of Live Control tab mode
-Example: ClickLCTabMode 2 // control currently selected cue in the grid
-ClickTCTabMode Index
-Parameters: Index represent mode. See constants of ClickLcTabMode above.
-Purpose: Control of Time Control tab mode
-Example: ClickTCTabMode 1 // control master
-ClickFXTabMode Index
-Parameters: Index represent mode. See constants of ClickLcTabMode above.
-Purpose: Control of FX tab mode
-Example: ClickFXTabMode 1 // control master
-ClickFXStopAll
-Parameters: no arguments
-Purpose: Same as click on Stop All button on FX tab (stop all effects in currently selected Live Control)
-Example: ClickFXStopAll
-ClickFxVlj Index, State
-Parameters: Index of FX line. Indexing from 1. Up to 8 lines. State is optional parameter and represent state of VLJ for this FX line (on or off). State values are
-- Off, 1 - On, 2 - Toggle.
-Purpose: Enable or disable VLJ for FX line.
-Example: ClickFxVlj 2, 0 // disable VLJ for second FX line
-WaitFor command group
 Sleep Time
@@ Line 996: / Line 472: @@
-WaitForMidi Command, Data1, Data2
-Parameters: Command, Data1, Data2. MIDI messages contain 3 bytes. 1st known as Command, and ha steh range 0x80h, up to 0xFF. Data1 and Data2 are parameters of command, max value is ox7F (127 decimal). It is possible to use special value "minus one", (-1), it will means "any value". As example: WaitForMidi 0x90,-1,-1   this command will wait for any NoteOn message, any note (Data1 is -1), any volume (Data2 is -1).
-Purpose: Allow to make reaction on incoming MIDI event.
-Example:
-WaitForMidi 0x90, 0x01, -1
-NextPage
-Restart
-Note: See SelectMidi command that allow select a MIDI device from what expect the message. SelectMidi control input and output operations
-WaitForArtNet ChannelIndex
-Parameters: ChannelIndex
-Purpose: Wait for change of value in incoming ArtNet packet. ChannelIndex values from 1 to 512. Special value "-1" means any channel index
-Example: WaitForArtNet 2
-WaitForDmx ChannelIndex
-Parameters: ChannelIndex
-Purpose: Wait for change of value in incoming DMX packet. ChannelIndex values from 1 to 512. Special value "-1" means any channel index
-Example: WaitForArtDMX 512
-WaitForChannel ChannelIndex
-Parameters: ChannelIndex
-Purpose: Wait for change of internal Channels. BEYOND has 256 channels that typically used in effects, shapes, abstracts.  ChannelIndex values from 1 to 255. Special value "-1" means any channel index
-Example: WaitForChannel 512
-WaitForCueStart PageIndex, CellIndex.
-Parameters: PageIndex, CellIndex.
-Purpose: Wait for start of exact Cue. Cue addres composes of Page and Cell. BEYOND has up to 64 pages, and 60 cell (cues) per page. So, address is two numbers - page and cell. Special value "-1" means "any"
-Example: WaitForCueStart  -1, 10
-WaitForCueStop PageIndex, CellIndex.
-Parameters: PageIndex, CellIndex.
-Purpose: Wait for stop of exact Cue. Cue addres composes of Page and Cell. BEYOND has up to 100 pages, and 60 cell (cues) per page. So, address is two numbers - page and cell. Special value "-1" means "any"
-Example: WaitForCueStop  -1, 10
-WaitForCellDown CellIndex.
-Parameters: CellIndex.
-Purpose: Main storage of cues is a Grid. When we click on the grid cell teh we start a cue, at least this is initial, and default action. But, click itself is just a click. There is special "input manager" that transform mouse down, mouse up events into commands to start to stop the cues. Managr takes into account current mode, current page, state of the cue (playing or no) and after this generate a command to start (or stop) the cue. OK, this version allow to wait and react on clicks
-Example: WaitForCellDown  1
-WaitForCellUp CellIndex.
-Parameters: CellIndex.
-Purpose:  OK, this version allow to wait and react on "release" the cell.
-Example:
-WaitForCellUp 1
-MidiOut 0x90, 0x40, 127
-Sleep 100
-MidiOut 0x80, 0x40, 0
-Restart
-WaitForTime Hour,Minute, Seconds, Milliseconds
-Parameters: Hour - 0..23, Minute - 0..59, Seconds - 0..59 , Milliseconds - 0..999;
-Purpose:  Wait for "real" time defined by PC clock
-Example:
-WaitForTime 21,00,0,0 // wait for 9 PM, and then allow code for go forward
-WaitForTimePos Hour,Minute, Seconds, Milliseconds
-Parameters: Hour - 0..23, Minute - 0..59, Seconds - 0..59 , Milliseconds - 0..999;
-Purpose:  wait for time from begining of the script execition. Time is relative to the script start. "Restart" command clear local script time
-Example:
-WaitForTime 0,1,45,0 // wait for 1 minute, 45 seconds from teh script start.
-WaitForHotkey no arguments
-Parameters:  none
-Purpose:  Each script in Code list has a hotkey that can activate it. Waiting for hotkey what allow create multiple reaction, or reaction loop by means of restart command
-Example:
-WaitForHotkey
-DmxOut 1, 255 // set first channel to 255
-Sleep 500 // wait a half of second
-DmxOut 1, 0 // zero first channel
-WaitForAudioBeat no arguments
-Parameters:  none
-Purpose:  what for audio beat, same as does VLJ
-WaitForManualBeat no arguments
-Parameters:  none
-Purpose:  what for manual beat
-WaitForTimerBeat no arguments
-Parameters:  none
-Purpose:  what for main beat controlable from main toolbar.
-Custom Events
-WaitForEvent  Name[, Name, Name]
-Parameters - at least one string that define name of event. May be used more than one event names.
-PulseEvent Name[, Name, Name]
-Parameter - at least one name of the event. It will reactive the scripts that suspended by WaitForEvent
-Workspace Pages, Tabs, Category
-SelectGrid Index
-Index allow to choose what grid will be used for executing commands below. Zero (0) means "recently selected" grid. 1 means main grid that in center of main form. 2 means secondary grid that is on bottom tabs.
-SelectTabName "Name"
-Select the tab of the grid by specified name. Name is a string. Function work within current category.
-SelectTab Index
-Select the tab by linear index. Counting starts from 1. Function work within current category.
-SelectNextTab
-Select the next tab relatively to current. No arguments. Function work within current category.
-SelectPrevTab
-Select the previous tab relatively to current. No arguments. Function work within current category.
-SelectPageName "Name"
-Select the page/tab of the grid by specified name. Name is a string. Function work independently on current category.
-SelectPage Index
-Select the page/tab by linear index. Counting starts from 1. Function work independently on current category.
-SelectNextPage
-Select the next page/tab relatively to current. No arguments. Function work independently on current category.
-SelectPrevPage
-Select the previous page/tab relatively to current. No arguments. Function work independently on current category.
-SelectAllCat
-No argumens. Select all categoris of pages, same as click on "All"
-SelectCatName CategoryName
-CategoryName - string. Select a category by name. Names of categories are completelly user defined, and may vary from workspace to workspace.
-SelectCat Index
-Select category by index. Counting from 1. -1 mean all, this is analog of SelectAllCat.
-SelectNextCat
-Select next category relatively to current. No arguments.
-SelectPrevCat
-Select previous category relatively to current. No arguments.
-Zones
-UnselectAllZones
-Unselect all projection zones. Analog of "use cue defined routing". No. arguments
-StoreZoneSelection
-Store information about currently selected zones in local buffer of interpreter. Lifetime of strong is limited to lifertime of time of executing this code
-ReStoreZoneSelection
-Restore previously store zone selection.
-SelectZone Index
-Select the zone by index. Argument - number. Counting from 1.
-UnSelectZone Index
-Select the zone by index. Argument - number. Counting from 1.
-ToggleSelectZone Index
-Toggle zone selection state. Argument - number. Counting from 1.
-SelectZoneName ZoneName
-Select zone by name. Argument - string.
-UnSelectZoneName ZoneName
-Unselect zone by name. Argument - string.
-ToggleSelectZoneName ZoneName
-Toggle zone selection state. Argument - string.
-"Cell Navigation"
-Command from this section designed to actiavte the cues within the page. Functionality affected by SelectGrid !!!
-FocusCell Col, Row
-Set focused cell by Column and Row. Columt range 1..10. Row range 1..6.
-FocusCellIndex Index
-Set focused cell by index (1..60)
-StartCell
-No arguments. Start focused cell
-StopCell
-No arguments. Stop focused cell
-ShiftFocus DeltaIndex
-Shift focused cell on DeltaIndex cells forward or backward. Positive value - go forward. Independently on step value the resulting index will be valid range.
-MoveFocus DeltaX, DeltaY
-DeltaX - how many cells to go horizontaly
-DeltaY - how many cells to go vertically
-Local Commands
-Restart
-Parameters: none
-Purpose:  start exection from a first line. Use it if you need to start from begining. Typical use - some WaitFor command at begining and Restart at the end
-Example: Restart
-Exit
-Parameters: none
-Purpose:  stop the script execution
-Example: Restart
-Autostart
-Parameters: none
-Purpose: Automatically start the script execution. Suitable for PangoScript tab and MIDI background scripts.
-StopOnBlackout  0,1 or ON, OFF
-Purpose: this option define how the scripter should react on blackout. By default (at least now), the script execution will not be interrupted. If to will enable this option then the script execution will stop.
-CodeName string
-Parameters: String. Allow define a program name in the Code list. This string is also used for identification of Code for StartCode and StopCode functions.
-Example: Name "my first code"
-CodeShortcut shortcut-string
-Paremeter: a string that contain a shortcut in text form. As example: ""Ctrl+A". Delphi has functions ShortcutToText and TextToShortcut. It allow transform. Main idea - allow code contain information about its name and shortcut as a text, inside the code. How to know shortcut text? right now - there is dialog that allow define a shortcut to Code, and you can see how it looks.
-StartCode CodeName
-Parameter: string that define code name to start. Could be used only code from the main pool (listbox in Code tab);
-Purpose:  This allow to actiavte one code from another code, for making a complex reactions. In act, this is analog of subroutine
-Example:
-// First script
-WaitForHotkey "F1"
-StartCode "Rotate Z"
-WaitForHotekey "F1"
-StopCode "Rotate Z"
-Restart
-// Second script
-CodeName "Rotate Z"
-WaitForBeat
-LCMaster
-AngleDelta 0,0, 5
-Restart
-StopCode CodeName
-Parameter: string that define code name to stop.
-Purpose:  Stop the execution of specified code, a pair for StartCode. (see above)
-Output
-SelectMidi DeviceNumber
-Parameters: DeviceNumber is from 1 to 4 and correspond to device number of MIDI settings dialog. Special value "-1" accepted for WaitForMIDI command only. MidiOut do not accept this value and will ignore it.
-Example:
-SelectMidi 1
-WaitForMidi 0xC0, 00, ANY
-See also - GetMidiDeviceIndex. Function return currently selected device number
-SetMidiLayer
-MidiOut Message, Data1, Data2
-Parameters: 3 parameters, standard for MIDI, Message is value in range of 80h up to FFh. Data1 and Data2  from zero to 7Fh.
-DmxOut Channel, Value
-Parameters: Channel is index of DMX channel, value range 1..512. Value is state of DMX channel, range 0..255
-Example: DmxOut 1,255
-DmxOutRange
-ChannelOut ChannelIndex, Value
-Parameters: ChannelIndex is index of internal BEYOND Channel, value range 1..255. Value is state of DMX channel, range 0..1000.
-Example: ChannelOut 1,1000
-OscOut Address, [Agrument]
-The first parameter is osc message address. string.
-Second and other agruments are optional. Types - string or number.
-Unsafe commands
-RunApp File, Parameters, ShowCmd
-Purpose: This command use ShellExecute() function inside it. Please check MSDN: http://msdn.microsoft.com/en-us/library/windows/desktop/bb762153(v=vs.85).aspx .
-Reason of adding this command - ability to run extenal application from BEYOND. Internally, BEYOND use this code:
-ShellExecuteW(0,nil,PWideChar(FFile), PWideChar(FParameters), nil, round(FShowCmd))
-Parameters:
-File - string. exe file name including path.
-Parameters - string.
-ShowCmd - number, see MSDN for details are optional. For more info please check MSDN. Default value is SW_SHOWNORMAL (1)
-Example: RunApp "C:\Windows\Notepad.exe", "", 1
-IMPORTANT: This command is disabled by default because of security reasons. If you going to use this command, enable it in "Configuration" dialog, "Security" tab.
-Limiters
-SetLimiterProfile Index
-Parameter - index of profile. There are two profiles, the 1st for "One Cue" mode, and second for "Multi Cue" mode. You should select 1 or 2 before using SetLimiter commands. This also will affect the state of BEYOND and change the active profile. It is recommended to call OneCue, OnePer or MultiCue command after the profile.
-SetLimiterPerZone Value
-Value specify max number of cues per Zone. The range is 1..30. The range is big, and we recommend to keep the values in reasonable limits
-SetLimiterPerGrid Value
-Value specify max number of cues per Grid. The range is 1..30.
-SetLimiterFlash Value
-Value specify max number of cues that can be in Flash mode. The range is 1..30.
-SetLimiterHold Value
-Value specify max number of cues that can be in Hold mode. The range is 1..30.
-SetLimiterBeam Value
-Value specify max number of playing Beam cues. The range is 1..30.
-SetLimiterDMX Value
-Value specify max number of playing Beam cues. The range is 1..30.
-SetLimiterShow Value
-Value specify max number of playing Show cues. The range is 1..30.
+==== Timeline control ====
-Timeline control
 PlayTimeline
@@ Line 1335: / Line 492: @@
-QuickDMX Editor
-SetDmxEditorChannel
-Play List control
-PlayListStop
-Stop playing of current show
-PlayListPlay
-Start playing of current show
-PlayListFirst
-Jump to first show in the list. Work in play and edit modes.
-PlayListLast
-Jump to last show in the list. Work in play and edit modes.
-PlayListNext
-Jump to next show in the list. Work in play and edit modes.
-PlayListPrev
-Jump to previous show in the list. Work in play and edit modes.
-PlayListSetPos index
-Jump to specified show of the list. Index define a number of show in the list
-PlayListSetTime time
-Jump to time position of the show, value defined in seconds. Work only in PLAY mode.
-Debug messages
-qLog  string or numeric argument(s)
-Purpose: display message in QLog tab. Usefull for debug purposes.
-Write string or numeric argument(s)
-Purpose: create special output window and display message.
-WriteLn string or numeric argument(s)
-Purpose: create special output window and display message.
-Player control
-InvertPlayersTime
-No arguments. Invert time direction of all currently playing cues. Works for all dynamic players. Used in corresponding button on Master tab
-PlayersSetJump (no argument)
-No arguments. The first call memorize current player position and second call restore the time of player to that position. See PlayersResetTime that clear this time storage. Works for all dynamic players. Used in corresponding button on Master tab
-PlayersResetJump
-No arguments. Function is an addition for PlayersSetJump, it clear the saved time to zero,. Works for all dynamic players. Used in corresponding button on Master tab
-PlayersSetLoop
-No arguments.One more function of "time fun" groups. First call memorize time position A, second call memorize time position B, and after that, Player bounce the time within specified A-B range. Third call of this procedure clear the time varibales, and player continue normal playback. Works for all dynamic players. Used in corresponding button on Master tab
-PlayersDisk  SpeedMultiplier, PositionDelta
-PlayersDisk provide access to "DJ disk" from Master tab of BEYOND. Disk action based on two things - distance from center that define the slowdown of rotation (speed control) and second is position shift - what actually is time shift delta.
-SpeedMultipler is normalized value within 0..1 range, where 1 is full speed, 0 a full stop
-PositionDelta is a shift of time, backward or forward. Value in radians. Each call add this value to time position of the players. Parameter is optional!, there is a special procedure for this if you plan to use it from MIDI.
-Works for all dynamic players. Used in corresponding button on Master tab
-PlayersDiskShift PositionDelta
-Command does the time shift (on delta) of all currently playing cue. It is simple action like Time=Time+Delta;
-Command made for use with MIDI and action is equal to PlayersDisk command.
+==== Property Animation ====
-Property Animation
 Property animation designed for linear change of property from one state to another during some period of time. Technically, this is sort of micro script, but BEYOND does this job automatically. Internally BEYOND has internal list of the tasks for object property animation. The list is dynamic. The only way to create request for property animation is a script.
@@ Line 1454: / Line 543: @@
-MIDI Surface Layer (MSL)
+==== MIDI Surface Layer (MSL) ====
 BEYOND offer more functions that can be mapped to MIDI sliders/buttons of overage MIDI console has. The soluion is map a few function to one slider, and enable only one of them. For making this possible BEYOND intoduce conception of "layers". You organize some set of functions grouped into layers, and after that you can change the layer, what give quick access to the groups of functions.
@@ Line 1476: / Line 566: @@
-Triggers
+==== Triggers ====
 "Trigger" is a special mode for the scripter. The trigger as two part - Definition and Action. The the Definition part you define the type of the trigger, range of values and labels for corresponding sections of code. In the Action part has one or more code sections that will be activated - depending on the definition. Lets talk a bit more about when trigger may be in help and why it done this way.
@@ Line 1711: / Line 802: @@
+</code>