The settings object¶

Functions¶

createInfo(String ID, String Logo, String Info)¶

Creates info block in the upper part of the page.

ID - String that identifies the info block
Logo - path to logo
Info - Synopsis of the plugin.

createDivider(String Title)¶

Title - Synopsis of the divider.

createInt(String ID, String Title, Int Initial, Int Minimum, Int Maximum, Int Step, String Unit, Function Func)¶

Shows a slider of integers to choose a value.

ID - String that identifies the setting. (e.g. integer)
Title - Synopsis of the setting. (e.g. Integer test)
Initial - Integer that's the default value. (e.g. 20)
Minimum - Integer of the lowest possible value. (e.g. 10)
Maximum - Integer of the highest possible value. (e.g. 50)
Step - Integer that is added to the current value. (e.g. 2)
Unit - String identifying the unit of the value. (e.g. Km/h)
Function - Function that handles the current value saving it (e.g. function(v){service.integer=v})

createString(String ID, String Title, String Initial, Function Func)¶

Shows a text input field.

ID - String that identifies the setting. (e.g. string)
Title - Synopsis of the setting. (e.g. String test)
Initial - Initial value of string
Function - Function that handles the current value saving it (e.g. function(v){somevalue = v})

createBool(String ID, String Title, Bool Initial, Function Func)¶

Shows a bool on/off setting

ID - String that identifies the setting. (e.g. boolean)
Title - Synopsis of the setting. (e.g. Boolean test)
Initial - Initial value of bool
Function - Function that handles the current value saving it (e.g. function(v){somevalue = v})

createMultiOpt(String ID, String Title, Object Values, Function Func)¶

Available from 3.3.328

Shows a multioption element (combobox style)

ID - String that identifies the setting. (e.g. boolean)
Title - Synopsis of the setting. (e.g. Boolean test)
Values - Array list describing each option. For example [['a', 'Alpha'], ['b', 'Beta', true]]. In this example the callback would be called with 'a' if 'Alpha' is selected and 'b' if 'Beta' is selected. The optional third per-item value denotes if the option is default. On ecmascript if there's no selected option as default - the element is disabled.
Function - Function that handles the current value saving it (e.g. function(v){somevalue = v})

createAction(String ID, String Title, Function Func)¶

Available from 3.99.47

Shows an Action Button that executes a given function when clicked.

ID - String that identifies the setting. (e.g. boolean)
Title - Synopsis of the setting. (e.g. Boolean test)
Function - Function that is executed when button is clicked (e.g. function(){ showtime.trace("Button clicked!"); })