File ../../LibScriptableWidgets-1.0/LibScriptableWidgetTimer-1.0/LibScriptableWidgetTimer-1.0.lua

Functions

WidgetTimer:Del () Delete a LibScriptableWidgetTimer object
WidgetTimer:GetOptions (db, callback, data) Retrieve an Ace3 options table for the given widget
WidgetTimer:New (visitor, name, config, errorLevel, timer, An) Create a new LibScriptableWidgetTimer object
WidgetTimer:Start () Start a LibScriptableWidgetTimer
WidgetTimer:Stop () Stop a LibScriptableWidgetTimer
WidgetTimer:Update () Update data.


Functions

WidgetTimer:Del ()
Delete a LibScriptableWidgetTimer object

Usage:

:Del()

Return value:

Nothing
WidgetTimer:GetOptions (db, callback, data)
Retrieve an Ace3 options table for the given widget

Parameters

  • db:
  • callback:
  • data:

Usage:

:GetOptions(db, callback, data)

Return value:

A new Ace3 options table populated with a widget's data
WidgetTimer:New (visitor, name, config, errorLevel, timer, An)
Create a new LibScriptableWidgetTimer object

Parameters

  • visitor: An LibScriptableCore-1.0 object, or provide your own
  • name: A name for the timer widget
  • config: This timeer's parameters
  • errorLevel: The errorLevel for this object
  • timer:
  • An: optional timer. This should have a :Start() and :Stop().

Usage:

WidgetTimer:New(visitor, name, config, errorLevel)

Return value:

A new LibScriptableWidgetTimer widget
WidgetTimer:Start ()
Start a LibScriptableWidgetTimer

Usage:

:Start()

Return value:

Nothing
WidgetTimer:Stop ()
Stop a LibScriptableWidgetTimer

Usage:

:Stop()

Return value:

Nothing
WidgetTimer:Update ()
Update data. This is called by the timer, or else call it yourself.

Usage:

:Update()

Return value:

Nothing

Valid XHTML 1.0!