WoW:API GetSpellCooldown - Revision history

Move page script: Move page script moved page API GetSpellCooldown to WoW:API GetSpellCooldown without leaving a redirect

2023-08-15T04:46:28Z

Move page script moved page API GetSpellCooldown to API GetSpellCooldown without leaving a redirect

← Older revision

Revision as of 04:46, 15 August 2023

Bear: 1 revision

2020-05-15T22:28:43Z

1 revision

← Older revision		Revision as of 22:28, 15 May 2020
Line 5:		Line 5:

	==Arguments==		==Arguments==
	:;spellName : String - name of the spell to retrieve cooldown data for.		:;spellName
	:;spellID : Number - ID of the spell in the database		:: String - name of the spell to retrieve cooldown data for.
	:;slotID : Number - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.		:;spellID
	:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.		:: Number - ID of the spell in the database
			:;slotID
			:: Number - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
			:;bookType
			:: String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.

	==Returns==		==Returns==
	:;startTime : Number - The time when the cooldown started (as returned by [[API GetTime\|GetTime()]]); zero if no cooldown; current time if (enabled == 0).		:;startTime
	:;duration : Number - Cooldown duration in seconds, 0 if spell is ready to be cast.		:: Number - The time when the cooldown started (as returned by [[API GetTime\|GetTime()]]); zero if no cooldown; current time if (enabled == 0).
	:;enabled : Number - 0 if the spell is active (Stealth, Shadowmeld, Presence of Mind, etc) and the cooldown will begin as soon as the spell is used/cancelled; 1 otherwise.		:;duration
			:: Number - Cooldown duration in seconds, 0 if spell is ready to be cast.
			:;enabled
			:: Number - 0 if the spell is active (Stealth, Shadowmeld, Presence of Mind, etc) and the cooldown will begin as soon as the spell is used/cancelled; 1 otherwise.

	==Example==		==Example==

WoWWiki>Hati~: Added: As of 3.3.x it is possible to use GetSpellCooldown(Spellid)

2010-02-14T22:25:24Z

Added: As of 3.3.x it is possible to use GetSpellCooldown(Spellid)

← Older revision		Revision as of 22:25, 14 February 2010
Line 2:		Line 2:
	Retrieves the cooldown data of the spell specified.		Retrieves the cooldown data of the spell specified.

	start, duration, enabled = GetSpellCooldown(spellName or slotID, "bookType");		start, duration, enabled = GetSpellCooldown(spellName or spellID or slotID, "bookType");

	==Arguments==		==Arguments==
	:;spellName : String - name of the spell to retrieve cooldown data for.		:;spellName : String - name of the spell to retrieve cooldown data for.
			:;spellID : Number - ID of the spell in the database
	:;slotID : Number - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.		:;slotID : Number - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
	:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.		:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.
Line 33:		Line 34:

	Example of using SpellIDs to retrieve cooldown info		Example of using SpellIDs to retrieve cooldown info


			==Example==
			local start, duration, enabled = GetSpellCooldown(48505);

			===Result===
			returns 0, 0, 1 if the spell 'Starfall' is not on Cooldown
			otherwise it returns GetTime(), 90, 1


Line 38:		Line 47:
	*The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs.		*The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs.
	*Values returned by this function are not updated immediately when UNIT_SPELLCAST_SUCCEEDED event is raised.		*Values returned by this function are not updated immediately when UNIT_SPELLCAST_SUCCEEDED event is raised.
	*GetSpellCooldown() does not directly accept SpellIDs. You must first retrieve the spell name using GetSpellInfo(spellID)		*GetSpellCooldown() does not directly accept SpellIDs. You must first retrieve the spell name using GetSpellInfo(spellID) [Seems out of date as of 3.3]
			*GetSpellCooldown() accepts SpellIDs [Noticed in 3.3.2 - but worked with it as of 3.3]

WoWWiki>Ganders at 03:09, 13 April 2008

2008-04-13T03:09:37Z

← Older revision		Revision as of 03:09, 13 April 2008
Line 2:		Line 2:
	Retrieves the cooldown data of the spell specified.		Retrieves the cooldown data of the spell specified.

	start, duration, enabled = GetSpellCooldown(spellName or ~~spellID~~, "bookType");		start, duration, enabled = GetSpellCooldown(spellName or slotID, "bookType");

	==Arguments==		==Arguments==
	:;spellName : String - name of the spell to retrieve cooldown data for.		:;spellName : String - name of the spell to retrieve cooldown data for.
	:;~~spellID~~ : Number - ~~The ID~~ of the ~~spell to retrieve cooldown data for~~		:;slotID : Number - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
	:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.		:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.

Line 15:		Line 15:

	==Example==		==Example==
	local start, duration, enabled = GetSpellCooldown("Presence of Mind");		local start, duration, enabled = GetSpellCooldown("Presence of Mind");
	if enabled == 0 then		if enabled == 0 then
	DEFAULT_CHAT_FRAME:AddMessage("Presence of Mind is currently active, use it and wait " .. duration .. " seconds for the next one.");		DEFAULT_CHAT_FRAME:AddMessage("Presence of Mind is currently active, use it and wait " .. duration .. " seconds for the next one.");
Line 26:		Line 26:
	===Result===		===Result===
	Checks status of the [[Presence of Mind]] cooldown and outputs the appropriate message to the default chat frame.		Checks status of the [[Presence of Mind]] cooldown and outputs the appropriate message to the default chat frame.

			==Example==
			local name = GetSpellInfo(28370);
			local start, duration, enabled = GetSpellCooldown(name);
			etc...

			Example of using SpellIDs to retrieve cooldown info


	==Notes==		==Notes==
	*The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs.		*The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs.
	*Values returned by this function are not updated immediately when UNIT_SPELLCAST_SUCCEEDED event is raised.		*Values returned by this function are not updated immediately when UNIT_SPELLCAST_SUCCEEDED event is raised.
			*GetSpellCooldown() does not directly accept SpellIDs. You must first retrieve the spell name using GetSpellInfo(spellID)

WoWWiki>Starlightblunder: /* Notes */

2007-09-25T13:35:10Z

Notes

← Older revision		Revision as of 13:35, 25 September 2007
Line 2:		Line 2:
	Retrieves the cooldown data of the spell specified.		Retrieves the cooldown data of the spell specified.

	~~local~~ start, duration = GetSpellCooldown(spellID, "bookType");		start, duration, enabled = GetSpellCooldown(spellName or spellID, "bookType");

	----		==Arguments==
	;~~''Arguments''~~		:;spellName : String - name of the spell to retrieve cooldown data for.
			:;spellID : Number - The ID of the spell to retrieve cooldown data for
			:;bookType : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.

	:(Number ~~spellID~~)		==Returns==
			:;startTime : Number - The time when the cooldown started (as returned by [[API GetTime\|GetTime()]]); zero if no cooldown; current time if (enabled == 0).
			:;duration : Number - Cooldown duration in seconds, 0 if spell is ready to be cast.
			:;enabled : Number - 0 if the spell is active (Stealth, Shadowmeld, Presence of Mind, etc) and the cooldown will begin as soon as the spell is used/cancelled; 1 otherwise.

	~~:;spellID : The ID of the spell to retrieve cooldown data for~~		==Example==
			local start, duration, enabled = GetSpellCooldown("Presence of Mind");
	~~:(string bookType)~~		if enabled == 0 then
			DEFAULT_CHAT_FRAME:AddMessage("Presence of Mind is currently active, use it and wait " .. duration .. " seconds for the next one.");
	~~:;bookType : BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.~~		elseif ( start > 0 and duration > 0) then
			DEFAULT_CHAT_FRAME:AddMessage("Presence of Mind is cooling down, wait " .. (start + duration - GetTime()) .. " seconds for the next one.");
	~~----~~
	~~;''Returns''~~

	~~:(Number startTime~~, ~~Number~~ duration, ~~Number enable~~)

	:~~;startTime : The time when the cooldown started~~ (~~as returned by [[API GetTime\|GetTime()]]) or zero if no cooldown~~
	~~:;duration : The number~~ of ~~seconds the cooldown will last, or zero if no cooldown~~
	~~:;enable : Returns 1 when the spell cooldown starts, for abilities that can be toggled like Stealth~~, ~~Shadowform this returns 0 when you activate~~ it.

	~~----~~
	~~;''Example''~~
	~~local start,~~ duration ~~= GetSpellCooldown(spellID, BOOKTYPE_SPELL~~);
	if ( start > 0 and duration > 0) then
	~~Print~~(~~'Please~~ wait ' .. duration - ( GetTime() ~~- start~~) .. ' seconds ~~before using this spell~~.');
	else		else
	~~Print~~(~~'Spell~~ is ready.');		DEFAULT_CHAT_FRAME:AddMessage("Presence of Mind is ready.");
	end		end

	~~;''~~Result''		===Result===
			Checks status of the [[Presence of Mind]] cooldown and outputs the appropriate message to the default chat frame.
	~~: Retrieves data. Does not (to my knowledge) actually change anything.~~

	~~: "For~~ the [[~~Nature's_Swiftness\|Nature's Swiftness~~]] ~~spell~~ and ~~posibly other spells that don't start their cooldown timer before they are used up~~ the ~~values retrieved by GetSpellCooldown change over time. The startTime returned is~~ the ~~current time (that this function was called), not the time the spell was cast. The duration is 0.001 not the spell's normal cooldown~~.

	~~: In this way we can use GetSpellCooldown~~ to ~~see~~ if ~~this type~~ of ~~spell is active on~~ the player ~~without having to look at~~ buffs ~~and debuffs~~."		==Notes==
			*The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs.
			*Values returned by this function are not updated immediately when UNIT_SPELLCAST_SUCCEEDED event is raised.

WoWWiki>Evl at 10:53, 11 May 2007

2007-05-11T10:53:41Z

← Older revision		Revision as of 10:53, 11 May 2007
Line 22:		Line 22:
	:;startTime : The time when the cooldown started (as returned by [[API GetTime\|GetTime()]]) or zero if no cooldown		:;startTime : The time when the cooldown started (as returned by [[API GetTime\|GetTime()]]) or zero if no cooldown
	:;duration : The number of seconds the cooldown will last, or zero if no cooldown		:;duration : The number of seconds the cooldown will last, or zero if no cooldown
			:;enable : Returns 1 when the spell cooldown starts, for abilities that can be toggled like Stealth, Shadowform this returns 0 when you activate it.
	:;enable : ~~Appears to return~~ 1 ~~no matter what~~.

	----		----

WoWWiki>VoidvectorBot: Remove singatures made using ~ in main namespace

2007-02-10T06:20:53Z

Remove singatures made using ~ in main namespace

← Older revision		Revision as of 06:20, 10 February 2007
Line 40:		Line 40:
	: "For the [[Nature's_Swiftness\|Nature's Swiftness]] spell and posibly other spells that don't start their cooldown timer before they are used up the values retrieved by GetSpellCooldown change over time. The startTime returned is the current time (that this function was called), not the time the spell was cast. The duration is 0.001 not the spell's normal cooldown.		: "For the [[Nature's_Swiftness\|Nature's Swiftness]] spell and posibly other spells that don't start their cooldown timer before they are used up the values retrieved by GetSpellCooldown change over time. The startTime returned is the current time (that this function was called), not the time the spell was cast. The duration is 0.001 not the spell's normal cooldown.

	: In this way we can use GetSpellCooldown to see if this type of spell is active on the player without having to look at buffs and debuffs." ~~--[[User:Brahgulshin\|Brahgulshin]] 19:39, 13 March 2006 (EST)~~		: In this way we can use GetSpellCooldown to see if this type of spell is active on the player without having to look at buffs and debuffs."

WoWWiki>Starlightblunder: {{wowapi}}

2006-12-20T04:14:31Z

← Older revision		Revision as of 04:14, 20 December 2006
Line 1:		Line 1:
			{{wowapi}}
	Retrieves the cooldown data of the spell specified.		Retrieves the cooldown data of the spell specified.

	local start, duration = GetSpellCooldown(spellID, "bookType");		local start, duration = GetSpellCooldown(spellID, "bookType");

	;

	----		----
Line 42:		Line 41:

	: In this way we can use GetSpellCooldown to see if this type of spell is active on the player without having to look at buffs and debuffs." --[[User:Brahgulshin\|Brahgulshin]] 19:39, 13 March 2006 (EST)		: In this way we can use GetSpellCooldown to see if this type of spell is active on the player without having to look at buffs and debuffs." --[[User:Brahgulshin\|Brahgulshin]] 19:39, 13 March 2006 (EST)
	~~----~~
	~~;''Description''~~

	~~: Retrieves data on the cooldown of a specific spell within your spellbook.~~
	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>WoWWiki-Sarek at 23:50, 7 July 2006

2006-07-07T23:50:05Z

← Older revision		Revision as of 23:50, 7 July 2006
Line 24:		Line 24:
	:;duration : The number of seconds the cooldown will last, or zero if no cooldown		:;duration : The number of seconds the cooldown will last, or zero if no cooldown

	:;enable : Appears to ~~be set to~~ 1 ~~if this spell is in cooldown, and 0 otherwise~~.		:;enable : Appears to return 1 no matter what.

	----		----

WoWWiki>Starlightblunder: bookType rather than tabNumber

2006-03-18T18:12:00Z

bookType rather than tabNumber

← Older revision		Revision as of 18:12, 18 March 2006
Line 1:		Line 1:
	Retrieves the cooldown data of the spell specified.		Retrieves the cooldown data of the spell specified.

	local start, duration = GetSpellCooldown(spellID, ~~spellnumTab~~);		local start, duration = GetSpellCooldown(spellID, "bookType");

	;		;
Line 12:		Line 12:
	:;spellID : The ID of the spell to retrieve cooldown data for		:;spellID : The ID of the spell to retrieve cooldown data for

	:(~~Number spellnumTab~~)		:(string bookType)

	:;~~spellnumTab~~ : ~~The tab within your~~ spellbook~~, ignore empty slots. As of 1.41 this argument appears to be required, but not used~~.		:;bookType : BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.

	----		----
Line 28:		Line 28:
	----		----
	;''Example''		;''Example''
	local start, duration = GetSpellCooldown(spellID, ~~spellnumTab~~);		local start, duration = GetSpellCooldown(spellID, BOOKTYPE_SPELL);
	if ( start > 0 and duration > 0) then		if ( start > 0 and duration > 0) then
	Print('Please wait ' .. duration - ( GetTime() - start) .. ' seconds before using this spell.');		Print('Please wait ' .. duration - ( GetTime() - start) .. ' seconds before using this spell.');