Cooldown
widget type46 methodsavailable in: camelot
CreateFrame("Cooldown", …) makes one. It has every method of Frame, plus 46 of its own.
Inherits from
- Cooldown · 46
- Frame · 126
- Region · 16
- ScriptRegion · 55
- ScriptRegionResizing · 13
- AnimatableObject · 3
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A Cooldown has all of them.
Methods
In the emulator: 26 implemented, 20 guessed.
| method | what it does | status |
|---|---|---|
Clear | Clears the cooldown. · by wowlua() | guessed |
GetCooldownDisplayDuration | The returned duration unit is milliseconds, unaffected by modRate. · warcraft.wiki.gg ↗(): number | guessed |
GetCooldownDuration | Returns the duration of the cooldown currently displayed by the Cooldown widget. · warcraft.wiki.gg ↗(): number | guessed |
GetCooldownTimes | Returns the cooldown's start time and duration in milliseconds. · by wowlua(): (number, number) | guessed |
GetCountdownAbbrevThreshold | Returns the threshold below which cooldown numbers are displayed as an abbreviated form without a unit suffix (eg. '1:31'). · warcraft.wiki.gg ↗(): Seconds | guessed |
GetCountdownFontString | Returns the font string that shows the countdown numbers. · by wowlua(): FontString | guessed |
GetCountdownFormatter | Returns the formatter that turns the remaining time into the countdown text, or nil if none is set. · by wowlua(): NumericFormatter? | guessed |
GetCountdownMillisecondsThreshold | Returns the threshold below which cooldown numbers are displayed as a decimal value with one place for milliseconds (eg. '8.7'). · warcraft.wiki.gg ↗(): Seconds | guessed |
GetDrawBling | Whether the cooldown shows a flash when it finishes. · by wowlua(): boolean | guessed |
GetDrawEdge | Whether the cooldown draws a bright edge on the swipe. · by wowlua(): boolean | guessed |
GetDrawSwipe | Whether the cooldown draws its swipe. · by wowlua(): boolean | guessed |
GetEdgeScale | Returns the scale of the cooldown's edge. · by wowlua(): number | guessed |
GetHideCountdownNumbers | Whether the cooldown hides its countdown numbers. · by wowlua(): boolean | guessed |
GetMinimumCountdownDuration | Returns the shortest cooldown for which countdown numbers are shown. · by wowlua(): Milliseconds | guessed |
GetReverse | Whether the cooldown's swipe runs in reverse. · by wowlua(): boolean | guessed |
GetRotation | Returns how many radians the cooldown is rotated clockwise. · warcraft.wiki.gg ↗(): number | guessed |
GetUseAuraDisplayTime | Whether the cooldown shows its time the way auras do. · by wowlua(): boolean | guessed |
IsPaused | Return whether the cooldown is currently paused. · warcraft.wiki.gg ↗(): boolean | implemented |
Pause | Pause the cooldown widget. · warcraft.wiki.gg ↗() | guessed |
Resume | Resumes the cooldown widget after being paused · warcraft.wiki.gg ↗() | guessed |
SetBlingTexture | Assign a texture for the brief animation after a cooldown finishes. · warcraft.wiki.gg ↗(texture: FileAsset, colorR: number, colorG: number, colorB: number, colorA: number) | implemented |
SetCooldown | Shows a cooldown animation. · warcraft.wiki.gg ↗(start: Seconds, duration: Seconds, modRate: number) | implemented |
SetCooldownDuration | Shows a cooldown animation starting from the moment the function is called. · warcraft.wiki.gg ↗(duration: Seconds, modRate: number) | guessed |
SetCooldownFromDurationObject | Starts the cooldown from a duration object. · by wowlua(duration: LuaDurationObject, clearIfZero: boolean) | implemented |
SetCooldownFromExpirationTime | Starts the cooldown from the time it ends and its duration. · by wowlua(expirationTime: Seconds, duration: Seconds, modRate: number) | implemented |
SetCooldownUNIX | Shows a cooldown animation using UNIX time. · warcraft.wiki.gg ↗(start: number, duration: number, modRate: number) | implemented |
SetCountdownAbbrevThreshold | Sets the threshold below which cooldown numbers are displayed as an abbreviated form without a unit suffix (eg. '1:31'). · warcraft.wiki.gg ↗(seconds: Seconds) | implemented |
SetCountdownFont | Sets the font of the countdown numbers. · by wowlua(fontName: string) | implemented |
SetCountdownFormatter | Sets the formatter that turns the remaining time into the countdown text. Pass nil to clear it. · by wowlua(formatter: NumericFormatter?) | implemented |
SetCountdownMillisecondsThreshold | Sets the threshold below which cooldown numbers are displayed as a decimal value with one place for milliseconds (eg. '8.7'). · warcraft.wiki.gg ↗(seconds: Seconds) | implemented |
SetDrawBling | Controls the rotating animation at the end of a cooldown. · warcraft.wiki.gg ↗(drawBling: boolean) | implemented |
SetDrawEdge | Sets whether the cooldown draws a bright edge on the swipe. · by wowlua(drawEdge: boolean) | implemented |
SetDrawSwipe | Sets whether the cooldown draws its swipe. · by wowlua(drawSwipe: boolean) | implemented |
SetEdgeColor | Sets the color of the cooldown's edge. · by wowlua(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetEdgeScale | Sets the scale of the cooldown's edge. · by wowlua(scale: number) | implemented |
SetEdgeTexture | Sets the texture and color of the cooldown's edge. · by wowlua(texture: FileAsset, colorR: number, colorG: number, colorB: number, colorA: number) | implemented |
SetHideCountdownNumbers | Sets whether the cooldown hides its countdown numbers. · by wowlua(hideNumbers: boolean) | implemented |
SetMinimumCountdownDuration | Controls the minimum duration above which countdown text will be shown. This is applied based upon the total duration of the cooldown, not the remaining duration as it ticks down. · warcraft.wiki.gg ↗(milliseconds: Milliseconds) | implemented |
SetPaused | Pauses or resumes the cooldown. · by wowlua(paused: boolean) | implemented |
SetReverse | Controls the direction of the cooldown animation. · warcraft.wiki.gg ↗(reverse: boolean) | implemented |
SetRotation | Rotates the entire cooldown a certain radians clockwise · warcraft.wiki.gg ↗(rotationRadians: number) | implemented |
SetSwipeColor | Set the cooldown swipe to be a specific color. · warcraft.wiki.gg ↗(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetSwipeTexture | Assigns a texture for the swipe of the cooldown. · warcraft.wiki.gg ↗(texture: FileAsset?, colorR: number, colorG: number, colorB: number, colorA: number) | implemented |
SetTexCoordRange | Sets the part of the swipe texture the cooldown uses. · by wowlua(low: Vector2DMixin, high: Vector2DMixin) | implemented |
SetUseAuraDisplayTime | Aura durations are displayed slightly differently than cooldown durations. Setting this to true will adjust the display logic to stay in sync with aura timers. · warcraft.wiki.gg ↗(useAuraDisplayTime: boolean) | implemented |
SetUseCircularEdge | Set the Cooldown edge to follow a circular pattern instead of a square. · warcraft.wiki.gg ↗(useCircularEdge: boolean) | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.