File ./LibScriptablePlugins-1.0/LibScriptablePluginRecount-1.0/LibScriptablePluginRecount-1.0.lua

Functions

PluginRecount:New (environment) Populate an environment with this plugin's fields
RecountGetTotal () Return the current window's total
RecountUnitData (unit) Return Recount data for a given unit
RecountUnitMaxValue () Return the maximum value for the currently active Recount window.
RecountUnitPerSecond (unit) Return per second information for a unit.
RecountUnitPercent (unit) Return value/total.
RecountUnitValue (unit) Return the raw Recount value for a given unit.


Functions

PluginRecount:New (environment)
Populate an environment with this plugin's fields

Parameters

  • environment: This will be the environment when setfenv is called.

Usage:

:New(environment)

Return value:

A new plugin object, aka the environment
RecountGetTotal ()
Return the current window's total

Usage:

RecountGetTotal()

Return value:

Recount total for the currently active window.
RecountUnitData (unit)
Return Recount data for a given unit

Parameters

  • unit: A valid unit id

Usage:

RecountUnitData(unit)

Return value:

value, percent, persecond, maxValue, total
RecountUnitMaxValue ()
Return the maximum value for the currently active Recount window.

Usage:

RecountUnitMaxValue(unit)

Return value:

Recount max value
RecountUnitPerSecond (unit)
Return per second information for a unit. The currently active Recount window is used.

Parameters

  • unit: A valid unit id

Usage:

RecountUnitPerSecond(unit)

Return value:

Recount information for a given unit.
RecountUnitPercent (unit)
Return value/total. The currently active Recount window is used.

Parameters

  • unit: A valid unit id

Usage:

RecountUnitPercent(unit)

Return value:

Recount information for a given unit.
RecountUnitValue (unit)
Return the raw Recount value for a given unit. The currently active Recount window is used.

Parameters

  • unit: A valid unit id

Usage:

RecountUnitValue(unit)

Return value:

Recount information for a given unit

Valid XHTML 1.0!