 |
The API is no longer being updated here until further notice. |
- See also: Cooldown
Cooldown (inherits from Frame) is a specialized variety of Frame that displays the little "clock" effect over abilities and buffs. It can be set with its running time, whether it should appear to "fill up" or "empty out", and whether or not there should be a bright edge where it's changing between dim and bright.
Cooldowns are usually children of another frame, and typically set to cover the same area as that frame, or almost all of it. In the stock UI, they are used mostly to display cooldowns on action buttons and buffs or debuffs on targets.
Defined Methods
- Cooldown:Clear() - Clears the currently active cooldown of the widget
- Cooldown:GetCooldownDisplayDuration()
- Cooldown:GetCooldownDuration() - Returns the duration currently shown by the cooldown frame in milliseconds
- Cooldown:GetCooldownTimes() - Returns the starting time and duration of the cooldown frame in milliseconds
- Cooldown:GetDrawBling()
- Cooldown:GetDrawEdge() - Returns whether a bright line should be drawn on the moving edge of the cooldown animation
- Cooldown:GetDrawSwipe()
- Cooldown:GetEdgeScale()
- Cooldown:GetReverse() - Returns whether the bright and dark portions of the cooldown animation should be inverted
- Cooldown:GetRotation() - Get the current rotation of the cooldown in radians
- Cooldown:IsPaused() - Returns whether the cooldown is currently paused
- Cooldown:Pause() - Pause the cooldown
- Cooldown:Resume() - Resume the cooldown after being paused
- Cooldown:SetBlingTexture(file or fileDataID, [r, g, b, a])
- Cooldown:SetCooldown(start, duration[, modRate]) - Shows a cooldown animation.
- Cooldown:SetCooldownDuration(duration[, modRate])
- Cooldown:SetCooldownUNIX(start, duration[, modRate])
- Cooldown:SetCountdownAbbrevThreshold(seconds)
- Cooldown:SetCountdownFont(font)
- Cooldown:SetDrawBling()
- Cooldown:SetDrawEdge(enable) - Sets whether a bright line should be drawn on the moving edge of the cooldown animation
- Cooldown:SetDrawSwipe()
- Cooldown:SetEdgeScale(edgeScale)
- Cooldown:SetEdgeTexture(file or fileDataID, [r, g, b, a]) - Set the texture which 'follows' the moving edge of the cooldown
- Cooldown:SetHideCountdownNumbers(hide) - Show or hide text cooldown timer
- Cooldown:SetReverse(boolean) - Controls the direction of the cooldown animation.
- Cooldown:SetRotation(rotationRadians) - Rotate the entire cooldown a certain radians clockwise
- Cooldown:SetSwipeColor(r, g, b, [a]) - Set the color of the swipe
- Cooldown:SetSwipeTexture(file or fileDataID, [r, g, b, a]) - Set the swipe texture used for the cooldown
- Cooldown:SetUseCircularEdge(Boolean) - Sets whether the edge texture should follow a circular pattern instead of square
Defined Script Handlers
- OnCooldownDone(self) - Run when a cooldown has finished.
External links
wowprogramming, Jim Whitehead