beyond:pangoscript_commands
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| beyond:pangoscript_commands [2020/05/26 12:54] – Bob Varkevisser | beyond:pangoscript_commands [2026/02/27 12:51] (current) – Bob Varkevisser | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== PangoScript Commands ====== | ====== PangoScript Commands ====== | ||
| + | New for 2026, a tool has been created with all new fresh documentation of every Pango script Command. The tool linked below allows you to read every command as well as see examples the script commands in use. The tools is searchable with the search bar on the top. | ||
| - | ===== A-B-C ===== | + | Click the link below to review this tool which will open in a new window. |
| + | [[https:// | ||
| - | ^ Function ^ Code ^ Comments ^ | ||
| - | | AddSms | AddSMS "This is my demo message" | ||
| - | | Angle | Angle 0,0,0 | X,Y,Z angles in degrees | | ||
| - | | AngleDelta | AngleDelta 0,0,0 | increment X,Y,Z angles in degrees | | ||
| - | | AngleX | AngleX 0 | degree | | ||
| - | | AngleY | AngleY 0 | degree | | ||
| - | | AngleZ | AngleZ 0 | degree | | ||
| - | | AnimateProp | AnimateProp "", | ||
| - | | AnimatePropDelta | AnimatePropDelta "", | ||
| - | | AnimationSpeed | AnimationSpeed 100 | speed in %. Zero full stop. | | ||
| - | | AnimationSpeedDelta | AnimationSpeedDelta 0 | | ||
| - | | AudioBeat | AudioBeat | | ||
| - | | Autostart | AutoStart | | ||
| - | | BeatResync | BeatResync | | ||
| - | | BeatTap | BeatTap | | ||
| - | | BlackOut | BlackOut | | ||
| - | | Brightness | Brightness 100 | 0..100 (percents) | | ||
| - | | BrightnessDelta | BrightnessDelta 0 | | ||
| - | | CaptureToClipboard | CaptureToClipboard | ||
| - | | ChannelOut | ChannelOut 1, 1000 | set first channel to 1000 (max value) | | ||
| - | | ClickFXStopAll | | ||
| - | | ClickFXTabMode | ClickFXTabMode 1 | 1-Master, 2-Cue, 3-Zone, 4-ProTrack | | ||
| - | | ClickFlash | ClickFlash | ||
| - | | ClickFxVlj | ClickFxVlj 1 | Toggle first FX-VLJ | ||
| - | | ClickLCTabMode | ClickLCTabMode 1 | 1-Master, 2-Cue, 3-Zone, 4-ProTrack | | ||
| - | | ClickLive | ClickLive | ||
| - | | ClickLockSize | ClickLockSize 1 |0,1,2 Off, On, toggle | | ||
| - | | ClickRestart | ClickRestart | ||
| - | | ClickScrollA | ClickScrollA -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollAniSpeed | ClickScrollAniSpeed -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollB | ClickScrollB -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollColor | ClickScrollColor -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollFade | ClickScrollFade -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollG | ClickScrollG -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollHue | ClickScrollHue -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollHueShift | ClickScrollHueShift -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollR | ClickScrollR -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollSaturation | ClickScrollSaturation -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollScanRate | ClickScrollScanRate -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollSize | ClickScrollSize -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollVPoints | ClickScrollVPoints -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickScrollZoom | ClickScrollZoom -5 | scroll speed, recommended -5..-1, or 1..5. Zero will stop. | | ||
| - | | ClickSelect | ClickSelect | ||
| - | | ClickSoloFlash | ClickSoloFlash | ||
| - | | ClickTCTabMode | ClickTCTabMode 1 | 1-Master, 2-Cue, 3-Zone, 4-ProTrack | | ||
| - | | ClickToggle | ClickToggle | ||
| - | | ClickTrack | ClickTrack | ||
| - | | CloseUmax | CloseUmax | | ||
| - | | CodeColorMarker | CodeColorMarker 0x00FF00 | green color marker | ||
| - | | CodeName | CodeName " | ||
| - | | CodeShortcut | CodeShortcut " | ||
| - | | ColorBGR | ColorBGR 0x0000FF | blue color | | ||
| - | | ColorOn | ColorOn 1| 1-enabled, 0-disabled | | ||
| - | | ColorRGB | ColorRGB 0x0000FF | red color, | ||
| - | | ColorSlider | ColorSlider 0 | 0..255 | | ||
| - | | ColorSliderDelta | ColorSliderDelta 0 | | ||
| - | | ControlCue | ControlCue 1,1 | | ||
| - | | ControlFromFxTab | ControlFromFxTab | | ||
| - | | ControlFromLcTab | ControlFromLcTab | | ||
| - | | ControlFromTcTab | ControlFromTcTab | | ||
| - | | ControlFromUI | ControlFromUI | | ||
| - | | ControlMaster | ControlMaster | | ||
| - | | ControlProTrack | ControlProTrack 1 | | ||
| - | | ControlProjector | ControlProjector 1 | | ||
| - | | ControlSelCues | ControlSelCues | | ||
| - | | ControlSelProTracks | ControlSelProTracks | | ||
| - | | ControlSelZones | ControlSelZones | | ||
| - | | ControlZone | ControlZone 1 | name as "Main Graphics", | ||
| - | | CueDown | Cuedown 1,1 | page 1..100, cue 1..100 | | ||
| - | | CueUp | CueUp 1,1 | page 1..100, cue 1..100 | | ||
| - | ===== D-E-F ===== | ||
| - | ^ Function ^ Code ^ Comments ^ | ||
| - | | DecreaseTrigger | DecreaseTrigger 0, | ||
| - | | DefineDmxTrigger | DefineDmxTrigger 1 | Channel | | ||
| - | | DefineMidiTrigger | DefineMidiTrigger 0xC0, 0x00 | MIDI Cmmand, MIDI Data 1, Trigger Name (optional), MIDI Dev index from 0 to 3 (optional), but default - any | | ||
| - | | DefineTcTrigger | DefineTCTrigger "TC Test"| hour, minute, second | | ||
| - | | DefineTrigger | DefineTrigger " | ||
| - | | DeletePropAni | DeletePropAni | " | ||
| - | | DisableLaserOutput | DisableLaserOutput | | ||
| - | | DisplayPopup | DisplayPopup "Hello world!" | ||
| - | | DisplayPopupOnTop | DisplayPopupOnTop "Hello world!" | ||
| - | | DisplayPreview | DisplayPreview "Hello world!", | ||
| - | | DmxInMute | DmxInMute 1, 255 | Channel index, 0 or 1; or ChannelIndex | | ||
| - | | DmxOut | DmxOut 1, 255 | set first DMX OUT channel to 255 (max value) | | ||
| - | | DmxOutRange | DmxOutRange 1, 255 | set first DMX OUT channel | ||
| - | | DropFX | DropFX 1,1, 1000 | Layer, Index, duration ms | | ||
| - | | Echo | Echo 2 | 0-none, 1-ok/error, 2-echo of input plus ok/error | | ||
| - | | EnableDmxIn | EnableDmxIn Toggle | ||
| - | | EnableFb3StyleDmxIn | EnableFb3StyleDmxIn 1 | On(1), Off(0), Toggle(2) | | ||
| - | | EnableLaserOutput | EnableLaserOutput | | ||
| - | | ExecCmd | ExecCmd " | ||
| - | | Exit | Exit | | ||
| - | | ExitBEYOND | ExitBEYOND | Exit from BEYOND | | ||
| - | | FX | FX 0,0,0,0 | One or more layers. 0 stop. Effect 1..100 | | ||
| - | | FXAction | FXAction 100, | ||
| - | | FXCellClick | FXCellClick 1,1 | | ||
| - | | FXCellDown | FXCellDown 1, 1 | Layer number: 1..4, Effect number | | ||
| - | | FXClick | FXClick 1,1 | | ||
| - | | FXScroll | FXScroll 1 | | ||
| - | | FXScrollDelta | FXScrollDelta 8 | | ||
| - | | FXTimeScaleAx | FXTimeScaleAx 1,2,1 | Layer, Mask (1,2,3), multiplier | | ||
| - | | FXTimeScaleAxReset | FXTimeScaleAxReset 1,2 | Layer, Mask (1,2,3) | | ||
| - | | FXTimeScaleDeltaAx | FXTimeScaleDeltaAx 1,2,1 | Layer, Mask (1,2,3), increment value | | ||
| - | | FXTimeSync | FXTimeSync 1,1 | Layer, Source (1-Master, 2-Own time) | | ||
| - | | FocusCell | FocusCell 1,1 | Column (1..10), Row (1..6) | | ||
| - | | FocusCellIndex | FocusCellIndex 1 | cell index, 1..60 | | ||
| - | | FocusProTrack | FocusProTrack 1 | Track index/name | | ||
| - | | FocusProjector | FocusProjector 1 | Projector index, 1..N. | | ||
| - | | FocusZone | FocusZone 1 | zone index, 1..N. | | ||
| - | ===== G-H-I ===== | ||
| - | ^ Function ^ Code ^ Comments ^ | ||
| - | | GetFxControl | GetFxControl | | | ||
| - | | GetLiveControl | GetLiveControl | | ||
| - | | GetPage | GetPage | | ||
| - | | GetTimeControl | GetPage | | ||
| - | | GoGridMode | GoGridMode | | ||
| - | | GoPlayListMode | GoPlayListMode | | ||
| - | | GoTimelineMode | GoTimelineMode | | ||
| - | | GoUniverseMode | GoUniverseMode | | ||
| - | | GroupCue | GroupCue | | ||
| - | | Hello | hello | answer will be Hello! | | ||
| - | | HoldClick | HoldClick ON | | ||
| - | | HtmlBody | | + | ---- |
| - | HtmlBody | | + | |
| - | | HtmlClearBody | | ||
| - | HtmlClearBody | | ||
| - | | HtmlClearHead | | + | Information below is being rewritten |
| - | HtmlClearHead | | + | |
| - | | HtmlHead | | + | < |
| - | HtmlHead | | + | |
| - | | HtmlHide | | + | ==== Intro ==== |
| - | HtmlHide | | + | |
| - | | HtmlUpdate | | ||
| - | HtmlUpdate | | ||
| - | | Hue | | + | Currently, the main purpose of " |
| - | Hue 0 | | + | |
| - | | HueDelta | | ||
| - | HueDelta 0 | | ||
| - | | HueShift | | + | ==== Numbers ==== |
| - | HueShift 0 | | + | |
| - | | HueShiftDelta | | + | Supported float point , integer and hexadecimal numbers. As example: |
| - | HueShiftDelta 0 | | + | 100 |
| + | -20 | ||
| + | 1.01 | ||
| + | 0xBF | ||
| + | All hexadecimal numbers much have 0x prefix, similar to C language, but without ending H | ||
| - | | InRangeTrigger | | + | There is not strict separation on integer and float point numbers. |
| - | InRangeTrigger 0, | + | |
| - | | InRangeTriggerCmd | | + | Separator between command parameter could be space (" ") or a comma (",") |
| - | InRangeTriggerCmd 0,100,"Blackout" | + | |
| - | | IncreaseTrigger | | ||
| - | IncreaseTrigger 0, | ||
| - | | InvertPlayersTime | | + | ==== Special characters (separators) ==== |
| - | InvertPlayersTime | | + | |
| - | | InvertProTrackTime | | ||
| - | InvertProTrackTime | | ||
| - | | InvertRotationX | | + | ' |
| - | InvertRotationX | + | ' |
| - | | InvertRotationY | | ||
| - | InvertRotationY | | ||
| - | | InvertRotationZ | | ||
| - | InvertRotationZ | | ||
| - | | LessThanTrigger | | + | ==== Predefined constants ==== |
| - | LessThanTrigger 0," | + | |
| - | | LinePerCycle | | ||
| - | LinePerCycle 24 | | ||
| - | | LoadCue | | + | There are a few constants mostly for readability of the code. Each constant will be transformed to a number |
| - | LoadCue " | + | TRUE - numeric analog 1 |
| + | FALSE - numeric analog 0 | ||
| + | ANY equal to numeric -1. Used in a few WaitFor command | ||
| + | OFF equal to numeric 0 | ||
| + | ON equal to numeric 1 | ||
| + | TOGGLE equal to numeric 2 | ||
| + | AsIs equal to -2. | ||
| + | This is required for commands like "MasterPause" | ||
| - | | LoadCueFromBlob | | + | A few examples of using commands: |
| - | < | + | VirtualLJ off |
| + | | ||
| + | WaitForMidi 0x90, 10, Any | ||
| - | | LoadPlaylist | | + | ==== Math operations (expressions) ==== |
| - | LoadPlaylist " | + | |
| - | | LoadWorkspace | | ||
| - | LoadWorkspace " | ||
| - | | LoadZoneFromBlob | | ||
| - | < | ||
| - | | MakeSecuredFile | | + | Standard: + - / |
| - | MakeSecuredFile "Input file name", " | + | Inversion: ! |
| + | bit OR: | | ||
| + | bit AND: & | ||
| + | bit XOR: ^ | ||
| + | bit right shift: >> | ||
| + | bit left shift: << | ||
| - | | ManualBeat | | ||
| - | ManualBeat | | ||
| - | | MasterAudioVolume | | + | ==== Operators ==== |
| - | MasterAudioVolume 100 | in percents | | + | |
| - | | MasterAudioVolumeMute | | + | |
| - | MasterAudioVolumeMute 1 | On(1), Off(0), Toggle(2) | | + | |
| - | | MasterClockShift | | + | IF operator. |
| - | MasterClockShift 0 | in seconds | | + | |
| - | | MasterCueLcSpeed | | + | Syntax: if ( expression ) operator |
| - | MasterCueLcSpeed 100 | in percents | | + | |
| - | | MasterCueSpeed | | + | expression - covered with brackets. Must be an expression with |
| - | MasterCueSpeed 100 | in percents | | + | numerical result that gives " |
| + | variable it's possible to write "if (variable) ...". | ||
| - | | MasterEffectClockShift | | + | Compare operators are: ">" |
| - | MasterEffectClockShift | + | |
| - | | MasterEffectMetroShift | | + | You can combine comparing operations with "&" |
| - | MasterEffectMetroShift | + | |
| - | | MasterFXSpeed | | + | operator will be executed if condition gets non-zero result. If you want to place other operator after "if (condition) operator" |
| - | MasterFXSpeed 100 | in percents | | + | |
| - | | MasterLCSpeed | | + | === GOTO operator === |
| - | MasterLCSpeed 100 | in percents | | + | |
| - | | MasterMetroShift | | ||
| - | MasterMetroShift 0 | in beats | | ||
| - | | MasterPause | | + | Syntax: |
| - | MasterPause Toggle |ON, OFF, TOGGLE | | + | |
| - | | MasterPauseTime | | + | " |
| - | MasterPauseTime 1000 | time in milliseconds | | + | |
| - | | MasterShowBrightness | | + | mylabel: WaitForBeat 4 |
| - | MasterShowBrightness 100 | in percents | | + | ... do something... |
| + | goto mylabel | ||
| - | | MasterShowSpeed | | ||
| - | MasterShowSpeed 100 | in percents | | ||
| - | | MasterSpeed | | + | Operator GOTO can work with the labels inside the string variables. It means that you declare string variable, assign a label name to variable, and then you a variable in GOTO. |
| - | MasterSpeed 1 | From zero to one | | + | Example: |
| - | | MasterTransition | | + | var s |
| - | MasterTransition ON | | + | s=" |
| + | goto s | ||
| - | | MasterTransitionIndex | | + | DisplayPopup "It does not work" |
| - | MasterTransitionIndex 2 | | + | exit |
| - | | MasterTransitionTime | | + | mylabel: |
| - | MasterTransitionTime 0.1 | | + | DisplayPopup "It works" |
| - | | MasterZoneFxSpeed | | ||
| - | MasterZoneFxSpeed 100 | in percents | | ||
| - | | MeshCurve | | ||
| - | MeshCurve 1,2,3 | quad-spline between point 1,2 and 3 | | ||
| - | | MeshPoint | | ||
| - | MeshPoint -100,-100, 0, " | ||
| - | | MeshPointChan | | + | === VAR operator === |
| - | MeshPointChan 1,0,0 | | + | |
| - | | MeshPolygon | | ||
| - | MeshPolygon 1,2 | connect 1st and 2nd point | | ||
| - | | MeshRect | | + | 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. |
| - | MeshRect 1,2,3,4 | | + | |
| - | | MeshSpline | | + | All variables must be declared before the using. No need to specify the type of variable. The variable automatically adjust the type depending |
| - | MeshSpline 1,2,3,4 | cubic-spline based on 4 points. 1,4 bases, 2,3 " | + | The declaration start from VAR operation and the follow one or more variable names. As example: |
| - | | MeshTriangle | | + | var MyVariable |
| - | MeshTriangle 1,2,3 | | + | var a,b,c |
| - | | MidiOut | | + | Before using the variable must be initialized by some value. Otherwise BEYOND will generate error and stop script execution. Example: |
| - | MidiOut 0x90, 0x40, 0x7F | | + | var MyInteger, MyString |
| + | MyInteger = 10 | ||
| + | MyString = " | ||
| - | | MidiOutLong | | + | All variables declared as VAR are local. |
| - | MidiOutLong 0x90, 0x40, 0x7F | | + | |
| - | | MidiSysexAdd | | ||
| - | MidiSysexAdd | ||
| - | | MidiSysexSend | | + | GLOBALVAR operator |
| - | MidiSysexSend | send prepared sysex buffer | | + | The variable can be declared as global. In this case, it visible in ALL scripts of BEYOND. |
| - | | MidiSysexStart | | ||
| - | MidiSysexStart | ||
| - | | MoreThanTrigger | | ||
| - | MoreThanTrigger 0," | ||
| - | | MoveFocus | | ||
| - | MoveFocus -1,0 | number of cells to go horizontally and vertically | | ||
| - | | MulFXMulAx | | + | ==== General functions ==== |
| - | MulFXMulAx 1, 3, 1 | Multiply multiplier... :-) Layer number: 1..4, Mask (1 is clock, 2 is beat, 3 is clock and beat), Value of multiplier | | + | |
| - | | MultiCue | | ||
| - | MultiCue | | ||
| - | | MuteAllProTracks | | + | intstr(value: |
| - | MuteAllProTracks | | + | value - number or float number |
| + | result - string | ||
| - | | MuteProTrack | | + | floatstr(value: |
| - | MuteProTrack 1 | index(es) or name(s) | | + | value - number |
| + | result - string | ||
| - | | MuteSelected | | + | abs(value: |
| - | MuteSelected | | + | value - integer or float number |
| + | result - same type as argument. result is absolute value | ||
| - | | MuteSelectedZones | | + | int(value: |
| - | MuteSelectedZones OFF | ON, OFF, TOGGLE | | + | value - a float point number |
| - | | MuteZone | | + | frac(value: |
| - | MuteZone 0 | index(es) or name(s) | | + | value - float |
| - | | MuteZonesOfProjector | | + | round(value: |
| - | MuteZonesOfProjector 1 | projector index, 1..N. | | + | value - a float point number |
| - | | OneCue | | + | sqr(value: |
| - | OneCue | one cue per workspace | | + | value - a float point number or integer |
| - | | OnePer | | + | sqrt(value: |
| - | OnePer | one cue per projectoin zone | | + | value - a float point number or integer |
| - | | OscOut | | + | cos(value: |
| - | OscOut "/ | + | value - a float point number or integer. angle in radians |
| - | | OscOutTTS | | + | sin(value: float):float - sinus |
| - | OscOutTTS "","" | + | value - a float point number or integer. angle in radians |
| - | | OutOfRangeTrigger | | + | tan(value: |
| - | OutOfRangeTrigger 0, | + | value - a float point number or integer. angle in radians |
| - | | OutOfRangeTriggerCmd | | + | arcsin(value: |
| - | OutOfRangeTriggerCmd 0, | + | value - a float point number or integer. angle in radians |
| - | | Password | | + | arccos(value: |
| - | password "enter pasword here" | | + | value - a float point number or integer. angle in radians |
| - | | PasteToCue | | + | arctan(value: |
| - | PasteToCue | | + | value - a float point number or integer. angle in radians |
| - | | PauseCue | | + | arctan2(dx, dy: |
| - | PauseCue 1,1, TOGGLE | page, cue, action | + | dx, dy - .... |
| - | | PlayListFirst | | + | min(a, |
| - | PlayListFirst | | + | a,b float or integer |
| + | |||
| + | max(a, | ||
| + | a,b float or integer | ||
| - | | PlayListLast | | + | pi:float - return PI value - 3.1415926... |
| - | PlayListLast | | + | |
| - | | PlayListNext | | + | invert(value: |
| - | PlayListNext | | + | |
| - | | PlayListPlay | | + | ==== Date and Time ==== |
| - | PlayListPlay | | + | |
| - | | PlayListPrev | | ||
| - | PlayListPrev | | ||
| - | | PlayListSetPos | | + | now:float - date& |
| - | PlayListSetPos 1 | | + | |
| - | | PlayListSetTime | | + | tickcount: integer - return number of millisecond from start of PC. |
| - | PlayListSetTime 0 | | + | |
| - | | PlayListStop | | + | hms(hour, minute, second): |
| - | PlayListStop | | + | |
| - | | PlayTimeline | | + | GetYear: |
| - | PlayTimeline | | + | |
| - | | PlayersDisk | | + | GetMonth: |
| - | PlayersDisk 1, 0.1 | | + | |
| - | | PlayersDiskShift | | + | GetDay: |
| - | PlayersDiskShift 0.1 | | + | |
| - | | PlayersResetJump | | + | timestr(now: |
| - | PlayersResetJump | | + | now - is variable representing time. Function return string with time in short format such as " |
| - | | PlayersSetJump | | + | timestrlong(now: |
| - | PlayersSetJump | | + | now - is variable representing time. Function return string with hours, minutes, seconds, such as " |
| - | | PlayersSetLoop | | + | datestr(now: |
| - | PlayersSetLoop | | + | now - is variable representing date. Function return string short date format such as " |
| - | | Position | | + | datestrlong(now: |
| - | Position 0,0,0 | X,Y,Z position. | + | now - is variable representing date. Function return string long date format such as "21 ������ 2012 �." |
| - | | PositionDelta | | + | dayofweek(now: |
| - | PositionDelta 0,0,0 | X,Y,Z | | + | |
| - | | PositionIndex | | + | dayofweeklong(now:float): |
| - | PositionIndex 1,0 | one axiz only: 1 is X, 2 is Y, 3 is Z. Second paramater is Value, 0 center, 100 is max | | + | |
| - | | PositionX | | + | ==== String functions ==== |
| - | PositionX 0 |-100..100 | | + | |
| - | | PositionY | | ||
| - | PositionY 0 |-100..100 | | ||
| - | | PositionZ | | + | uppercase(string): |
| - | PositionZ 0 |-100..100 | | + | |
| - | | PreviewMaster | | + | lowercase(string: |
| - | PreviewMaster | | + | |
| - | | PreviewNxN | | + | crlf: |
| - | PreviewNxN 1 | 1 - laser, 2 - 2x2, 3 - 3x3, 4 - 4x4 | | + | |
| - | | ProTrackDisk | | ||
| - | ProTrackDisk 1, 0.1 | | ||
| - | | ProTrackDiskShift | | ||
| - | ProTrackDiskShift 0.1 | | ||
| - | | ProTrackResetJump | | + | ==== Clock And Metronome ==== |
| - | ProTrackResetJump | | + | |
| - | | ProTrackSetJump | | ||
| - | ProTrackSetJump | | ||
| - | | ProTrackSetLoop | | + | b2s(beats) - transform beats to seconds |
| - | ProTrackSetLoop | | + | |
| - | | ProjectionZonesDialog | | + | b2ms(beats) - transform beats to milliseconds |
| - | ProjectionZonesDialog | | + | |
| - | | PulseEvent | | + | s2b(seconds) - transform seconds to beats |
| - | PulseEvent " | + | |
| - | | QLog | | + | b2s(seconds) - transform beats to seconds |
| - | QLog "My message | + | |
| - | | RGBA | | ||
| - | RGBA 255, | ||
| - | | RGBADelta | | + | ==== Functions ==== |
| - | RGBADelta 0,0,0,0 | | + | |
| - | | ReStartCell | | ||
| - | RestartCell | restart current cell | | ||
| - | | ReStoreZoneSelection | | + | There are a few functions for access of incoming data |
| - | ReStoreZoneSelection | | + | |
| - | | RebootConnectedFB4 | | + | Dmx ( Channel, OutputMin, OutputMax ) |
| - | RebootConnectedFB4 | If you need to use this command then please contact Pangolin (report@pangolin.com) and tell what is wrong with your FB4. Thanks. | | + | Parameters: |
| + | Channel - index of DMX channel, acceptable value from 1 to 2048 | ||
| + | OutputMin, OutputMax - defines the range resulting value of the function. Oupout value will start from OutputMin | ||
| + | result | ||
| - | | RefreshDmxIn | | + | Example: |
| - | RefreshDmxIn | activate update of DMX IN reactions, independently on data changed or no | | + | |
| - | | RegisterOscFeedback | | + | in this example we use Position command that has 3 arguments - X,Y,Z and we use DMX IN values (three channels, 10,11,12), and map the values range -100 to +100. |
| - | RegisterOscFeedback "/ | + | |
| - | | ResetCuesFX | | + | Dmx ( Channel |
| - | ResetCuesFX | | + | or |
| + | Dmx( Channel, OutputMin, OutputMax) | ||
| + | Parameters: | ||
| + | Channel - index of DMX channel, acceptable value from 1 to 2048 | ||
| + | Result of the function is value of DMX channel as it is, without anr range adjustments | ||
| - | | ResetFxTiming | | + | OutputMin, OutputMax - defines the range resulting value of the function. Output value will start from OutputMin and increase up to OutputMax. Internally channels are normalized to 0...1 range |
| - | ResetFxTiming | | + | result |
| + | Example: | ||
| + | DisplayPopup Dmx(10) // display the value of 10th DMX channel. | ||
| - | | ResetLCTab | | + | Note: version with min/max used for simplification of use of function in operators where you may need to transform DMX value range (0..255) to some other range. As example Size operator, you may want to use size range like 0...100, or 10...100, or -100..100. |
| - | ResetLCTab | | + | |
| - | | ResetLiveControl | | + | Channel ( Channel, OutputMin, OutputMax ) |
| - | ResetLiveControl | | + | or |
| + | Channel( Channel ) | ||
| - | | ResetMasterFX | | + | Parameters: |
| - | ResetMasterFX | | + | Channel - index of Channel, acceptable value from 1 to 255 |
| + | OutputMin, OutputMax - defines the range resulting value of the function. Output value will start from OutputMin and increase up to OutputMax. Internally channels are normalized to 0...1 range | ||
| + | result | ||
| - | | ResetMidiFeedback | | + | If function has one argument then result is normalized channel value (range from 0 to 1) |
| - | ResetMidiFeedback | | + | |
| - | | ResetOscFeedback | | + | Example: |
| - | ResetOscFeedback | | + | Size Channel(10, 5, 100), ChannelIn(10, |
| - | | ResetPosition | | + | in this example we use Size command that has 3 arguments - X, Y,Z and we use Channel 10 value for all 3 axis. |
| - | ResetPosition | | + | |
| - | | ResetProTrackFX | | + | Channel ( Channel ) |
| - | ResetProTrackFX | | + | Parameters: |
| + | Channel - index of Channel, acceptable value from 1 to 255 | ||
| + | Result of the function is channel value. Channel value is normalized, the range from 0 to 1. | ||
| - | | ResetRotation | | ||
| - | ResetRotation | | ||
| - | | ResetRotationX | | + | CC (Channel, Controller, OutputMin, OutputMax) |
| - | ResetRotationX | | + | Get a value of of MIDI controller. BEYOND memorize all values of incoming MIDI controllers (Contrl Change Message) and you can get an access to it. |
| + | Channel - value 0..15 | ||
| + | Controller - value 0..127. Thsi is Data1 in MIDI messages | ||
| + | OutputMin, OutputMax - defines the range resulting value. Result | ||
| - | | ResetRotationY | | ||
| - | ResetRotationY | | ||
| - | | ResetRotationZ | | + | ExtValue( OutputMin, OutputMax ) |
| - | ResetRotationZ | | + | There are a few pretty big tables of code-sources. A tables such as DMX, ArtNet, ControlChange, |
| + | PositionIndex 1, ExtValue(-100, | ||
| + | In this example PositionIndex is a live control command, see below. 1 is index of axis. And finally ExtValue() is a fuction that take DMX channel value in map to rangle -100 to 100. | ||
| - | | ResetZonesFX | | + | ExtDelta( Delta ) |
| - | ResetZonesFX | | + | Function equal to ExtValue but made specially for MIDI encoders. There are many controlled with wheels and knobs that generate Control Change message and the data2 value is 00 or 7F. That is all, no values in between. For such cases has a sense to use " |
| - | | Restart | | + | PositionDelta 0, ExtDelta(1), |
| - | Restart | | + | |
| - | | RestartCue | | + | another example: |
| - | RestartCue 1,1 | page, cue | | + | |
| - | | RestorePlayer | | + | AngleDelta 0,0, ExtDelta(45) // rotate by Z on 45 degrees. |
| - | RestorePlayer | | + | |
| - | | ResyncByCueClick | | + | Random( MaxValue ) |
| - | ResyncByCueClick On | options: On, Off, Toggle | | + | Function return random value in range 0..MaxValue. Note, MaxValue included into the range |
| - | | RotoSpeed | | + | RandomIn( MinValue, MaxValue ) |
| - | RotoSpeed 0,0,0 | rotation speed by X,Y,Z axis. degree. | | + | Functino return random value in range MinValue..MaxValue |
| - | | RotoSpeedDelta | | + | Param( ParamIndex ) - newer name of OscParam() function. It get the value of parameter supplied into the script. See commend about OscParam() |
| - | RotoSpeedDelta 0,0,0 | increment | + | |
| - | | RotoSpeedX | | + | OscParam( ParamIndex ) |
| - | RotoSpeedX 0 | rotation speed, degree | | + | Specialy designed for use in "OSC to CODE" table.. When BEYOND receive OSC message and supply it into interpreter to execution, then we can supply up to 10 parameters with OSC message. BEYOND put them into local array, and you may use it inside the Code. Note, data is there only during execution of current script. As soon we exit from execution of this script, data will be lost. OK, parameter index is from 1 up to 10. BEYOND check how many parameters the OSC message has, and if you will try to access non existing paramater then script will stop with error. So, if OSC message has 3 parameters, then you can use index from 1 to 3. Accepts f, i, and s type of OSC parameters. You can freely mix float and integer. |
| - | | RotoSpeedY | | + | ParamRange( MinValue, MaxValue) function return TRUE (1) if the first parameter inside the specified range. |
| - | RotoSpeedY 0 | rotation speed, degree | | + | |
| - | | RotoSpeedZ | | + | ParamRange(ParamIndex, |
| - | RotoSpeedZ 0 | rotation speed, degree | | + | |
| - | | RunApp | | + | GetTransitionName( index ) |
| - | RunApp " | + | function return string, the name of transition. Index is number of transition. Range 0..23 |
| - | | Saturation | | + | BeatTime |
| - | Saturation 0 | | + | Function has no arguments. The result of function is float point number. Integer part of function is number of beat from the start of BEYOND. The fractional part is progress inside the beat. |
| - | | SaturationDelta | | + | GetMidiDeviceIndex |
| - | SaturationDelta 0 | | + | function return currently selected MIDI Device pair, Value range 1..4. |
| - | | ScanRate | | + | ObjectExists( AObjectName ) - function get object name a s string and return 1 if object exists, or zero if object is not found. |
| - | ScanRate 100 | | + | |
| - | | ScanRateDelta | | ||
| - | ScanRateDelta 0 | | ||
| - | | SelectAllCat | | + | ==== Timecode input ==== |
| - | SelectAllCat | | + | |
| - | | SelectAndFocusZone | | ||
| - | SelectAndFocusZone 1 | zone index, 1..N. | | ||
| - | | SelectCat | | + | GetTimeCode - return latest timecode value as a float point value, value in seconds |
| - | SelectCat 1 | category index, 1..N. | | + | |
| - | | SelectCatName | | + | GetTimeCodeTick - return the tick when the last timecode value arrived. Use function GetTick for getting the current tick value. |
| - | SelectCatName " | + | |
| - | | SelectCue | | + | ==== Cue related functions ==== |
| - | SelectCue " | + | |
| - | | SelectFixt | | ||
| - | SelectFixt 0 | index(es) or name(s) | | ||
| - | | SelectGrid | | + | 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. |
| - | SelectGrid | + | Example: CuePlaying(1,1) //return state of first cue on a first page. Note, function is not applicable for ProTracks and DMX server. |
| - | | SelectMidi | | + | CueEmpty(PageIndex, CueIndex) - function return |
| - | SelectMidi 1 | select MIDI device pair, 1..4. | | + | |
| - | | SelectNextCat | | + | GetCueCaptionColor(PageIndex, |
| - | SelectNextCat | | + | |
| - | | SelectNextCatGrid1 | | ||
| - | SelectNextCatGrid1 | | ||
| - | | SelectNextPage | | + | ==== Misc ==== |
| - | SelectNextPage | | + | |
| - | | SelectNextPageGrid1 | | ||
| - | SelectNextPageGrid1 | | ||
| - | | SelectNextTab | | + | GetBeyondBuild - return integer value, build of BEYOND application. |
| - | SelectNextTab | | + | |
| - | | SelectNextTabGrid1 | | + | GetMidiDeviveIndex - return current MIDI device index associated with this script. BEYOND can use 4 MIDI devices. By default script associated with 1st device. There is a command for change device index. This function allows to check current association. Indexing from 1. |
| - | SelectNextTabGrid1 | | + | |
| - | | SelectPage | | + | GetMidiDeviceLayer - return current layer of MIDI device mapping. |
| - | SelectPage | + | |
| - | | SelectPageName | | + | ==== User Interface ==== |
| - | SelectPageName " | + | |
| - | | SelectPrevCat | | ||
| - | SelectPrevCat | | ||
| - | | SelectPrevCatGrid1 | | + | GetLcTabMode: |
| - | SelectPrevCatGrid1 | | + | Values are: |
| + | 1 - Master | ||
| + | 2 - Cue | ||
| + | 3 - Zone | ||
| + | 4 - ProTrack | ||
| - | | SelectPrevPage | | + | GetTcTabMode: |
| - | SelectPrevPage | | + | |
| - | | SelectPrevPageGrid1 | | + | GetFxTabMode: |
| - | SelectPrevPageGrid1 | | + | |
| - | | SelectPrevTab | | + | GetGrid1Mode: |
| - | SelectPrevTab | | + | 0 - Select mode |
| + | 1 - Flash mode | ||
| + | 2 - FlashSolo mode | ||
| + | 3 - Toggle mode | ||
| + | 4 - Restart mode | ||
| + | 5 - ProTrack mode | ||
| - | | SelectPrevTabGrid1 | | + | GetGrid2Mode: |
| - | SelectPrevTabGrid1 | | + | |
| - | | SelectProTrack | | ||
| - | SelectProTrack 1 | index(es) (1..N) or name(string). Can be used more than one argument | | ||
| - | | SelectProjector | | + | ==== Timeline mode functions ==== |
| - | SelectProjector 1 | index(es) (1..N) or name(string). Can be used more than one argument | | + | |
| - | | SelectTab | | ||
| - | SelectTab 1 | tab index, 1..N. | | ||
| - | | SelectTabName | | + | GetTimelinePos: |
| - | SelectTabName " | + | |
| - | | SelectZone | | + | GetTimelineDuration: |
| - | SelectZone 1 | zone index, 1..N. | | + | |
| - | | SelectZoneName | | + | GetTimelineOnline: |
| - | SelectZoneName | + | |
| - | | SetActiveGrid | | + | GetTImelinePlaying: |
| - | SetActiveGrid | + | |
| - | | SetAttractionSlider | | + | GetTimlineTabIndex: |
| - | SetAttractionSlider 10 | | + | |
| - | | SetAudioGain | | + | GetTimelineTabName: |
| - | SetAudioGain 10 | 1..15 | | + | |
| - | | SetAudioInGain | | ||
| - | SetAudioInGain 10 | 1 is min, 15 is max, 10 default | | ||
| - | | SetAudioInRelease | | ||
| - | SetAudioInRelease 75 | 1 is min, 99 is max (slowest) 75 is default | | ||
| - | | SetAudioRelease | | + | ==== FX and Live Control commands ==== |
| - | SetAudioRelease 75 | 1..99 | | + | |
| - | | SetBpm | | ||
| - | SetBpm 120 | | ||
| - | | SetBpmDelta | | + | The Destination |
| - | SetBpmDelta 1 | | + | |
| - | | SetButtonMSL | | + | A few words about commands of BEYOND. Each command of BEYOND has information about: |
| - | SetButtonMSL 1 | | + | Sender - who initiated the command |
| + | Server - who is recipient / server of the command. As example - zone, cue, master, and so on | ||
| + | Server index - index of server, of there are many such servers. As example - Projection Zone | ||
| + | Command - the command itself | ||
| + | Arguments - depends on exact commands. | ||
| - | | SetChannelToChannelRatio | | + | Lets consider example. We want to set the size of second projection zone to 50%. In this case, command will have such values |
| - | SetChannelToChannelRatio 0 | 0..100 | | + | Sender - BEYOND set it automatically, |
| + | Server - Zone | ||
| + | Server index - 2 | ||
| + | Command - Size | ||
| + | Arguments - 50,50,50 | ||
| - | | SetCueCaptionColor | | + | For the script, to make a complex command that include all fields is not practical. Because the process has two parts. The first part - you define the destination. By default it is Master. The second part is a Command itself. BEYOND memorize the setting of destination and all consequent commands will use it. |
| - | SetCueCaptionColor 1,2, 0x0000FF | + | |
| - | | SetDmxEditorChannel | | ||
| - | SetDmxEditorChannel 1, 128 | | ||
| - | | SetDmxToChannelRatio | | ||
| - | SetDmxToChannelRatio 0 | 0..100 | | ||
| - | | SetEffectChannelAction | | + | ==== WaitFor command group ==== |
| - | SetEffectChannelAction 0 |0..100 | | + | |
| - | | SetFFTToChannelRatio | | ||
| - | SetFFTToChannelRatio 0 | 0..100 | | ||
| - | | SetFX | | + | Sleep Time |
| - | SetFX 1, 1 | Layer number: 1..4, Effect index: 1..100 | | + | Parameters: Time measured in milliseconds |
| + | Purpose: Allow to pause execution to defined time | ||
| + | Example | ||
| + | Example 2: | ||
| + | MidiOut 0x90, 0x40, 0x7F | ||
| + | Sleep(500); | ||
| + | MidiOut 0x90, 0x40, 0x00 | ||
| + | Sleep(500); | ||
| + | Restart | ||
| - | | SetFX1MSL | | ||
| - | SetFX1MSL 1 | | ||
| - | | SetFX2MSL | | ||
| - | SetFX2MSL 1 | | ||
| - | | SetFX3MSL | | ||
| - | SetFX3MSL 1 | | ||
| - | | SetFX4MSL | | + | ==== Timeline control ==== |
| - | SetFX4MSL 1 | | + | |
| - | | SetFX5MSL | | ||
| - | SetFX5MSL 1 | | ||
| - | | SetFX6MSL | | + | PlayTimeline |
| - | SetFX6MSL 1 | | + | Start playback of current show in timeline editor |
| - | | SetFXAction | | + | StopTimeline |
| - | SetFXAction 1, 100 | Layer number: 1..4, Action 0..100 percent | | + | Stop playback of current show in timeline editor |
| - | | SetFXAction1 | | + | TimelineMarker |
| - | SetFXAction1 100 | Action 0..100 percent | | + | Add timeline marker. There are 3 modifications |
| + | TimelineMarker (no arguments) - add marker at current position and current color | ||
| + | TimelineMarker Color - addmarker with specified color at current time position | ||
| + | TimelineMarker Color, Time - add marker with specified color at specified time | ||
| + | Time - time in seconds, float point | ||
| + | Color - index, 1..10; | ||
| - | | SetFXAction2 | | ||
| - | SetFXAction2 100 | Action 0..100 percent | | ||
| - | | SetFXAction3 | | ||
| - | SetFXAction3 100 | Action 0..100 percent | | ||
| - | | SetFXAction4 | | ||
| - | SetFXAction4 100 | Action 0..100 percent | | ||
| - | | SetFXAction5 | | + | ==== Property Animation ==== |
| - | SetFXAction5 100 | Action 0..100 percent | | + | |
| - | | SetFXAction6 | | ||
| - | SetFXAction6 100 | Action 0..100 percent | | ||
| - | | SetFXAction7 | | + | Property animation designed for linear change of property from one state to another during some period of time. Technically, |
| - | SetFXAction7 100 | Action 0..100 percent | | + | |
| - | | SetFXAction8 | | + | Note, the execution of property animation performed right after execution of all script by dedicated thread of BEYOND. The time resolution is ~ 40 " |
| - | SetFXAction8 100 | Action 0..100 percent | | + | |
| - | | SetFXMul | | + | AnimateProp PropertyName, |
| - | SetFXMul 1, 1,1 | Layer number: 1..4, Multiplier 1 - default | + | PropertyName - string that contain complete name of object and its property. The property must be numeric. |
| + | StartValue | ||
| + | FinishValue - number. Specify final value of the property during animation. | ||
| + | DurationMS - duration of animation in milliseconds | ||
| + | FinishEvent - optional parameter, string. Specify name of Event that will be activated at the end of animation. Action equal to call of PulseEvent() procedure. | ||
| - | | SetFXMulAx | | + | Exmaple: |
| - | SetFXMulAx 1, 3, 1 | Layer number: 1..4, Mask (1 is clock, 2 is beat, 3 is clock and beat), Value of multiplier | | + | AnimapeProp " |
| + | // command change value of Master brightness from 100% to zero during 1000 ms (one second) | ||
| - | | SetFXMute | | + | Example2 : |
| - | SetFXMute 1, 0 | Layer number: 1..4, 0-Off, 1-On, 2-Toggle | | + | AnimapeProp " |
| + | // command change value of Master brightness from current value to zero during 500 ms (0.5 second) | ||
| - | | SetFrictionSlider | | ||
| - | SetFrictionSlider 10 | | ||
| - | | SetGrid1MSL | | + | AnimatePropDelta PropertyName, |
| - | SetGrid1MSL 1 | | + | PropertyName - string that contain complete name of object and its property. The property must be numeric. |
| + | TotalDelta- number. Specify how much will change the value of specified property | ||
| + | DurationMS - duration of animation in milliseconds | ||
| + | FinishEvent - optional parameter, string. Specify name of Event that will be activated at the end of animation. Action equal to call of PulseEvent() procedure. | ||
| - | | SetGrid1Page | | + | Example: |
| - | SetGrid1Page 1 | | + | AnimatePropDelta " |
| - | | SetGrid2MSL | | + | Example 2: |
| - | SetGrid2MSL | + | AnimatePropDelta " |
| - | | SetGrid2Page | | + | DeletePropAni PropertyName, |
| - | SetGrid2Page 1 | | + | Commamd delete existing animation-tasks from the pool. If no one parameter specified then command delete ALL tasks. Command can contain one or more names of properties. |
| + | PropertyName - string that contain complete name of object and its property. The property must be numeric. | ||
| - | | SetGridSize | | + | Example1: |
| - | SetGridSize 8,5 | | + | DeletePropAni |
| - | | SetGridView | | + | Example2: |
| - | SetGridView | | + | DeletePropAni " |
| - | | SetLimiterBeam | | + | Example3: |
| - | SetLimiterBeam 5 | | + | DeletePropAni " |
| - | | SetLimiterDMX | | ||
| - | SetLimiterDMX 5 | | ||
| - | | SetLimiterFlash | | + | ==== MIDI Surface Layer (MSL) ==== |
| - | SetLimiterFlash 4 | | + | |
| - | | SetLimiterHold | | ||
| - | SetLimiterHold 3 | | ||
| - | | SetLimiterPerGrid | | + | BEYOND offer more functions that can be mapped to MIDI sliders/ |
| - | SetLimiterPerGrid 10 | | + | |
| - | | SetLimiterPerZone | | + | MIDI Sufrace Layering allow connect multiple BEYOND features to one MIDI command (message). Layeing work with Main Grid, Secondary Grid, Sufrace Buttons, Surface Sliders, FX and Zone selection. Currently available 12 layers. Counting starts from 1 and up to 12. The function of BEYOND may belong to more than one layer. In this case this function stay active in all layers where it enabled. If the function of BEYOND is not enabled in current layer, then it will not react on assigned MIDI message, same as will not generate a feedback messages. |
| - | SetLimiterPerZone 3 | | + | |
| - | | SetLimiterProfile | | + | Simplified Layer control. |
| - | SetLimiterProfile 1 | | + | |
| - | | SetLimiterShow | | + | Each MIDI Mapping object has preperty Layer. When you write to this propetry then it change Layer of all tables. Such operation equal to using of 12 commands descrived below. |
| - | SetLimiterShow 2 | | + | |
| - | | SetLocation | | + | Example: |
| - | SetLocation 1, 0,0,0 | set one of 256 positions/ | + | Midi1.Layer=1 |
| + | Midi2.Layer=10 | ||
| + | Midi3.Layer=5 | ||
| - | | SetMassSlider | | ||
| - | SetMassSlider 4 | | ||
| - | | SetMidiLayer | | + | Detailed control. |
| - | SetMidiLayer 1 | 1..8. | | + | |
| - | | SetPage | | + | Each table has own Layer property that you can control independently. |
| - | SetPage 1 | | + | |
| - | | SetPhysicsCheckbox | | ||
| - | SetPhysicsCheckbox ON | | ||
| - | | SetPlayListView | | ||
| - | SetPlayListView | | ||
| - | | SetProTrackZones | | + | ==== Triggers ==== |
| - | SetProTrackZones 1, 1 | Track index/name, Zone name(es)/ | + | |
| - | | SetSliderMSL | | ||
| - | SetSliderMSL 1 | | ||
| - | | SetTimelineView | | + | " |
| - | SetTimelineView | | + | |
| - | | SetTransitionIndex | | + | The simplest and classic example is when DMX come into some range of values, and the fact that the value is in range now it create some reaction. If the is not the same as "if value is in range then we do something" |
| - | SetTransitionIndex 2 | | + | |
| - | | SetTransitionTime | | + | No doubt it is possible to make a trigger by means for " |
| - | SetTransitionTime 0.1 | | + | |
| - | | SetUCenterPage | | ||
| - | SetUCenterPage 1 | set first page | | ||
| - | | SetUEditPage | | + | Trigger definition commands |
| - | SetUEditPage 1 | set first page | | + | |
| - | | SetUMaxPage | | + | DefineDmxTrigger ChannelIndex - this command |
| - | SetUMaxPage 1 | set first page | | + | |
| - | | SetUPreviewPage | | + | DefineMidiTrigger Message, Data1 - this command |
| - | SetUPreviewPage 1 | set first page | | + | |
| - | | SetURightPage | | + | DefineTrigger String-Expression, |
| - | SetURightPage 1 | set first page | | + | |
| - | | SetUToolPage | | + | The top level logic of these command is this. The most possible, the triggers will work with MIDI and DMX consoles. The trigger must be fix, and effective, because it will work on a high speed, because we have a trigger specially made for MIDI and DMX. BEYOND precalculate values and do it all in native code. But, not doubt will appear a need in some universal method, and in this case will help universal command DefineTrigger. This command work with expression, it is more slow because BEYOND need to calculate expression all the time, but it is very flexible, and work for all types of input data. You can use objects, variables, functions, expression and so on. It can work with Audio, Kinect or DMX, Universe or GamePad and any mix of this. So, for DefineTrigger we need to supply text of expression to trigger engine, and it is a string. |
| - | SetUToolPage 1 | set first page | | + | |
| - | | SetUniverseView | | ||
| - | SetUniverseView | | ||
| - | | SetVdjToChannelRatio | | + | Trigger range commands |
| - | SetVdjToChannelRatio 0 | 0..100 | | + | |
| - | | SetWorkspacePageCount | | + | Here a formal description of commands, examples and logic after that. |
| - | < | + | |
| - | | SetZoneMeshPointPos | | + | InRangeTrigger MinValue, MaxValue, LabelName |
| - | SetZoneMeshPointPos 1, 1,1, 0,0 | Zone index, X node index, Y node index, X coordinate (-32K..32K), y coordinate | | + | The action will be activated when values comes in range between MinValue and MaxValue. When it happen the scripter does goto to LabelName |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue | ||
| + | LabelName - string that contain label name | ||
| - | | SetZoneMuteMSL | | + | InRangeTriggerCmd MinValue, MaxValue, Command |
| - | SetZoneMuteMSL 1 | | + | The action will be activated when values comes in range between MinValue and MaxValue. When it happen the scripter execute Command. |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue - number, a maximum value of the range | ||
| + | Command- string that contain a PangoScript command | ||
| - | | SetZoneSelMSL | | ||
| - | SetZoneSelMSL 1 | | ||
| - | | ShiftFX | | + | OutOfRangeTrigger MinValue, MaxValue, LabelName |
| - | ShiftFX 1, 1 | Layer 1..4, delta | | + | The action will be activated when values comes out of range of MinValue and MaxValue. When it happen the scripter does goto to LabelName. |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue - number, a maximum value of the range | ||
| + | LabelName - string that contain label name | ||
| - | | ShiftFocus | | + | OutOfRangeTriggerCmd MinValue, MaxValue, Command |
| - | ShiftFocus -5 | go back and forth on N cells | | + | The action will be activated when values goes out of range of MinValue |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue - number, a maximum value of the range | ||
| + | Command- string that contain a PangoScript command | ||
| - | | ShowHint | | ||
| - | ShowHint " | ||
| - | | ShowItNowSMS | | + | IncreaseTrigger MinValue, MaxValue, LabelName |
| - | ShowIsNowSMS 1 | | + | The action will be activated when value increase and stay in range of MinValue and MaxValue. When it happen the scripter does goto to LabelName. |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue - number, a maximum value of the range | ||
| + | LabelName - string that contain label name | ||
| - | | ShowMasterHelpFile | | ||
| - | ShowMasterHelpFile | | ||
| - | | ShutDownWindows | | + | DecreaseTrigger MinValue, MaxValue, LabelName |
| - | ShutDownWindows | require ShutDownWindows.exe application | | + | The action will be activated when value decrease and stay in range of MinValue and MaxValue. When it happen the scripter does goto to LabelName. |
| + | MinValue - number, a minimum value of the range | ||
| + | MaxValue - number, a maximum value of the range | ||
| + | LabelName - string that contain label name | ||
| - | | Size | | + | About the logic |
| - | Size 100,100,100 | Size X,Y,Z axis | | + | |
| - | | SizeDelta | | + | The most simple is InRangeTrigger command. When values comes in range, then something happen. We can define a few ranges, and when value comes into the range then something will happen. What will happen? We considered a few options, and appeared that in simplest case one simple command will be enough. I mean, Blackout, or EnableLaserOutput, |
| - | SizeDelta 0,0,0 | shift Size value | | + | |
| - | | SizeIndex | | + | There is inverted version of InRangeTrigger - OutOfRange trigger. The only different is goes to be activated when value goes out of range. All the rest is equal. There in Min and Max value, and there version of command for Command and for Label. |
| - | SizeDelta 0,0 | | + | |
| - | | SizeX | | + | The third variation of trigger allow define reaction on the increase or decrease of the value. it work like this: scripter memorize current value, and if the new value is bigger (or smaller) than current state then it active the trigger. |
| - | SizeX 100 | | + | |
| - | | SizeY | | + | No doubt, we can add more commands, add more functionality to trigger. The range oriented commands is a classic. The increase/ |
| - | SizeY 100 | | + | |
| - | | SizeZ | | + | Rule of 3 words: Type, Range, Interaction |
| - | SizeZ 100 | | + | T - type of the trigger - DMX, or MIDI, or universal |
| + | R - range, | ||
| + | I - interaction, | ||
| - | | Sleep | | + | Example 1: Enable/ |
| - | Sleep 1000 | | + | |
| - | | SoloProTrack | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | SoloProTrack 1 | index(es) or name(s) | | + | InRangeTriggerCmd 0, |
| + | InRangeTriggerCmd 64, | ||
| - | | StartAudioRecord | | + | This trigger react in the MDI slider 0xB0, 0x00, and has values in range of 0..127. When slider in lower half the laser output will be disables, and when in higher half, then output will be disables. Now command bby comamnd: |
| - | StartAudioRecord | | + | |
| - | | StartCell | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | StartCell | start current cell | | + | DefineMidiTrigger |
| + | 0xB0, 0x00 - this is slider parameter | ||
| + | " | ||
| - | | StartCode | | ||
| - | StartCode " | ||
| - | | StartCue | | + | InRangeTriggerCmd 0, |
| - | StartCue 1,1 | | + | InRangeTriggerCmd - command, define the range and command |
| + | 0,63 - the range | ||
| + | " | ||
| - | | StartPrevious | | ||
| - | StartPrevious | " | ||
| - | | StartTalkClient | | + | InRangeTriggerCmd 64, |
| - | StartUdpTalkClient | | + | InRangeTriggerCmd - command that define second range |
| + | 64,127 - second range | ||
| + | " | ||
| - | | StartTalkServer | | ||
| - | StartUdpTalkServer | | ||
| - | | StopAllAsync | | ||
| - | StopAllAsync 0.5 | duration in seconds | | ||
| - | | StopAllNow | | + | Example 2: Same as example 1, but with goto |
| - | StopAllNow | no arguments | | + | |
| - | | StopAllSync | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | StopAllSync | + | InRangeTrigger 0,63, " |
| + | InRangeTrigger 64,127, " | ||
| + | exit // we need to exit because we should stop script execution after the declaration | ||
| - | | StopAudioRecord | | + | D1: // this is label used 1st range |
| - | StopAudioRecord | | + | DisplayPreview " |
| + | DisableLaserOutput // Commamd | ||
| + | exit // we should stop script execution, otherwise it will do below | ||
| - | | StopCell | | + | D2: // this is label used 2nd range |
| - | StopCell | stop current cell | | + | DisplayPreview " |
| + | EnableLaserOutput | ||
| + | exit // we should | ||
| - | | StopCode | | + | Commentaries for this example. The script itself is bigger, and there are sections for definition and for corresponding scripts. There are two typical mistakes |
| - | StopCode " | + | 1. Do not forger to put exit instruction |
| + | 2. Ensure that label name in code and in definition is the same. Otherwise, it will not work. Label is case sensitive. | ||
| - | | StopCue | | + | And general advice - use DisplayPreview, DisplayPopup or qlog for debug purpose. It might be good idea to create a trigger definition with all jumps, and put inside commands like DipsplayPreview only, without real functionality. Once you see that the logic works fine, the put there the rest of code. |
| - | StopCue 1,1 | | + | |
| - | | StopCueNow | | ||
| - | StopCueNow 1, 1 | page 1..100, cue 1..100 | | ||
| - | | StopCueSync | | + | Example 3: Slider at first time do Enable Laser, and and second |
| - | StopCueSync 1, 1, 0.5 | page 1..100, cue 1..60, time 0.. | | + | |
| - | | StopCueType | | + | This code based on previous, but it use variable. Variable organize a |
| - | StopCueType 255 |Mask: 1-Image, 2-Timeline, 4-DMX, 8-Sequence, 16-Beams, 32-Capture | | + | |
| - | | StopFX | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | StopFX | One or more layers. | + | InRangeTrigger 64,127, " |
| + | var counter // declare variable | ||
| + | counter=0 // initialize variable | ||
| + | exit | ||
| - | | StopFxCell | | ||
| - | StopFXCell | Layer index, optional Cell index (relative, take into account scrollbar) | | ||
| - | | StopOnBlackout | | + | Trick1: |
| - | StopOnBlackout | + | DisplayPreview Counter |
| + | if (Counter=0) EnableLaserOutput | ||
| + | if (Counter=1) DisableLaserOutput // action when Count is 1 | ||
| + | Counter=(Counter+1) % 2 // increment counter and divide by modulus 2, so, it will be 0,1,0,1,0,1 and so on | ||
| + | exit // stop this section | ||
| - | | StopProTrack | | ||
| - | StopProTrack 1 | index(es) (1..N) or name(string). Can be used more than one argument | | ||
| - | | StopProTrackFX | | + | Example 4: The same as example 4, but with Goto |
| - | StopProTrackFX 1, 1 | Track index/name and FX line index(es). Counting from 1. If no arguments at all - stop all FX on all tracks | | + | |
| - | | StopTalkClient | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | StopUdpTalkClient | | + | InRangeTrigger 64,127, " |
| + | var counter | ||
| + | counter=1 | ||
| + | exit | ||
| - | | StopTalkServer | | + | Trick1: |
| - | StopUdpTalkServer | | + | DisplayPreview Counter |
| + | Counter=(Counter+1) % 2 | ||
| + | if (Counter=0) goto When0 | ||
| + | if (Counter=1) goto When1 | ||
| + | exit | ||
| - | | StopTimeline | | + | When0: |
| - | StopTimeline | | + | EnableLaserOutput |
| + | exit | ||
| - | | StoreZoneSelection | | + | When1: |
| - | StoreZoneSelection | | + | DisableLaserOutput |
| + | exit | ||
| - | | StrobeSpeed | | + | Well, example, is similar, and show that you can use additional Goto instructions. |
| - | StrobeSpeed 0.2 | period, flicker per second | | + | |
| - | | StrobeSpeedDelta | | + | Example 5 |
| - | StrobeSpeedDelta 0.1 | period, flicker per second | | + | |
| - | | SynchronizePlayerToBeat | | + | What I want to demonstrate by this example - BEYOND does a goto when it execute a trigger. It means this. You can do goto by means of script command. But trigger engine use the same goto. Look a the code, comments below |
| - | SynchronizePlayerToBeat On | options: On, Off, Toggle | | + | |
| - | | TapByCueClick | | ||
| - | TapByCueClick On | options: On,Off, Toggle | | ||
| - | | TimelineAddMarker | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | TimelineAddMarker | + | InRangeTrigger 64,127, " |
| + | InRangeTrigger 0,63, " | ||
| + | exit | ||
| - | | TimelineEnableTC | | ||
| - | TimelineEnableTC | | ||
| - | | TimelineFirstTab | | + | Trick1: |
| - | TimelineFirstTab | | + | DisplayPopup " |
| + | Sleep 1000 | ||
| + | DisplayPopup " | ||
| + | Sleep 1000 | ||
| + | goto Trick1 | ||
| - | | TimelineJumpDelta | | + | StopIt: |
| - | TimelineJumpDelta 1 | one second | | + | DisplayPopup "I dont care" |
| + | exit | ||
| - | | TimelineJumpToEnd | | + | Two ranges, and main action in range of 64..127. The main action is after label Trick1. It has a dead loop. At least, it looks like dead loop. You see message panel with Yes and No and it will work until you move the slider down. It will break this endless loop. |
| - | TimelineJumpToEnd | | + | |
| - | | TimelineJumpToStart | | ||
| - | TimelineJumpToStart | | ||
| - | | TimelineLastTab | | + | Example 6: Lets try to use expressions... BPM notification |
| - | TimelineLastTab | | + | |
| - | | TimelineMarker | | + | DefineTrigger " |
| - | TimelineMarker | | + | InRangeTrigger 0, |
| + | InRangeTrigger 250, | ||
| + | exit | ||
| - | | TimelineNextEditPoint | | + | WhenSlow: |
| - | TimelineNextEditPoint | | + | DisplayPopup "Hey, dont sleep" |
| + | exit | ||
| - | | TimelineNextMarker | | + | WhenFast: |
| - | TimelineNextMarker | | + | DisplayPopup "Hey, too fast!" |
| + | exit | ||
| - | | TimelineNextTab | | + | This example use simplest expression - read the value of object property - Master.BPM, and depending on the BPM show the message. |
| - | TimelineNextTab | | + | |
| - | | TimelinePlay | | + | Example 7: Out of range. |
| - | TimelinePlay | | + | |
| - | | TimelinePlayFromMarker | | + | This example based on previous. The only change is OutOfRangeTrigger. This section will be activate when BPM is too slow or too fast. This is only example without big sense, but it it easy to test, because you can see BPM value on toolbar and have the slider that control it. |
| - | TimelinePlayFromMarker "" | + | |
| - | | TimelinePrevEditPoint | | + | DefineTrigger " |
| - | TimelinePrevEditPoint | | + | OutOfRangeTrigger 60, |
| + | exit | ||
| - | | TimelinePrevMarker | | + | WhenOutOf: |
| - | TimelinePrevMarker | | + | DisplayPopup "Hmm, this is not normal" |
| + | exit | ||
| - | | TimelinePrevTab | | + | Example 8: Starts/Stop timeline |
| - | TimelinePrevTab | | + | |
| - | | TimelineQuickSave | | + | DefineMidiTrigger 0xB0, 0x00, " |
| - | TimelineQuickSave | | + | InRangeTriggerCmd |
| + | InRangeTriggerCmd 64,127, " | ||
| - | | TimelineSetPos | | + | |
| - | TimelineSetPos 10 | jump to second 10 | | + | |
| - | | TimelineSetTabIndex | | + | </code> |
| - | TimelineSetTabIndex | | + | |
| - | + | ||
| - | | TimelineSetTabName | | + | |
| - | TimelineSetTabName " | + | |
| - | + | ||
| - | | TimelineSetViewRange | | + | |
| - | TimelineSetViewRange 1,5 | from s to 5 second | | + | |
| - | + | ||
| - | | TimelineShiftViewRange | | + | |
| - | TimelineShiftViewRange 1 | one second shift | | + | |
| - | + | ||
| - | | TimelineShowItNow | | + | |
| - | TimelineShowItNow 1 | set online mode for timeline editor | | + | |
| - | + | ||
| - | | TimelineStop | | + | |
| - | TimelineStop | | + | |
| - | + | ||
| - | | TimerBeat | | + | |
| - | TimerBeat | | + | |
| - | + | ||
| - | | ToggleCell | | + | |
| - | Toggle | start/stop current cell | | + | |
| - | + | ||
| - | | ToggleCue | | + | |
| - | ToggleCue 1,1 | | + | |
| - | + | ||
| - | | ToggleFX | | + | |
| - | ToggleFX 1 | Layer number: 1..4 | | + | |
| - | + | ||
| - | | ToggleMuteProTrack | | + | |
| - | ToggleMuteProTrack 1 | index(es) or name(s) | | + | |
| - | + | ||
| - | | ToggleMuteZone | | + | |
| - | ToggleMuteZone 0 | index(es) or name(s) | | + | |
| - | + | ||
| - | | ToggleMuteZoneOfProjector | | + | |
| - | ToggleMuteZoneOfProjector 1 | 1st projector | | + | |
| - | + | ||
| - | | TogglePrevious | | + | |
| - | TogglePrevious | " | + | |
| - | + | ||
| - | | ToggleSelectFixt | | + | |
| - | ToggleSelectFixt | | + | |
| - | + | ||
| - | | ToggleSelectProTrack | | + | |
| - | ToggleSelectProTrack 1 | index(es) (1..N) or name(s) | | + | |
| - | + | ||
| - | | ToggleSelectProjector | | + | |
| - | ToggleSelectProjector 1 | index(es) (1..N) or name(s) | | + | |
| - | + | ||
| - | | ToggleSelectZone | | + | |
| - | ToggleSelectZone 1 | zone index, 1..N. | | + | |
| - | + | ||
| - | | ToggleSoloProTrack | | + | |
| - | ToggleSoloProTrack 1 | index(es) or name(s) | | + | |
| - | + | ||
| - | | ToggleUCenterPage | | + | |
| - | ToggleUCenterPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | ToggleUEditPage | | + | |
| - | ToggleUEditPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | ToggleUMaxPage | | + | |
| - | ToggleUMaxPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | ToggleUPreviewPage | | + | |
| - | ToggleUPreviewPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | ToggleURightPage | | + | |
| - | ToggleURightPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | ToggleUToolPage | | + | |
| - | ToggleUToolPage 1 | Relative command. +1 means next page, -1 means previous | | + | |
| - | + | ||
| - | | Transition | | + | |
| - | Transition Toggle | + | |
| - | + | ||
| - | | UnMuteZonesOfProjector | | + | |
| - | UnMuteZonesOfProjector 1 | projector index, 1..N. | | + | |
| - | + | ||
| - | | UnSelectZone | | + | |
| - | UnSelectZone 1 | zone index, 1..N. | | + | |
| - | + | ||
| - | | UnSelectZoneName | | + | |
| - | UnSelectZoneName "Main Graphics" | + | |
| - | + | ||
| - | | UnSoloAllProTrack | | + | |
| - | UnSoloAllProTrack | | + | |
| - | + | ||
| - | | UnSoloProTrack | | + | |
| - | UnSoloProTrack 1 | index(es) or name(s) | | + | |
| - | + | ||
| - | | UnmuteAllProTracks | | + | |
| - | UnmuteAllProTracks | | + | |
| - | + | ||
| - | | UnmuteAllZone | | + | |
| - | UnmuteAllZone | | + | |
| - | + | ||
| - | | UnmuteProTrack | | + | |
| - | UnmuteProTrack 1 | index(es) or name(s) | | + | |
| - | + | ||
| - | | UnmuteZone | | + | |
| - | UnmuteZone 0 | index(es) or name(s) | | + | |
| - | + | ||
| - | | UnselectAllCue | | + | |
| - | UnselectAllCue | | + | |
| - | + | ||
| - | | UnselectAllFixt | | + | |
| - | UnselectAllFixt | | + | |
| - | + | ||
| - | | UnselectAllProTracks | | + | |
| - | UnselectAllProTracks | | + | |
| - | + | ||
| - | | UnselectAllProjectors | | + | |
| - | UnselectAllProjectors | | + | |
| - | + | ||
| - | | UnselectAllZones | | + | |
| - | UnselectAllZones | | + | |
| - | + | ||
| - | | UnselectFixt | | + | |
| - | UnselectFixt 0 | index(es) or name(s) | | + | |
| - | + | ||
| - | | UnselectProTrack | | + | |
| - | UnselectProTrack 1 | index(es) (1..N) or name(s) | | + | |
| - | + | ||
| - | | UnselectProjector | | + | |
| - | UnselectProjector 1 | index(es) (1..N) or name(s) | | + | |
| - | + | ||
| - | | VLJFX | | + | |
| - | VljFX 1, Toggle | index of FX-VLJ 1..4, and action: ON, OFF, TOGGLE | | + | |
| - | + | ||
| - | | Version | | + | |
| - | version | remote server will get exe file version | | + | |
| - | + | ||
| - | | VirtualLJ | | + | |
| - | VirtualLJ Toggle | ON, OFF, TOGGLE | | + | |
| - | + | ||
| - | | VisiblePoints | | + | |
| - | VisiblePoints 100 | 0..100 (percents) | | + | |
| - | + | ||
| - | | VisiblePointsDelta | | + | |
| - | VisiblePointsDelta 0 | | + | |
| - | + | ||
| - | | WaitForAudioBeat | | + | |
| - | WaitForAudioBeat 1 | | + | |
| - | + | ||
| - | | WaitForBeat | | + | |
| - | WaitForBeat 7, 1 | | + | |
| - | + | ||
| - | | WaitForCellDown | | + | |
| - | WaitForCellDown 1 | | + | |
| - | + | ||
| - | | WaitForCellUp | | + | |
| - | WaitForCellUp 1 | | + | |
| - | + | ||
| - | | WaitForChannel | | + | |
| - | WaitForChannel 1 | | + | |
| - | + | ||
| - | | WaitForCueStart | | + | |
| - | WaitForCueStart 1 1 | | + | |
| - | + | ||
| - | | WaitForCueStop | | + | |
| - | WaitForCueStop 1 1 | | + | |
| - | + | ||
| - | | WaitForDmx | | + | |
| - | WaitForDmx 1 | | + | |
| - | + | ||
| - | | WaitForEvent | | + | |
| - | WaitForEvent " | + | |
| - | + | ||
| - | | WaitForHotKey | | + | |
| - | WaitForHotKey | waiting for hotkey assigned to this script in Code-tab | | + | |
| - | + | ||
| - | | WaitForManualBeat | | + | |
| - | WaitForManualBeat 1 | | + | |
| - | + | ||
| - | | WaitForMidi | | + | |
| - | WaitForMidi 0x90, -1, -1 | | + | |
| - | + | ||
| - | | WaitForPageChange | | + | |
| - | WaitForPageChange | | + | |
| - | + | ||
| - | | WaitForTC | | + | |
| - | WaitForTC 15,30,0,0 | hours, minutes, seconds, ms | | + | |
| - | + | ||
| - | | WaitForTime | | + | |
| - | WaitForTime 15,30,0,0 | hours, minutes, seconds, ms | | + | |
| - | + | ||
| - | | WaitForTimePos | | + | |
| - | WaitForTimePos 21,00,00,00 | hours, minutes, seconds, ms | | + | |
| - | + | ||
| - | | WaitForTimerBeat | | + | |
| - | WaitForTimerBeat 1 | | + | |
| - | + | ||
| - | | Write | | + | |
| - | write | | + | |
| - | + | ||
| - | | WriteLn | | + | |
| - | writeln "Hello world!" | + | |
| - | + | ||
| - | | ZoneFXTimeScale | | + | |
| - | ZoneFXTimeScale 1,2,1 | Layer, Clock multipler, Metronome multiplier | | + | |
| - | + | ||
| - | | ZoneFXTimeScaleDelta | | + | |
| - | ZoneFXTimeScaleDelta 0, | + | |
| - | + | ||
| - | | ZoneFXTimeShift | | + | |
| - | ZoneFXTimeShift 1,2,1 | Layer, Clock multipler, Metronome multiplier | | + | |
| - | + | ||
| - | | ZoneFXTimeShiftDelta | | + | |
| - | ZoneFXTimeShiftDelta 0, | + | |
| - | + | ||
| - | | Zoom | | + | |
| - | Zoom 100 | value -100..100 | | + | |
| - | + | ||
| - | | ZoomDelta | | + | |
| - | ZoomDelta 0 | shift zoom value | | + | |
| - | + | ||
| - | | + | |
beyond/pangoscript_commands.1590490467.txt · Last modified: (external edit)