Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:StatusBarGetCurrentValue

From RoR Wiki

UI Lua API · StatusBar functions
Version: WAR 1.4.8

Returns the current value of a StatusBar.

value = StatusBarGetCurrentValue(barName)

Arguments

barName
string – Name of a StatusBar window.

Returns

value
number – The value last set with StatusBarSetCurrentValue.

Details

  • This is the stored value. While an interpolating bar is still moving towards it, the fill on screen shows a different value.
  • The value is returned as stored, without limiting it to the range 0 to maximum.
  • The error is the same when the window does not exist and when it is not a StatusBar.

Errors

  • Error in function call 'StatusBarGetCurrentValue': StatusBar %s does not exist.

Example

From ea_battlegrouphud/source/battlegrouphud.lua:

elseif( StatusBarGetCurrentValue(memberWindow.."HPBar") == 0 )

See also