API
Contents |
Types
api.attributeTypes
Classes
api.cues
Used for working with cues.
api.groups
Used for working with groups.
api.output
Used for getting information about DMX output.
Methods
getTime
getTime() As Double
Gets the current playback position.
Usage:
print(api.getTime())
setTime
setTime(time As Double)
Sets the current playback position to the specified time.
Usage:
api.setTime(36.5) print(api.getTime())
getBPM
getBPM() As Double
Gets the BPM of the current cuelist
Usage:
print(api.getBPM())
wait
wait(seconds As Double)
Causes execution to wait for the specified number of seconds.
Usage:
api.wait(3.5)
isPlaying
isPlaying() As Boolean
Checks to see if the timeline is currently playing back.
Usage:
if(api.isPlaying()): api.stopPlayback()
startPlayback
startPlayback()
Starts timeline playback.
Usage:
if(api.isPlaying() == False): api.startPlayback()
stopPlayback
stopPlayback()
Stops timeline playback.
Usage:
if(api.isPlaying()): api.stopPlayback()
NextCue
nextCue()
Advances timeline to the next cue.
Usage:
api.nextCue()
PreviousCue
previousCue()
Moves timeline to the previous cue.
Usage:
api.previousCue()
Event Handling
onInitialize
Called when the script is loaded.
Usage:
def onInitialize(): print("Script Loaded")
onDispose
Called when the script is being disposed by either it being disabled, or by Lightforge closing.
Usage:
def onDispose(): print("Addon Disposing")
onEdit
Called when the script settings are being edited. Editing a script's settings from the Script Settings Dialog is only possible if this function is implemented in your code.
Usage:
def onEdit(): print("Settings Edit")
onExecute
Called when this script is specifically executed.
Usage:
def onExecute(): print("Script Executed")
onExecuteAsync
Called when this script is specifically executed. Code run from this function is executed asynchronously.
Usage:
def onExecuteAsync(): print("Script Executed Asynchronously")
onStartup
Called when Lightforge starts up.
Usage:
def onStartup(): print("Lightforge Started")
onStartupAsync
Called when Lightforge starts up. Code run from this function is executed asynchronously.
Usage:
def onStartupAsync(): print("Lightforge Started (Async)")
onPlaybackStart
Called when timeline playback has started.
Usage:
def onPlaybackStart(): print("Playback Started")
onPlaybackStop
Called when timeline playback has stopped
Usage:
def onPlaybackStop(): print("Playback Stopped")
onFrameChange
Called on every frame change during playback, scrubbing, and time changes.
Usage:
def onFrameChange(seconds As Double): print("Frame Changed " + seconds)
onShutdown
Called when Lightforge is shutting down.
Usage:
def onShutdown(): print("Lightforge Shutdown")
onCuelistChange
Called when the current cuelist has been changed.
Usage:
def onCuelistChange(): print("Cue List Changed")
onShowLoaded
Called when a new show has been loaded.
Usage:
def onShowLoaded(): print("Show Loaded")