Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:47Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CooldownDisplay}}
Starts the cooldown shown by a CooldownDisplay window.

<pre>
CooldownDisplaySetCooldown(displayName, remaining, total)
</pre>

== Arguments ==
;displayName : <code>string</code> – Name of a CooldownDisplay window.
;remaining : <code>number</code> – Seconds of cooldown left.
;total : <code>number</code> – Full length of the cooldown in seconds.

== Returns ==
Nothing.

== Details ==
* The client stores <code>total</code> and the time at which the cooldown ends (now + <code>remaining</code>), rebuilds the display's shape and schedules it for update.
* The stock UI passes <code>0, 0</code> to clear a cooldown.
* If the window exists but is not a CooldownDisplay, the call does nothing and raises no error.
* The error message is built from a format string, so its text is the same as the other ''does not exist'' errors.

== Errors ==
* <code>Error in function call 'CooldownDisplaySetCooldown': Window %s does not exist</code>

== Example ==
From <code>ea_actionbars/source/actionbutton.lua</code>:
<pre>
self.m_Cooldown, self.m_MaxCooldown = GetHotbarCooldown (self:GetSlot ())
...
cooldownFrame:Show (true)
CooldownDisplaySetCooldown (cooldownFrame:GetName (), self.m_Cooldown, self.m_MaxCooldown)
</pre>

Clearing it, from <code>ea_moralewindow/source/moralewindow.lua</code>:
<pre>
CooldownDisplaySetCooldown (self.m_Windows[COOLDOWN]:GetName (), 0, 0)
</pre>

== See also ==
* [[API:ActionButtonGroupSetTimer|ActionButtonGroupSetTimer]]

API:CooldownDisplaySetCooldown - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)