WoW:API GetActionCooldown - Revision history

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

2023-08-15T04:45:41Z

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

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Mbudde at 01:11, 4 November 2006

2006-11-04T01:11:54Z

← Older revision		Revision as of 01:11, 4 November 2006
Line 4:		Line 4:

	start, duration, enable = GetActionCooldown(slot)		start, duration, enable = GetActionCooldown(slot)
	~~{{clr}}~~
	== Parameters ==		== Parameters ==
	''Arguments''		<big>'''Arguments'''</big>

	:;slot : Integer - The [[ActionSlot\|action slot]] to retrieve data from.		:;slot : Integer - The [[ActionSlot\|action slot]] to retrieve data from.
	~~''Returns''~~

	:;start : Number: The time at which the current cooldown period began (relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.		<big>'''Returns'''</big>
	:;duration : Number: The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
	:;enable : Number: Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started.		:start, duration, enable

			:;start : Number - The time at which the current cooldown period began (relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.
			:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
			:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started.

	== Example ==		== Example ==

WoWWiki>Socrates200X: Added {{clr}}

2006-10-16T19:01:23Z

Added {{clr}}

← Older revision		Revision as of 19:01, 16 October 2006
Line 1:		Line 1:
	~~<center>'''GetActionCooldown''' - ''Documentation by Sarf''</center>~~		{{wowapi}} __NOTOC__

	Retrieves the cooldown data of the action specified.		Retrieves the [[cooldown]] data of the action specified.

	start, duration, enable = GetActionCooldown(slot)		start, duration, enable = GetActionCooldown(slot)
			{{clr}}
	== Parameters ==		== Parameters ==
	~~===~~ Arguments ~~===~~		''Arguments''
	~~:(slot)~~

	:;slot : Integer - The action slot to retrieve data from.		:;slot : Integer - The [[ActionSlot\|action slot]] to retrieve data from.
	~~===~~ Returns ~~===~~		''Returns''
	~~:start, duration, enable~~

	:;start : Number - The time at which the current cooldown period began (~~Relative~~ to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.		:;start : Number: The time at which the current cooldown period began (relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.
	:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.		:;duration : Number: The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
	:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. ~~(Lets~~ you know when a shapeshifting form has ended and the actual countdown has started).		:;enable : Number: Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started.

	== Example ==		== Example ==
	~~<!-- begin code -->~~
	~~local start, duration, enable = GetActionCooldown(slot);~~
	~~if ( start > 0 and duration > 0 and enable > 0) then~~
	~~-- do stuff when cooldown is under effect~~
	~~else~~
	~~-- do stuff when cooldown is not active~~
	~~end~~
	~~<!-- end code -->~~
	or
	<!-- begin code -->		<!-- begin code -->
	local start, duration, enable = GetActionCooldown(slot);		local start, duration, enable = GetActionCooldown(slot);
Line 34:		Line 24:
	end		end
	<!-- end code -->		<!-- end code -->
	~~----~~
	~~__NOTOC__~~
	~~{{Template:WoW API}}~~

WoWWiki>Mortilus: /* Example */

2006-07-19T14:09:26Z

Example

← Older revision		Revision as of 14:09, 19 July 2006
Line 23:		Line 23:
	else		else
	-- do stuff when cooldown is not active		-- do stuff when cooldown is not active
			end
			<!-- end code -->
			or
			<!-- begin code -->
			local start, duration, enable = GetActionCooldown(slot);
			if ( start == 0 ) then
			-- do stuff when cooldown is not active
			else
			-- do stuff when cooldown is under effect
	end		end
	<!-- end code -->		<!-- end code -->

WoWWiki>Anticrash at 16:39, 30 December 2005

2005-12-30T16:39:59Z

← Older revision		Revision as of 16:39, 30 December 2005
Line 28:		Line 28:
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Action Functions\|GetActionCooldown]]~~

WoWWiki>Vyrticl: /* Returns */

2005-10-17T19:18:02Z

Returns

← Older revision		Revision as of 19:18, 17 October 2005
Line 14:		Line 14:
	:;start : Number - The time at which the current cooldown period began (Relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.		:;start : Number - The time at which the current cooldown period began (Relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.
	:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.		:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
	:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (~~Exactly what this is for is slightly unclear~~).		:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (Lets you know when a shapeshifting form has ended and the actual countdown has started).

	== Example ==		== Example ==
	<!-- begin code -->		<!-- begin code -->

WoWWiki>Flickering: Updated formatting

2005-09-20T01:58:03Z

Updated formatting

← Older revision		Revision as of 01:58, 20 September 2005
Line 1:		Line 1:
	<center>'''GetActionCooldown''' ''-Documentation by Sarf-''</center>		<center>'''GetActionCooldown''' - ''Documentation by Sarf''</center>

	Retrieves the cooldown data of the action specified.		Retrieves the cooldown data of the action specified.

	~~local~~ start, duration, enable = GetActionCooldown(~~v.id~~);		start, duration, enable = GetActionCooldown(slot)
			== Parameters ==
			=== Arguments ===
			:(slot)

	;		:;slot : Integer - The action slot to retrieve data from.
			=== Returns ===
			:start, duration, enable

	~~----~~		:;start : Number - The time at which the current cooldown period began (Relative to the result of [[API GetTime\|GetTime]]), or 0 if the cooldown is not active or not applicable.
	;~~''Arguments''~~		:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
			:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (Exactly what this is for is slightly unclear).
	:(Number ~~actionID)~~		== Example ==
			<!-- begin code -->
	~~:;actionID : The ID of the action button to retrieve cooldown data for~~		local start, duration, enable = GetActionCooldown(slot);
			if ( start > 0 and duration > 0 and enable > 0) then
	~~---~~-
	~~;''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 : ~~seems to always~~ be 1

	----
	~~;''Example''~~
	local start, duration, enable = GetActionCooldown(~~v.id~~);
	if ( start > 0 and duration > 0 and enable > 0) then
	-- do stuff when cooldown is under effect		-- do stuff when cooldown is under effect
	else		else
	-- do stuff when cooldown is not active		-- do stuff when cooldown is not active
	end		end
			<!-- end code -->
	~~;''Result''~~

	~~Retrieves data. Does not (to my knowledge) actually change anything.~~

	----
	~~;''Description''~~

	~~: Retrieves data on the cooldown on a specific action button.~~
	~~----~~
	~~(This doesn't seem to work in Macros (or perhaps not at all) it always triggers the "not active" part.~~
	~~Crash 19:09 05-06-2005)~~

	----		----
			__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|GetActionCooldown]]~~
	[[Category:API Action Functions\|GetActionCooldown]]		[[Category:API Action Functions\|GetActionCooldown]]

WoWWiki>Mrfrippe at 11:19, 13 September 2005

2005-09-13T11:19:20Z

← Older revision		Revision as of 11:19, 13 September 2005
Line 21:		Line 21:
	:;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 : ~~0 if no cooldown,~~ 1 ~~if cooldown is in effect (probably)~~		:;enable : seems to always be 1

	----		----

WoWWiki>Inglais at 12:41, 27 August 2005

2005-08-27T12:41:32Z

← Older revision		Revision as of 12:41, 27 August 2005
Line 46:		Line 46:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|GetActionCooldown]]
			[[Category:API Action Functions\|GetActionCooldown]]

WoWWiki>WoWWiki-Crash at 16:09, 5 June 2005

2005-06-05T16:09:59Z

← Older revision		Revision as of 16:09, 5 June 2005
Line 40:		Line 40:

	: Retrieves data on the cooldown on a specific action button.		: Retrieves data on the cooldown on a specific action button.
			----
			(This doesn't seem to work in Macros (or perhaps not at all) it always triggers the "not active" part.
			Crash 19:09 05-06-2005)

	----		----
	{{Template:WoW API}}		{{Template:WoW API}}