Revision as of 20:20, 6 May 2013

Classes

api.attributeTypes

api.attributeTypes

api.cues

api.cues

api.groups

api.groups

api.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)

Events

onExecute

Called when this script is specifically executed.

Usage:

  def onExecute():
     print("Script Executed")

onStartup

Called when Lightforge initially starts up.

Usage:

  def onStartup():
     print("Lightforge Started")	

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

onCuelistChanged

Called when the current cuelist has been changed.

Usage:

  def onCuelistChanged():
     print("Cue List Changed")

onShowLoaded

Called when a new show has been loaded.

Usage:

  def onShowLoaded():
     print("Show Loaded")