http://www.visualsorcery.com/LightForgeWiki/api.php?action=feedcontributions&feedformat=atom&user=Chris+MonsonLight Forge Wiki - User contributions [en]2026-10-11T11:01:50ZUser contributionsMediaWiki 1.20.0http://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-06-15T18:45:50Z<p>Chris Monson: /* getBPM */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Methods=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==getBPM==<br />
'''getBPM() As Double'''<br />
<br />
Gets the BPM of the current cuelist<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getBPM())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Event Handling=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onDispose==<br />
Called when the script is being disposed by either it being disabled, or by Lightforge closing.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onDispose():<br />
print("Addon Disposing")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-06-15T18:45:32Z<p>Chris Monson: /* Methods */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Methods=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==getBPM==<br />
'''getBPM() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getBPM())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Event Handling=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onDispose==<br />
Called when the script is being disposed by either it being disabled, or by Lightforge closing.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onDispose():<br />
print("Addon Disposing")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=InterfaceInterface2013-05-11T21:05:39Z<p>Chris Monson: /* Panels */</p>
<hr />
<div>The Lightforge interface is designed to be very customizable and allow you the ability to set up the interface in whatever manner makes the most sense to you, or however makes the most sense for your particular application.<br />
<br />
<br />
== Panels ==<br />
<br />
Panels are the main type of interface element that you will work with in Lightforge. Panels can be scaled, split into multiple panels, changed to different panels, or removed entirely. <br />
<br />
=== Working With Panels ===<br />
<br />
Every panel contains two handles. One to divide or remove a panel in the top right corner, and one to change the panel type in the top left corner.<br />
<br />
==== Dividing a Panel ====<br />
<br />
To divide a panel into two new panels, click and drag the top right handle either left, to divide the panel horizontally, or down to divide it vertically. An overlay will indicate which direction the panel will divide. If you wish to cancel this operation, just move your mouse back to the original handle position.<br />
<br />
==== Removing a Panel ====<br />
<br />
To remove a panel, click on the top right handle, and drag it outside the bounds of the panel. The panel will highlight in red indicating that it is going to be removed from the interface. To cancel this operation, move your mouse back to the original handle position.<br />
<br />
==== Changing the Panel Type ====<br />
<br />
To change the panel type, click on the top left handle, and select the type of panel you would like to use from the drop down menu.<br />
<br />
==== Resizing Panels ====<br />
<br />
To resize a panel, click and drag anywhere on the panel's border and drag the direction you'd like to scale it in.<br />
<br />
=== Panel Types ===<br />
<br />
==== Groups ====<br />
The [[Groups Panel]] is the primary means for managing and selecting your lighting rig.<br />
<br />
==== Timeline ====<br />
The [[Timeline Panel]] is used to manipulate lighting cues and audio files, and position them in time. <br />
<br />
==== Show List ====<br />
The [[Show List Panel]] allows you to move between multiple cue lists in a single show.<br />
<br />
==== Cue Editor ====<br />
The [[Cue Editor Panel]] is used to modify a cue's settings, remove groups or attributes, and keyframe changes over time.<br />
<br />
==== Show Controls ====<br />
The [[Show Controls Panel]] gives you basic transport control (play, pause, next, previous) as well as the ability to add new cues, and audio files, and enable or disable crossfades on certain attribute changes. <br />
<br />
==== Submasters ====<br />
The [[Submasters Panel]] allows you to record intensity information from multiple groups and fixtures at different intensities onto a single fader. <br />
<br />
==== Palettes ====<br />
The [[Palettes Panel]] lets you record presets that can be recalled live or recorded into cues.<br />
<br />
==== Effects ====<br />
The [[Effects Panel]] lets you select, create, and modify effects.<br />
<br />
==== Effect Settings ====<br />
The [[Effect Settings Panel]] allows you to adjust settings on effects, and keyframe effect changes over time. <br />
<br />
==== DMX ====<br />
The [[DMX Panel]] gives you the ability to view the DMX control data that is being output by Lightforge. It also allows you to do simple channel checks. <br />
<br />
==== Color Picker ====<br />
The [[Color Picker Panel]] lets you select a color to be applied to groups or fixtures.<br />
<br />
==== Intensity ====<br />
The [[Intensity Panel]] lets you set or fade to intensity values on groups or fixtures.<br />
<br />
==== Positioner ====<br />
The [[Positioner Panel]] gives you the ability to control the pan and tilt values on groups or fixtures.<br />
<br />
==== Attributes ====<br />
The [[Attributes Panel]] lets you adjust all the various attributes that a lighting fixture may utilize.<br />
<br />
==== Audio Player ====<br />
The [[Audio Player Panel]] lets you play back audio tracks without syncing them to your timeline.</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Api.outputApi.output2013-05-11T20:50:33Z<p>Chris Monson: </p>
<hr />
<div>=Methods=<br />
<br />
==getDMX==<br />
'''getDMX(universe As Integer) As Byte()'''<br />
<br />
Returns a byte array containing all current dmx data for the specified universe. If the specified universe doesn't exist this function returns null.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
dmxValues = api.output.getDMX(0)<br />
print(dmxValues[42])<br />
</syntaxhighlight><br />
<br />
==getUniverseCount==<br />
'''getUniverseCount() as Integer'''<br />
<br />
Returns the number of DMX universes in the current show.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
universeCount = api.output.getUniverseCount()<br />
print(universeCount)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-11T20:49:33Z<p>Chris Monson: /* Events */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Methods=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Event Handling=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onDispose==<br />
Called when the script is being disposed by either it being disabled, or by Lightforge closing.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onDispose():<br />
print("Addon Disposing")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-11T20:49:12Z<p>Chris Monson: /* Functions */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Methods=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onDispose==<br />
Called when the script is being disposed by either it being disabled, or by Lightforge closing.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onDispose():<br />
print("Addon Disposing")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=MediaWiki:SidebarMediaWiki:Sidebar2013-05-11T20:21:10Z<p>Chris Monson: </p>
<hr />
<div><br />
* navigation<br />
** mainpage|mainpage-description<br />
** API|API<br />
** recentchanges-url|recentchanges<br />
** randompage-url|randompage<br />
** helppage|help<br />
* SEARCH<br />
* TOOLBOX<br />
* LANGUAGES</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-11T06:14:45Z<p>Chris Monson: /* Events */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onDispose==<br />
Called when the script is being disposed by either it being disabled, or by Lightforge closing.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onDispose():<br />
print("Addon Disposing")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-10T01:17:14Z<p>Chris Monson: /* Functions */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==startPlayback==<br />
'''startPlayback()'''<br />
<br />
Starts timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying() == False):<br />
api.startPlayback()<br />
</syntaxhighlight><br />
<br />
==stopPlayback==<br />
'''stopPlayback()'''<br />
<br />
Stops timeline playback.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
==NextCue==<br />
'''nextCue()'''<br />
<br />
Advances timeline to the next cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.nextCue()<br />
</syntaxhighlight><br />
<br />
==PreviousCue==<br />
'''previousCue()'''<br />
<br />
Moves timeline to the previous cue.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.previousCue()<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-10T01:10:35Z<p>Chris Monson: /* Functions */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
==isPlaying==<br />
'''isPlaying() As Boolean'''<br />
<br />
Checks to see if the timeline is currently playing back.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
if(api.isPlaying()):<br />
api.stopPlayback()<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-10T00:59:55Z<p>Chris Monson: /* API */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
==Where To Go From Here==<br />
I would suggest investigating the [[API]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
<br />
[[API]]<br />
<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
<br />
[[Addon]]<br />
<br />
=Sample Addons=<br />
On this page you can find sample code for learning how to create addons.<br />
[[Sample Addons]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-10T00:59:45Z<p>Chris Monson: /* Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
==Where To Go From Here==<br />
I would suggest investigating the [[API]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
<br />
[[Addon]]<br />
<br />
=Sample Addons=<br />
On this page you can find sample code for learning how to create addons.<br />
[[Sample Addons]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-09T23:48:09Z<p>Chris Monson: /* onCuelistChanged */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChange==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChange():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T23:41:26Z<p>Chris Monson: </p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
==Where To Go From Here==<br />
I would suggest investigating the [[API]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]<br />
<br />
=Sample Addons=<br />
On this page you can find sample code for learning how to create addons.<br />
[[Sample Addons]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Main_PageMain Page2013-05-09T23:39:14Z<p>Chris Monson: </p>
<hr />
<div>'''Lightforge Wiki'''<br />
<br />
Welcome to the Lightforge Wiki, home of everything there is to know about using Lightforge<br />
<br />
[[Interface]]<br />
<br />
[[Panels]]<br />
<br />
[[Scripting]]<br />
<br />
[[Common Tasks]]<br />
<br />
[[General Lighting Concepts]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:36:37Z<p>Chris Monson: /* Lamps On */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
#called when the addon is selected in the addon's menu<br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
#select all the children for a given group <br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
#select group<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight><br />
<br />
<br />
=Lamps On=<br />
This addon allows you to specify a list of profile names and the value that the lamp channel must be assigned to in order to strike the lamp for that particular fixture. This addon runs automatically on startup asking if you'd like to turn the lamps on.<br />
<br />
This example is a little more complicated, utilizing file operations for saving and loading settings, asynchronous processing, as well as using Windows Forms for dialog boxes to adjust the addon's settings in Lightforge. The bulk of the code is devoted to setting up the forms and laying out controls for the dialog boxes.<br />
<br />
<syntaxhighlight lang=python><br />
import clr<br />
clr.AddReference("System.Drawing")<br />
clr.AddReference("System.Windows.Forms")<br />
from System.Drawing import Point<br />
from System.Windows.Forms import Application, Button, ListView, ListViewItem, View, Form, ContextMenu, TextBox, NumericUpDown, Label<br />
from System.Windows.Forms import MessageBox, MessageBoxButtons<br />
from System.Windows.Forms import FormBorderStyle, DialogResult<br />
<br />
profilesAndValues = []<br />
<br />
#called when the script is loaded<br />
def onInitialize():<br />
load()<br />
<br />
#called when the script settings are edited in the script settings dialog<br />
def onEdit():<br />
dlg = LampOnDialog()<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
save()<br />
<br />
#executes asyncronously when clicked from the Lightforge interface <br />
def onExecuteAsync():<br />
onStartupAsync()<br />
<br />
#called as Lightforge is starting up<br />
def onStartupAsync():<br />
global profilesAndValues<br />
if MessageBox.Show("Would you like to turn lamps on?", "Lamp Startup", MessageBoxButtons.YesNo) == DialogResult.Yes:<br />
print("")<br />
print("Turning Lamps On")<br />
<br />
#find profiles that match those in our profilesAndValues list and set values appropriately<br />
findProfiles("", profilesAndValues)<br />
<br />
#wait 5 seconds to allow the fixtures to process the command<br />
print("Waiting...")<br />
api.wait(5)<br />
<br />
#release the rig to remove the changes we made<br />
print("Releasing Fixtures")<br />
api.groups.releaseGroup("")<br />
<br />
<br />
#Search through rig to find the specified profiles and assign them the given values<br />
def findProfiles(groupPath, profileList):<br />
currentPath = groupPath<br />
<br />
#step through all children of the current group<br />
for i in range(0, api.groups.getChildCount(currentPath)):<br />
#build the group path for the next group<br />
if len(currentPath) == 0:<br />
currentPath = str(i)<br />
else:<br />
currentPath = groupPath + "," + str(i) <br />
<br />
found = False<br />
<br />
#step through all the profiles we've listed to see if this fixture's profile matches any of them<br />
for prf in profileList: <br />
if prf[0] in api.groups.getProfileName(currentPath):<br />
#set the value of this fixture to the value in the profile list<br />
api.groups.setAttribute(api.attributeTypes.lamp, int(prf[1]) * 256, currentPath)<br />
found = True<br />
<br />
#call this function on the tested group to work recursively through the groups<br />
if found == False and api.groups.getChildCount(currentPath) > 0:<br />
findProfiles(currentPath, profileList)<br />
<br />
#Save settings to file<br />
def save():<br />
global profilesAndValues<br />
strOutput = ""<br />
for prf in profilesAndValues:<br />
strOutput += prf[0] + ";" + str(prf[1]) + "\n"<br />
<br />
f = open(addon.getDirectory() + "Lamps On.settings", "w+")<br />
f.write(strOutput)<br />
f.close()<br />
<br />
#Load settings in from file <br />
def load():<br />
global profilesAndValues<br />
profilesAndValues = []<br />
try:<br />
f = open(addon.getDirectory() + "Lamps On.settings", "r+")<br />
for line in f:<br />
profilesAndValues.append(line.rstrip().split(';'))<br />
f.close()<br />
except: <br />
pass<br />
<br />
#Dialog box for assigning values to profiles <br />
class LampOnDialog(Form):<br />
<br />
def __init__(self):<br />
global profilesAndValues<br />
self.Text = 'Lamp On Settings'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
#List Box<br />
self.lstProfiles = ListView()<br />
self.lstProfiles.Location = Point(margin, margin)<br />
self.lstProfiles.Width = self.ClientRectangle.Width - (margin * 2)<br />
self.lstProfiles.Height = btnOk.Top - (margin * 2)<br />
self.Controls.Add(self.lstProfiles)<br />
self.lstProfiles.View = View.Details<br />
self.lstProfiles.Columns.Add("Profile")<br />
self.lstProfiles.Columns.Add("Value") <br />
self.lstProfiles.Columns[0].Width = self.lstProfiles.Width * 0.7<br />
self.refreshList()<br />
<br />
#Context Menu<br />
listContext = ContextMenu()<br />
listContext.MenuItems.Add("Add Profile")<br />
listContext.MenuItems[0].Click += self.addProfile<br />
listContext.MenuItems.Add("Edit")<br />
listContext.MenuItems[1].Click += self.editProfile<br />
listContext.MenuItems.Add("Remove")<br />
listContext.MenuItems[2].Click += self.removeProfile<br />
self.lstProfiles.ContextMenu = listContext<br />
<br />
#reload the profilesAndValues data into the ListView control<br />
def refreshList(self):<br />
global profilesAndValues<br />
self.lstProfiles.Items.Clear()<br />
for prf in profilesAndValues:<br />
lvItem = ListViewItem(prf[0])<br />
lvItem.SubItems.Add(str(prf[1]))<br />
self.lstProfiles.Items.Add(lvItem)<br />
<br />
#handle Ok button click<br />
def clickOk(self, sender, args):<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
#handle Cancel button click <br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
<br />
#add profile called from the context menu <br />
def addProfile(self, sender, args):<br />
global profilesAndValues<br />
dlg = ProfileValueDialog("",0)<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues.append([dlg.profile,dlg.value])<br />
self.refreshList()<br />
<br />
#remove profile called from the context menu <br />
def removeProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
profilesAndValues.pop(self.lstProfiles.SelectedIndices[0])<br />
self.refreshList()<br />
<br />
#edit profile called from the context menu <br />
def editProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
index = self.lstProfiles.SelectedIndices[0]<br />
dlg = ProfileValueDialog(profilesAndValues[index][0],profilesAndValues[index][1])<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues[index] = [dlg.profile,dlg.value]<br />
self.refreshList()<br />
<br />
<br />
#Dialog box for assigning values to profiles <br />
class ProfileValueDialog(Form):<br />
<br />
profile = ""<br />
value = 0<br />
<br />
def __init__(self, profileName, lampValue):<br />
global profilesAndValues<br />
self.Text = 'Profile Value Dialog'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
self.Width = 350<br />
self.Height = 150<br />
<br />
#Label<br />
lblPrompt = Label()<br />
lblPrompt.Text = "Enter profile name and 8 bit value for lamp on."<br />
lblPrompt.Location = Point(margin, margin)<br />
lblPrompt.Width = self.Width<br />
self.Controls.Add(lblPrompt)<br />
<br />
#Text Box<br />
self.txtProfile = TextBox()<br />
self.txtProfile.Location = Point(margin, margin * 4)<br />
self.txtProfile.Text = profileName<br />
self.txtProfile.Width = 200<br />
self.Controls.Add(self.txtProfile)<br />
<br />
#NumericUpDown<br />
self.numValue = NumericUpDown()<br />
self.numValue.Maximum = 255<br />
self.numValue.Value = lampValue<br />
self.numValue.Location = Point(self.txtProfile.Right + margin, self.txtProfile.Top)<br />
self.numValue.Width = (self.Width - margin) - (self.txtProfile.Right + (margin * 3))<br />
self.Controls.Add(self.numValue)<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
def clickOk(self, sender, args):<br />
self.profile = self.txtProfile.Text<br />
self.value = self.numValue.Value<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:35:37Z<p>Chris Monson: /* Lamps On */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
#called when the addon is selected in the addon's menu<br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
#select all the children for a given group <br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
#select group<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight><br />
<br />
<br />
=Lamps On=<br />
This addon allows you to specify a list of profile names and the value that the lamp channel must be assigned to in order to strike the lamp for that particular fixture. This addon runs automatically on startup asking if you'd like to turn the lamps on.<br />
<br />
This example is a little more complicated, utilizing file operations for saving and loading settings, asynchronous processing, as well as using Windows Forms for dialog boxes to adjust the addon's settings in Lightforge.<br />
<br />
<syntaxhighlight lang=python><br />
import clr<br />
clr.AddReference("System.Drawing")<br />
clr.AddReference("System.Windows.Forms")<br />
from System.Drawing import Point<br />
from System.Windows.Forms import Application, Button, ListView, ListViewItem, View, Form, ContextMenu, TextBox, NumericUpDown, Label<br />
from System.Windows.Forms import MessageBox, MessageBoxButtons<br />
from System.Windows.Forms import FormBorderStyle, DialogResult<br />
<br />
profilesAndValues = []<br />
<br />
#called when the script is loaded<br />
def onInitialize():<br />
load()<br />
<br />
#called when the script settings are edited in the script settings dialog<br />
def onEdit():<br />
dlg = LampOnDialog()<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
save()<br />
<br />
#executes asyncronously when clicked from the Lightforge interface <br />
def onExecuteAsync():<br />
onStartupAsync()<br />
<br />
#called as Lightforge is starting up<br />
def onStartupAsync():<br />
global profilesAndValues<br />
if MessageBox.Show("Would you like to turn lamps on?", "Lamp Startup", MessageBoxButtons.YesNo) == DialogResult.Yes:<br />
print("")<br />
print("Turning Lamps On")<br />
<br />
#find profiles that match those in our profilesAndValues list and set values appropriately<br />
findProfiles("", profilesAndValues)<br />
<br />
#wait 5 seconds to allow the fixtures to process the command<br />
print("Waiting...")<br />
api.wait(5)<br />
<br />
#release the rig to remove the changes we made<br />
print("Releasing Fixtures")<br />
api.groups.releaseGroup("")<br />
<br />
<br />
#Search through rig to find the specified profiles and assign them the given values<br />
def findProfiles(groupPath, profileList):<br />
currentPath = groupPath<br />
<br />
#step through all children of the current group<br />
for i in range(0, api.groups.getChildCount(currentPath)):<br />
#build the group path for the next group<br />
if len(currentPath) == 0:<br />
currentPath = str(i)<br />
else:<br />
currentPath = groupPath + "," + str(i) <br />
<br />
found = False<br />
<br />
#step through all the profiles we've listed to see if this fixture's profile matches any of them<br />
for prf in profileList: <br />
if prf[0] in api.groups.getProfileName(currentPath):<br />
#set the value of this fixture to the value in the profile list<br />
api.groups.setAttribute(api.attributeTypes.lamp, int(prf[1]) * 256, currentPath)<br />
found = True<br />
<br />
#call this function on the tested group to work recursively through the groups<br />
if found == False and api.groups.getChildCount(currentPath) > 0:<br />
findProfiles(currentPath, profileList)<br />
<br />
#Save settings to file<br />
def save():<br />
global profilesAndValues<br />
strOutput = ""<br />
for prf in profilesAndValues:<br />
strOutput += prf[0] + ";" + str(prf[1]) + "\n"<br />
<br />
f = open(addon.getDirectory() + "Lamps On.settings", "w+")<br />
f.write(strOutput)<br />
f.close()<br />
<br />
#Load settings in from file <br />
def load():<br />
global profilesAndValues<br />
profilesAndValues = []<br />
try:<br />
f = open(addon.getDirectory() + "Lamps On.settings", "r+")<br />
for line in f:<br />
profilesAndValues.append(line.rstrip().split(';'))<br />
f.close()<br />
except: <br />
pass<br />
<br />
#Dialog box for assigning values to profiles <br />
class LampOnDialog(Form):<br />
<br />
def __init__(self):<br />
global profilesAndValues<br />
self.Text = 'Lamp On Settings'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
#List Box<br />
self.lstProfiles = ListView()<br />
self.lstProfiles.Location = Point(margin, margin)<br />
self.lstProfiles.Width = self.ClientRectangle.Width - (margin * 2)<br />
self.lstProfiles.Height = btnOk.Top - (margin * 2)<br />
self.Controls.Add(self.lstProfiles)<br />
self.lstProfiles.View = View.Details<br />
self.lstProfiles.Columns.Add("Profile")<br />
self.lstProfiles.Columns.Add("Value") <br />
self.lstProfiles.Columns[0].Width = self.lstProfiles.Width * 0.7<br />
self.refreshList()<br />
<br />
#Context Menu<br />
listContext = ContextMenu()<br />
listContext.MenuItems.Add("Add Profile")<br />
listContext.MenuItems[0].Click += self.addProfile<br />
listContext.MenuItems.Add("Edit")<br />
listContext.MenuItems[1].Click += self.editProfile<br />
listContext.MenuItems.Add("Remove")<br />
listContext.MenuItems[2].Click += self.removeProfile<br />
self.lstProfiles.ContextMenu = listContext<br />
<br />
#reload the profilesAndValues data into the ListView control<br />
def refreshList(self):<br />
global profilesAndValues<br />
self.lstProfiles.Items.Clear()<br />
for prf in profilesAndValues:<br />
lvItem = ListViewItem(prf[0])<br />
lvItem.SubItems.Add(str(prf[1]))<br />
self.lstProfiles.Items.Add(lvItem)<br />
<br />
#handle Ok button click<br />
def clickOk(self, sender, args):<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
#handle Cancel button click <br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
<br />
#add profile called from the context menu <br />
def addProfile(self, sender, args):<br />
global profilesAndValues<br />
dlg = ProfileValueDialog("",0)<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues.append([dlg.profile,dlg.value])<br />
self.refreshList()<br />
<br />
#remove profile called from the context menu <br />
def removeProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
profilesAndValues.pop(self.lstProfiles.SelectedIndices[0])<br />
self.refreshList()<br />
<br />
#edit profile called from the context menu <br />
def editProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
index = self.lstProfiles.SelectedIndices[0]<br />
dlg = ProfileValueDialog(profilesAndValues[index][0],profilesAndValues[index][1])<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues[index] = [dlg.profile,dlg.value]<br />
self.refreshList()<br />
<br />
<br />
#Dialog box for assigning values to profiles <br />
class ProfileValueDialog(Form):<br />
<br />
profile = ""<br />
value = 0<br />
<br />
def __init__(self, profileName, lampValue):<br />
global profilesAndValues<br />
self.Text = 'Profile Value Dialog'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
self.Width = 350<br />
self.Height = 150<br />
<br />
#Label<br />
lblPrompt = Label()<br />
lblPrompt.Text = "Enter profile name and 8 bit value for lamp on."<br />
lblPrompt.Location = Point(margin, margin)<br />
lblPrompt.Width = self.Width<br />
self.Controls.Add(lblPrompt)<br />
<br />
#Text Box<br />
self.txtProfile = TextBox()<br />
self.txtProfile.Location = Point(margin, margin * 4)<br />
self.txtProfile.Text = profileName<br />
self.txtProfile.Width = 200<br />
self.Controls.Add(self.txtProfile)<br />
<br />
#NumericUpDown<br />
self.numValue = NumericUpDown()<br />
self.numValue.Maximum = 255<br />
self.numValue.Value = lampValue<br />
self.numValue.Location = Point(self.txtProfile.Right + margin, self.txtProfile.Top)<br />
self.numValue.Width = (self.Width - margin) - (self.txtProfile.Right + (margin * 3))<br />
self.Controls.Add(self.numValue)<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
def clickOk(self, sender, args):<br />
self.profile = self.txtProfile.Text<br />
self.value = self.numValue.Value<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:29:26Z<p>Chris Monson: /* Select Children */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
#called when the addon is selected in the addon's menu<br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
#select all the children for a given group <br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
#select group<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight><br />
<br />
<br />
=Lamps On=<br />
<syntaxhighlight lang=python><br />
import clr<br />
clr.AddReference("System.Drawing")<br />
clr.AddReference("System.Windows.Forms")<br />
from System.Drawing import Point<br />
from System.Windows.Forms import Application, Button, ListView, ListViewItem, View, Form, ContextMenu, TextBox, NumericUpDown, Label<br />
from System.Windows.Forms import MessageBox, MessageBoxButtons<br />
from System.Windows.Forms import FormBorderStyle, DialogResult<br />
<br />
profilesAndValues = []<br />
<br />
#called when the script is loaded<br />
def onInitialize():<br />
load()<br />
<br />
#called when the script settings are edited in the script settings dialog<br />
def onEdit():<br />
dlg = LampOnDialog()<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
save()<br />
<br />
#executes asyncronously when clicked from the Lightforge interface <br />
def onExecuteAsync():<br />
onStartupAsync()<br />
<br />
#called as Lightforge is starting up<br />
def onStartupAsync():<br />
global profilesAndValues<br />
if MessageBox.Show("Would you like to turn lamps on?", "Lamp Startup", MessageBoxButtons.YesNo) == DialogResult.Yes:<br />
print("")<br />
print("Turning Lamps On")<br />
<br />
#find profiles that match those in our profilesAndValues list and set values appropriately<br />
findProfiles("", profilesAndValues)<br />
<br />
#wait 5 seconds to allow the fixtures to process the command<br />
print("Waiting...")<br />
api.wait(5)<br />
<br />
#release the rig to remove the changes we made<br />
print("Releasing Fixtures")<br />
api.groups.releaseGroup("")<br />
<br />
<br />
#Search through rig to find the specified profiles and assign them the given values<br />
def findProfiles(groupPath, profileList):<br />
currentPath = groupPath<br />
<br />
#step through all children of the current group<br />
for i in range(0, api.groups.getChildCount(currentPath)):<br />
#build the group path for the next group<br />
if len(currentPath) == 0:<br />
currentPath = str(i)<br />
else:<br />
currentPath = groupPath + "," + str(i) <br />
<br />
found = False<br />
<br />
#step through all the profiles we've listed to see if this fixture's profile matches any of them<br />
for prf in profileList: <br />
if prf[0] in api.groups.getProfileName(currentPath):<br />
#set the value of this fixture to the value in the profile list<br />
api.groups.setAttribute(api.attributeTypes.lamp, int(prf[1]) * 256, currentPath)<br />
found = True<br />
<br />
#call this function on the tested group to work recursively through the groups<br />
if found == False and api.groups.getChildCount(currentPath) > 0:<br />
findProfiles(currentPath, profileList)<br />
<br />
#Save settings to file<br />
def save():<br />
global profilesAndValues<br />
strOutput = ""<br />
for prf in profilesAndValues:<br />
strOutput += prf[0] + ";" + str(prf[1]) + "\n"<br />
<br />
f = open(addon.getDirectory() + "Lamps On.settings", "w+")<br />
f.write(strOutput)<br />
f.close()<br />
<br />
#Load settings in from file <br />
def load():<br />
global profilesAndValues<br />
profilesAndValues = []<br />
try:<br />
f = open(addon.getDirectory() + "Lamps On.settings", "r+")<br />
for line in f:<br />
profilesAndValues.append(line.rstrip().split(';'))<br />
f.close()<br />
except: <br />
pass<br />
<br />
#Dialog box for assigning values to profiles <br />
class LampOnDialog(Form):<br />
<br />
def __init__(self):<br />
global profilesAndValues<br />
self.Text = 'Lamp On Settings'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
#List Box<br />
self.lstProfiles = ListView()<br />
self.lstProfiles.Location = Point(margin, margin)<br />
self.lstProfiles.Width = self.ClientRectangle.Width - (margin * 2)<br />
self.lstProfiles.Height = btnOk.Top - (margin * 2)<br />
self.Controls.Add(self.lstProfiles)<br />
self.lstProfiles.View = View.Details<br />
self.lstProfiles.Columns.Add("Profile")<br />
self.lstProfiles.Columns.Add("Value") <br />
self.lstProfiles.Columns[0].Width = self.lstProfiles.Width * 0.7<br />
self.refreshList()<br />
<br />
#Context Menu<br />
listContext = ContextMenu()<br />
listContext.MenuItems.Add("Add Profile")<br />
listContext.MenuItems[0].Click += self.addProfile<br />
listContext.MenuItems.Add("Edit")<br />
listContext.MenuItems[1].Click += self.editProfile<br />
listContext.MenuItems.Add("Remove")<br />
listContext.MenuItems[2].Click += self.removeProfile<br />
self.lstProfiles.ContextMenu = listContext<br />
<br />
#reload the profilesAndValues data into the ListView control<br />
def refreshList(self):<br />
global profilesAndValues<br />
self.lstProfiles.Items.Clear()<br />
for prf in profilesAndValues:<br />
lvItem = ListViewItem(prf[0])<br />
lvItem.SubItems.Add(str(prf[1]))<br />
self.lstProfiles.Items.Add(lvItem)<br />
<br />
#handle Ok button click<br />
def clickOk(self, sender, args):<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
#handle Cancel button click <br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
<br />
#add profile called from the context menu <br />
def addProfile(self, sender, args):<br />
global profilesAndValues<br />
dlg = ProfileValueDialog("",0)<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues.append([dlg.profile,dlg.value])<br />
self.refreshList()<br />
<br />
#remove profile called from the context menu <br />
def removeProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
profilesAndValues.pop(self.lstProfiles.SelectedIndices[0])<br />
self.refreshList()<br />
<br />
#edit profile called from the context menu <br />
def editProfile(self, sender, args):<br />
global profilesAndValues<br />
if self.lstProfiles.SelectedIndices.Count > 0:<br />
index = self.lstProfiles.SelectedIndices[0]<br />
dlg = ProfileValueDialog(profilesAndValues[index][0],profilesAndValues[index][1])<br />
if dlg.ShowDialog() == DialogResult.OK:<br />
profilesAndValues[index] = [dlg.profile,dlg.value]<br />
self.refreshList()<br />
<br />
<br />
#Dialog box for assigning values to profiles <br />
class ProfileValueDialog(Form):<br />
<br />
profile = ""<br />
value = 0<br />
<br />
def __init__(self, profileName, lampValue):<br />
global profilesAndValues<br />
self.Text = 'Profile Value Dialog'<br />
self.FormBorderStyle = FormBorderStyle.FixedDialog<br />
self.MinimizeBox = False<br />
self.MaximizeBox = False<br />
<br />
margin = 10<br />
<br />
self.Width = 350<br />
self.Height = 150<br />
<br />
#Label<br />
lblPrompt = Label()<br />
lblPrompt.Text = "Enter profile name and 8 bit value for lamp on."<br />
lblPrompt.Location = Point(margin, margin)<br />
lblPrompt.Width = self.Width<br />
self.Controls.Add(lblPrompt)<br />
<br />
#Text Box<br />
self.txtProfile = TextBox()<br />
self.txtProfile.Location = Point(margin, margin * 4)<br />
self.txtProfile.Text = profileName<br />
self.txtProfile.Width = 200<br />
self.Controls.Add(self.txtProfile)<br />
<br />
#NumericUpDown<br />
self.numValue = NumericUpDown()<br />
self.numValue.Maximum = 255<br />
self.numValue.Value = lampValue<br />
self.numValue.Location = Point(self.txtProfile.Right + margin, self.txtProfile.Top)<br />
self.numValue.Width = (self.Width - margin) - (self.txtProfile.Right + (margin * 3))<br />
self.Controls.Add(self.numValue)<br />
<br />
#Cancel Button<br />
btnCancel = Button()<br />
btnCancel.Text = "Cancel"<br />
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))<br />
btnCancel.Click += self.clickCancel<br />
self.Controls.Add(btnCancel)<br />
<br />
#Ok Button<br />
btnOk = Button()<br />
btnOk.Text = "Ok"<br />
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))<br />
btnOk.Click += self.clickOk<br />
self.Controls.Add(btnOk)<br />
<br />
def clickOk(self, sender, args):<br />
self.profile = self.txtProfile.Text<br />
self.value = self.numValue.Value<br />
self.DialogResult = DialogResult.OK<br />
self.Close<br />
<br />
def clickCancel(self, sender, args):<br />
self.DialogResult = DialogResult.Cancel<br />
self.Close<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:26:23Z<p>Chris Monson: /* Select Children */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
#called when the addon is selected in the addon's menu<br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
#select all the children for a given group <br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
#select group<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:26:01Z<p>Chris Monson: /* Select Children */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
#called when the addon is selected in the addon's menu<br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
#select all the children for a given group <br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:25:11Z<p>Chris Monson: /* Select Children */</p>
<hr />
<div>=Select Children=<br />
<br />
This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:24:00Z<p>Chris Monson: /* Select Children */</p>
<hr />
<div>=Select Children=<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
<br />
api.groups.selectGroup(newPath)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Sample_AddonsSample Addons2013-05-09T23:22:47Z<p>Chris Monson: Created page with "=Select Children= <highlightsyntax lang=python> def onExecute(): #get list of selected groups groupList = api.groups.getSelectedGroups() if groupList != None: for group ..."</p>
<hr />
<div>=Select Children=<br />
<highlightsyntax lang=python><br />
def onExecute():<br />
#get list of selected groups<br />
groupList = api.groups.getSelectedGroups()<br />
<br />
if groupList != None:<br />
for group in groupList:<br />
selectChildren(group)<br />
<br />
def selectChildren(groupPath):<br />
childCount = api.groups.getChildCount(groupPath)<br />
<br />
if childCount > 0:<br />
api.groups.deselectGroup(groupPath)<br />
<br />
for i in range(0, childCount):<br />
#build the group path for the next group<br />
newPath = groupPath<br />
if len(newPath) == 0:<br />
newPath = str(i)<br />
else:<br />
newPath = newPath + "," + str(i) <br />
<br />
api.groups.selectGroup(newPath)<br />
</highlightsyntax></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T23:00:25Z<p>Chris Monson: /* Where To Go From Here */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
==Where To Go From Here==<br />
I would suggest investigating the [[API]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T23:00:12Z<p>Chris Monson: /* Introduction */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
==Where To Go From Here==<br />
I would suggest investigating the [[api]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:57:22Z<p>Chris Monson: /* Your First Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
<br />
Congratulations! You've made an addon!<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:57:12Z<p>Chris Monson: /* Your First Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
Congratulations! You've made an addon!<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-09T22:54:25Z<p>Chris Monson: /* Events */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onInitialize():<br />
print("Script Loaded")<br />
</syntaxhighlight><br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecute():<br />
print("Script Executed")<br />
</syntaxhighlight><br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
</syntaxhighlight><br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartup():<br />
print("Lightforge Started")<br />
</syntaxhighlight><br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStart():<br />
print("Playback Started")<br />
</syntaxhighlight><br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
</syntaxhighlight><br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
</syntaxhighlight><br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python> <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
</syntaxhighlight><br />
<br />
==onCuelistChanged==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onCuelistChanged():<br />
print("Cue List Changed")<br />
</syntaxhighlight><br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onShowLoaded():<br />
print("Show Loaded")<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-09T22:51:36Z<p>Chris Monson: /* onEdit */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
def onInitialize():<br />
print("Script Loaded")<br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
def onEdit():<br />
print("Settings Edit")<br />
</syntaxhighlight><br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
def onExecute():<br />
print("Script Executed")<br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
def onStartup():<br />
print("Lightforge Started")<br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
def onPlaybackStart():<br />
print("Playback Started")<br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage: <br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage: <br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage: <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
<br />
==onCuelistChanged==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
def onCuelistChanged():<br />
print("Cue List Changed")<br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
def onShowLoaded():<br />
print("Show Loaded")</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-09T22:50:50Z<p>Chris Monson: /* Functions */</p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.getTime())<br />
</syntaxhighlight><br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.setTime(36.5)<br />
print(api.getTime())<br />
</syntaxhighlight><br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.wait(3.5)<br />
</syntaxhighlight><br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
def onInitialize():<br />
print("Script Loaded")<br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
def onEdit():<br />
print("Settings Edit")<br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
def onExecute():<br />
print("Script Executed")<br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
def onStartup():<br />
print("Lightforge Started")<br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
def onPlaybackStart():<br />
print("Playback Started")<br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage: <br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage: <br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage: <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
<br />
==onCuelistChanged==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
def onCuelistChanged():<br />
print("Cue List Changed")<br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
def onShowLoaded():<br />
print("Show Loaded")</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Api.outputApi.output2013-05-09T22:33:52Z<p>Chris Monson: </p>
<hr />
<div>==getDMX==<br />
'''getDMX(universe As Integer) As Byte()'''<br />
<br />
Returns a byte array containing all current dmx data for the specified universe. If the specified universe doesn't exist this function returns null.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
dmxValues = api.output.getDMX(0)<br />
print(dmxValues[42])<br />
</syntaxhighlight><br />
<br />
==getUniverseCount==<br />
'''getUniverseCount() as Integer'''<br />
<br />
Returns the number of DMX universes in the current show.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
universeCount = api.output.getUniverseCount()<br />
print(universeCount)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Api.groupsApi.groups2013-05-09T22:32:45Z<p>Chris Monson: /* Methods */</p>
<hr />
<div><br />
=Information=<br />
<br />
==Group Paths==<br />
A group path is a method for specifying a group in the group hierarchy. It is defined by use of a string. <br />
<br />
An empty string ("") will specify the main group. <br />
<br />
To specify a child of the main group you use that child's index number ex. "1"<br />
<br />
Note: the indexes are 0 based so fixture 1 in a group is 0, fixture 2 is 1, etc. <br />
<br />
To specify a child of a child, you use a comma, and the index of the next child you want to select ex. "1,3"<br />
<br />
You can continue in this fashion throughout the group hierarchy. If you are looking at something nested deeply it may look like "1,3,0,2,4".<br />
<br />
=Methods=<br />
<br />
==getAttribute==<br />
<br />
'''getAttribute(attribute As [[api.attributeTypes]], groupPath As String) As Integer'''<br />
<br />
Returns the value for a specified attribute on a specified group<br />
Returns -1 if the group can't be found<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.groups.getAttribute(api.attributeTypes.intensity, "0,0"))<br />
</syntaxhighlight><br />
<br />
==getChildCount==<br />
'''getChildCount(groupPath As String) As Integer'''<br />
<br />
Returns the number of children in a group<br />
Returns -1 if the group can't be found<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.groups.getChildCount("0,0"))<br />
</syntaxhighlight><br />
<br />
==getName==<br />
'''getName(groupPath As String) As String'''<br />
<br />
Returns the name of the requested group<br />
Returns -1 if the group can't be found<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.groups.getName("1,1"))<br />
</syntaxhighlight><br />
<br />
==getProfileName==<br />
'''getProfileName(groupPath As String) As String'''<br />
<br />
Returns the name of the profile in use by the specified group. If this group is not a fixture and does not have a profile this function will return -1.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
print(api.groups.getProfileName("1,0,3"))<br />
</syntaxhighlight><br />
<br />
==getSelectedGroups==<br />
'''getSelectedGroups() As String[]'''<br />
<br />
Returns a list of group paths for all selected groups. If there are no groups selected then null is returned.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
groupList = api.groups.getSelectedGroups()<br />
for group in groupList:<br />
print(group)<br />
</syntaxhighlight><br />
<br />
==releaseAttribute==<br />
'''releaseAttribute(attribute As [[api.attributeTypes]], groupPath As String)'''<br />
<br />
Releases the specified attribute on the specified group.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.releaseAttribute(api.attributeTypes.intensity, "0,1")<br />
</syntaxhighlight><br />
<br />
==releaseGroup==<br />
'''releaseGroup(groupPath As String)'''<br />
<br />
Releases the all attributes on the specified group.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.releaseGroup("1,0")<br />
</syntaxhighlight><br />
<br />
==setAttribute==<br />
'''setAttribute(attribute As [[api.attributeTypes]], value As Integer, groupPath As String)'''<br />
<br />
Sets the value of an attribute on a specified group.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.setAttribute(api.attributeTypes.intensity, 65535, "1,1")<br />
</syntaxhighlight><br />
<br />
==selectGroup==<br />
'''selectGroup(groupPath As String)'''<br />
<br />
Sets the given group as selected.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.selectGroup("0,1,1,2")<br />
</syntaxhighlight><br />
<br />
==deselectGroup==<br />
'''deselectGroup(groupPath As String)'''<br />
<br />
Deselects the given group.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.deselectGroup("0,1,1,2")<br />
</syntaxhighlight><br />
<br />
==clearSelection==<br />
'''clearSelection()'''<br />
<br />
Deselects all selected groups.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.groups.clearSelection()<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonAddon2013-05-09T22:28:23Z<p>Chris Monson: /* getDirectory() */</p>
<hr />
<div>=Methods=<br />
<br />
==getDirectory()==<br />
'''getDirectory() As String'''<br />
<br />
This function returns the path of the current addon's folder.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
path = addon.getDirectory()<br />
print(path)<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:27:03Z<p>Chris Monson: /* Introduction */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Api.cuesApi.cues2013-05-09T22:25:42Z<p>Chris Monson: </p>
<hr />
<div>=Methods=<br />
<br />
==getCuelistCount==<br />
'''getCuelistCount() As Integer'''<br />
<br />
Returns the number of cuelists in this show.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
cuelistCount = api.cues.getCuelistCount()<br />
print(cuelistCount)<br />
</syntaxhighlight><br />
<br />
==getCuelistLength==<br />
'''getCuelistLength() As Double'''<br />
<br />
Returns the length of the current cuelist in seconds or beats<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
cuelistLength = api.cues.getCuelistLength()<br />
print(cuelistLength)<br />
</syntaxhighlight><br />
<br />
==getCuelistIndex==<br />
'''getCuelistIndex() As Integer'''<br />
<br />
Returns the index of the current cuelist.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
index = api.cues.getCuelistIndex()<br />
print(index)<br />
</syntaxhighlight><br />
<br />
==selectCuelist==<br />
'''selectCuelist(index As Integer)'''<br />
<br />
Changes to a different cuelist.<br />
<br />
Usage:<br />
<syntaxhighlight lang=python><br />
api.cues.selectCuelist(2)<br />
print(api.cues.getCuelistIndex())<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=Api.attributeTypesApi.attributeTypes2013-05-09T22:23:21Z<p>Chris Monson: </p>
<hr />
<div><syntaxhighlight lang=vbnet><br />
Enum AttributeTypes<br />
intensity<br />
pan<br />
tilt<br />
colorRed<br />
colorGreen<br />
colorBlue<br />
colorWheel_Secondary<br />
strobe<br />
gobo<br />
gobo_Rotate<br />
gobo_Secondary<br />
prism<br />
prism_Rotate<br />
focus<br />
beam<br />
zoom<br />
iris<br />
frost<br />
shutter<br />
pan_Tilt_Speed<br />
lamp<br />
macro<br />
control<br />
</syntaxhighlight></div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:20:30Z<p>Chris Monson: /* XML Structure */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:20:18Z<p>Chris Monson: /* XML Structure */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<syntaxhighlight lang="python"><br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
</syntaxhighlight lang="xml"><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:19:19Z<p>Chris Monson: /* Structure */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
=Addon Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T22:19:00Z<p>Chris Monson: /* Your First Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"<br />
<br />
=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=MediaWiki:Geshi.cssMediaWiki:Geshi.css2013-05-09T22:16:27Z<p>Chris Monson: </p>
<hr />
<div>/* CSS placed here will be applied to GeSHi syntax highlighting */<br />
div.mw-geshi {<br />
padding: 1em; <br />
margin: 1em 0; <br />
border: 1px dashed #2f6fab;<br />
background-color: #f9f9f9;<br />
font-size: 120%;<br />
}</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=MediaWiki:Geshi.cssMediaWiki:Geshi.css2013-05-09T22:16:07Z<p>Chris Monson: </p>
<hr />
<div>/* CSS placed here will be applied to GeSHi syntax highlighting */<br />
div.mw-geshi {<br />
padding: 1em; <br />
margin: 1em 0; <br />
border: 1px dashed #2f6fab;<br />
background-color: #f9f9f9;<br />
font-size: 100%;<br />
}</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=MediaWiki:Geshi.cssMediaWiki:Geshi.css2013-05-09T22:15:12Z<p>Chris Monson: </p>
<hr />
<div>/* CSS placed here will be applied to GeSHi syntax highlighting */<br />
div.mw-geshi {<br />
padding: 1em; <br />
margin: 1em 0; <br />
border: 1px dashed #2f6fab;<br />
background-color: #f9f9f9;<br />
}</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=MediaWiki:Geshi.cssMediaWiki:Geshi.css2013-05-09T21:51:40Z<p>Chris Monson: Created page with "/* CSS placed here will be applied to GeSHi syntax highlighting */ div.mw-geshi { padding: 1em; margin: 1em 0; border: 1px dashed #2f6fab; background-color: #f9f9f9;..."</p>
<hr />
<div>/* CSS placed here will be applied to GeSHi syntax highlighting */<br />
div.mw-geshi {<br />
padding: 1em; <br />
margin: 1em 0; <br />
border: 1px dashed #2f6fab;<br />
background-color: #f9f9f9;<br />
font-size:150%;<br />
}</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T21:43:30Z<p>Chris Monson: /* Your First Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now In the window<br />
<br />
=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T21:41:59Z<p>Chris Monson: /* Your First Addon */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
<syntaxhighlight lang="python"><br />
def onExecute():<br />
print("Hello World!")<br />
</syntaxhighlight><br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now In the window<br />
<br />
=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T21:17:46Z<p>Chris Monson: /* Introduction */</p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/].<br />
<br />
==Your First Addon==<br />
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.<br />
<br />
In this folder create a new folder named "Hello World". <br />
<br />
Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.<br />
<br />
Type the code:<br />
<br />
onExecute():<br />
print("Hello World!")<br />
<br />
Save the script, and return to Lightforge.<br />
<br />
In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.<br />
<br />
Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.<br />
<br />
In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.<br />
<br />
Now In the window<br />
<br />
=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T20:55:47Z<p>Chris Monson: </p>
<hr />
<div>=Introduction=<br />
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.<br />
<br />
Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]<br />
<br />
<br />
=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=APIAPI2013-05-09T20:35:05Z<p>Chris Monson: </p>
<hr />
<div>=Types=<br />
<br />
==api.attributeTypes==<br />
[[api.attributeTypes]]<br />
<br />
<br />
=Classes=<br />
<br />
==api.cues==<br />
Used for working with cues.<br />
<br />
[[api.cues]]<br />
<br />
==api.groups==<br />
Used for working with groups.<br />
<br />
[[api.groups]]<br />
<br />
==api.output==<br />
Used for getting information about DMX output.<br />
<br />
[[api.output]]<br />
<br />
=Functions=<br />
<br />
==getTime==<br />
'''getTime() As Double'''<br />
<br />
Gets the current playback position.<br />
<br />
Usage:<br />
print(api.getTime())<br />
<br />
==setTime==<br />
'''setTime(time As Double)'''<br />
<br />
Sets the current playback position to the specified time.<br />
<br />
Usage:<br />
api.setTime(36.5)<br />
print(api.getTime())<br />
<br />
==wait==<br />
'''wait(seconds As Double)'''<br />
<br />
Causes execution to wait for the specified number of seconds.<br />
<br />
Usage:<br />
api.wait(3.5)<br />
<br />
=Events=<br />
<br />
==onInitialize==<br />
Called when the script is loaded.<br />
<br />
Usage:<br />
def onInitialize():<br />
print("Script Loaded")<br />
<br />
==onEdit==<br />
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.<br />
<br />
Usage:<br />
def onEdit():<br />
print("Settings Edit")<br />
<br />
==onExecute==<br />
Called when this script is specifically executed.<br />
<br />
Usage:<br />
def onExecute():<br />
print("Script Executed")<br />
<br />
==onExecuteAsync==<br />
Called when this script is specifically executed. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onExecuteAsync():<br />
print("Script Executed Asynchronously")<br />
<br />
==onStartup==<br />
Called when Lightforge starts up.<br />
<br />
Usage:<br />
def onStartup():<br />
print("Lightforge Started")<br />
<br />
==onStartupAsync==<br />
Called when Lightforge starts up. Code run from this function is executed asynchronously.<br />
<br />
Usage:<br />
def onStartupAsync():<br />
print("Lightforge Started (Async)")<br />
<br />
==onPlaybackStart==<br />
Called when timeline playback has started.<br />
<br />
Usage:<br />
def onPlaybackStart():<br />
print("Playback Started")<br />
<br />
==onPlaybackStop==<br />
Called when timeline playback has stopped<br />
<br />
Usage: <br />
def onPlaybackStop():<br />
print("Playback Stopped")<br />
<br />
==onFrameChange==<br />
Called on every frame change during playback, scrubbing, and time changes.<br />
<br />
Usage: <br />
def onFrameChange(seconds As Double):<br />
print("Frame Changed " + seconds)<br />
<br />
==onShutdown==<br />
Called when Lightforge is shutting down.<br />
<br />
Usage: <br />
def onShutdown():<br />
print("Lightforge Shutdown")<br />
<br />
==onCuelistChanged==<br />
Called when the current cuelist has been changed.<br />
<br />
Usage:<br />
def onCuelistChanged():<br />
print("Cue List Changed")<br />
<br />
==onShowLoaded==<br />
Called when a new show has been loaded.<br />
<br />
Usage:<br />
def onShowLoaded():<br />
print("Show Loaded")</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonAddon2013-05-09T20:34:17Z<p>Chris Monson: Created page with "=Methods= ==getDirectory()== '''getDirectory() As String''' This function returns the path of the current addon's folder. Usage: path = addon.getDirectory() print(path)"</p>
<hr />
<div>=Methods=<br />
<br />
==getDirectory()==<br />
'''getDirectory() As String'''<br />
<br />
This function returns the path of the current addon's folder.<br />
<br />
Usage:<br />
path = addon.getDirectory()<br />
print(path)</div>Chris Monsonhttp://www.visualsorcery.com/LightForgeWiki/index.php?title=AddonsAddons2013-05-09T20:31:27Z<p>Chris Monson: /* XML Structure */</p>
<hr />
<div>=Structure=<br />
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.<br />
<br />
==base.py==<br />
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.<br />
<br />
==addonInfo.xml==<br />
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.<br />
<br />
The addonInfo.xml file can contain the following information:<br />
<br />
===Author===<br />
The author of the addon.<br />
===Version===<br />
The current version number.<br />
===Website===<br />
A website associated with this addon.<br />
===Support===<br />
An email address or website for providing addon support.<br />
<br />
===XML Structure===<br />
<br />
<addonInfo><br />
<author>Visual Sorcery</author><br />
<version>1.0.0</version><br />
<website>http://www.visualsorcery.com/</website><br />
<support>support@visualsorcery.com</support><br />
</addonInfo><br />
<br />
=Classes=<br />
==API==<br />
This class contains all access for working with Lightforge.<br />
[[API]]<br />
==Addon==<br />
This class gives you access to information about your addon.<br />
[[Addon]]</div>Chris Monson