API

Types

api.attributeTypes

api.attributeTypes

Classes

api.cues

Used for working with cues.

api.cues

api.groups

Used for working with groups.

api.groups

api.output

Used for getting information about DMX output.

api.output

Functions

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())

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()

Events

onInitialize

Called when the script is loaded.

Usage:

def onInitialize():
	print("Script Loaded")

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")