Package heronarts.lx.script

Class LXScriptEngine.ScriptInterface

java.lang.Object

heronarts.lx.script.LXScriptEngine.ScriptInterface

Enclosing class:

LXScriptEngine

public class LXScriptEngine.ScriptInterface
extends Object

Interface of methods exposed for Javascript to call back up into the LX device

Constructor Summary

Constructors

Constructor	Description
ScriptInterface()

Method Summary

Modifier and Type	Method	Description
void	include(String fileName)	Include a file
void	knob(String key, String label, String description, double def)	Used by the script to declare a java script knob
void	knobi(String key, String label, String description, int def, int range)	Used by the script to declare a java script knob with discrete values
void	toggle(String key, String label, String description, boolean def)	Used by the script to declare a java script toggle
void	trigger(String key, String label, String description, Runnable callback)	Used by the script to declare a java script trigger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptInterface

public ScriptInterface()

Method Details

include

public void include(String fileName)
             throws IOException,
ScriptException

Include a file

Parameters:

fileName - File name, path relative to parent file

Throws:

IOException

ScriptException

knob

public void knob(String key,
 String label,
 String description,
 double def)

Used by the script to declare a java script knob

Parameters:

key - Variable name/path for the knob

label - Label of knob

description - Helpful description of knob

def - Default value

knobi

public void knobi(String key,
 String label,
 String description,
 int def,
 int range)

Used by the script to declare a java script knob with discrete values

Parameters:

key - Variable name/path for the discrete field

label - Label of field

description - Helpful description of field

def - Default value

range - Range of values [0, range-1]

toggle

public void toggle(String key,
 String label,
 String description,
 boolean def)

Used by the script to declare a java script toggle

Parameters:

key - Variable name/path for the toggle

label - Label of toggle

description - Helpful description of toggle

def - Default value

trigger

public void trigger(String key,
 String label,
 String description,
 Runnable callback)

Used by the script to declare a java script trigger

Parameters:

key - Variable name/path for the trigger

label - Label of trigger

description - Helpful description of trigger

callback - Callback invoked when trigger fires