Difference between revisions of "API"
From Light Forge Wiki
Chris Monson (Talk | contribs) |
Chris Monson (Talk | contribs) |
||
| Line 12: | Line 12: | ||
==onExecute== | ==onExecute== | ||
| + | Called when this script is specifically executed. | ||
| + | |||
Usage: | Usage: | ||
def onExecute(): | 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. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | def | + | Usage: |
| − | + | def onPlaybackStart(): | |
| − | + | print("Playback Started") | |
| − | + | ||
| − | def onShowLoaded(): | + | ==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") | ||
Revision as of 19:10, 6 May 2013
Contents |
Classes
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")
