C_Housing. GetVisitCooldownInfo
functionguessedavailable in: camelot
Returns the cooldown of visiting a house, or nothing. · description by wowlua
function C_Housing.GetVisitCooldownInfo(): SpellCooldownInfo?Returns
spellCooldownInfo · SpellCooldownInfo?
| field | type | description |
|---|---|---|
startTime | number | If cooldown is active, time started; 0 if no cooldown; Current time if isEnabled is false |
duration | number | Cooldown duration in seconds if active; 0 if cooldown is inactive |
isEnabled | boolean | False if cooldown is on hold (ex: some cooldowns only start after an active spell is cancelled); True otherwise |
isActive | boolean | False if cooldown is not active (ex: not enabled, or startTime or duration are 0); True otherwise |
modRate | number | Rate at which cooldown UI should update |
activeCategory | number? | Indicates which category is responsible for determining the duration. A nil value indicates the duration was determined through some other logic, e.g. the spell is on hold. |
timeUntilEndOfStartRecovery | number? | When this is set it indicates that the spell is in recovery and this is how long it will be until that recovery period is finished |
isOnGCD | boolean? | Whether or not this spell is considered to be on the global cooldown, do not trust this field unless responding to a SPELL_UPDATE_COOLDOWN event |
Blizzard's documentation says it may return nothing.
In wowlua's emulated client
guessedThe answer is worked out from Blizzard's documentation, its UI code and the function's name, and not checked against the client. what the statuses mean
sources
Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingUI system, camelot 1.60.1). Description: written by wowlua where no documentation describes the entry.