CooldownDisplay

The CooldownDisplay provides a rectangular or circular shaped radial cooldown wipe for interface objects needing to display that information.

Summary
CooldownDisplayThe CooldownDisplay provides a rectangular or circular shaped radial cooldown wipe for interface objects needing to display that information.
XML DefinitionThis is the CooldownDisplay xml definition.
XML Tag
Optional AttributesThese are optional.
cooldownshapeThe shape of the cooldown; is it circlular or rectangular?
segmentsOnly applies to circular CooldownDisplays.
CooldownDisplaySetCooldown()Alters the state of the cooldown animation.

XML Definition

This is the CooldownDisplay xml definition.

Summary
XML Tag
Optional AttributesThese are optional.
cooldownshapeThe shape of the cooldown; is it circlular or rectangular?
segmentsOnly applies to circular CooldownDisplays.
CooldownDisplaySetCooldown()Alters the state of the cooldown animation.

XML Tag

<CooldownDisplay>
....
</CooldownDisplay>

Optional Attributes

These are optional.  You can use whichever apply to the CooldownDisplay you are creating.

cooldownshape

The shape of the cooldown; is it circlular or rectangular?

Expects

A string value, “circle” or “square”

Default Value

  • ”square”

segments

Only applies to circular CooldownDisplays.

Expects

An integer value, which determines the number of segments around the circular CooldownDisplay.

Default Value

  • 8

CooldownDisplaySetCooldown()

Alters the state of the cooldown animation.  This either begins a new cooldown, adjusts a cooldown in progress, or stops a cooldown.

Parameters

cooldownDisplayName(string) The window name of the CooldownDisplay.
currentCooldownValue(number) What the timer is currently set to.
maximumCooldownValue(number) What the maximum timer of the cooldown is.

Returns

  • none

Notes

  • none

Example

CooldownDisplaySetCooldown ("TestCooldown", 5, 5) -- Resets the cooldown to 5 seconds, begins animating instantly.