File ../../LibScriptableWidgets-1.0/LibScriptableWidgetText-1.0/LibScriptableWidgetText-1.0.lua
Functions
LibScriptableWidgetText.Draw (text) | Executes the widget's draw function -- the callback parameter |
WidgetText:Del () | Delete a LibScriptableWidgetText object |
WidgetText:GetOptions (db, callback, data) | Get an Ace3 option table. |
WidgetText:Init (config) | Initialize this widget |
WidgetText:New (visitor, name, config, row, col, layer, errorLevel, callback) | Create a new LibScriptableWidgetText object |
WidgetText:Start (unit) | Start a LibScriptableWidgetText object |
WidgetText:Stop () | Stop a LibScriptableWidgetText object |
WidgetText:Update () | Update data. |
Functions
- LibScriptableWidgetText.Draw (text)
-
Executes the widget's draw function -- the callback parameter
Parameters
- text: The text to print.
Return value:
Nothing - WidgetText:Del ()
-
Delete a LibScriptableWidgetText object
Usage:
:Del()Return value:
Nothing - WidgetText:GetOptions (db, callback, data)
-
Get an Ace3 option table. Plug this into a group type's args.
Parameters
- db: The database table
- callback: Provide this if you want to execute the callback once an option is changed
- data: Some data to pass when executing the callback
Return value:
An Ace3 options table -- `name.args = options`. - WidgetText:Init (config)
-
Initialize this widget
Parameters
- config:
Usage:
:Init()Return value:
Nothing - WidgetText:New (visitor, name, config, row, col, layer, errorLevel, callback)
-
Create a new LibScriptableWidgetText object
Parameters
- visitor: An LibScriptableCore-1.0 object. There's also a visitor pointer in the script environment provided by LibCore, so you can create new widgets at runtime.
- name:
- config: This widget's settings
- row: This widget's row
- col: This widget's column
- layer: This widget's layer
- errorLevel: The self.errorLevel for this object
- callback: Your draw function. The widget is passed as first parameter.
Usage:
WidgetText:New(visitor, name, config, row, col, layer, errorLevel, callback, timer)Return value:
A new LibScriptableWidgetText object - WidgetText:Start (unit)
-
Start a LibScriptableWidgetText object
Parameters
- unit:
Usage:
:Start()Return value:
Nothing - WidgetText:Stop ()
-
Stop a LibScriptableWidgetText object
Usage:
:Stop()Return value:
Nothing - WidgetText:Update ()
-
Update data. This will be called by this widget's timer, or else call it yourself.
Usage:
:Update()Return value:
Nothing