WoW:API UnitCastingInfo - Revision history

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

2023-08-15T04:47:42Z

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

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 07:08, 16 January 2014

2014-01-16T07:08:29Z

← Older revision		Revision as of 07:08, 16 January 2014
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		__NOWYSIWYG__{{wowapi}}__NOTOC__


Line 12:		Line 12:

	=== Returns ===		=== Returns ===
	:;spell		:;spell: String - The name of the spell, or nil if no spell is being cast.
	:: String - The name of the spell, or nil if no spell is being cast.		:;rank: String - The string describing the rank of the spell, e.g. "Rank 1".
	:;rank		:;displayName: String - The name to be displayed.
	:: String - The string describing the rank of the spell, e.g. "Rank 1".		:;icon: String - The texture path associated with the spell.
	:;displayName		:;startTime: Number - Specifies when casting has begun, in milliseconds.
	:: String - The name to be displayed.		:;endTime: Number - Specifies when casting will end, in milliseconds.
	:;icon		:;isTradeSkill: Boolean - Specifies if the cast is a tradeskill
	:: String - The texture path associated with the spell.		:;castID: Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)
	:;startTime		:;interrupt: (added in 3.2) Boolean - Returns true if the unit's current cast can not be interrupted by abilities such as Counterspell or Kick. Otherwise, returns false if the cast is interruptible or nil if the unit is not casting. If tested on a Paladin with Divine Shield active, interrupt returns true while the Paladin is casting. Without Divine Shield active, interrupt would return false.)
	:: Number - Specifies when casting has begun, in milliseconds.
	:;endTime
	:: Number - Specifies when casting will end, in milliseconds.
	:;isTradeSkill
	:: Boolean - Specifies if the cast is a tradeskill
	:;castID
	:: Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)
	:; interrupt
	:: (added in 3.2) Boolean - Returns true if the unit's current cast can not be interrupted by abilities such as Counterspell or Kick. Otherwise, returns false if the cast is interruptible or nil if the unit is not casting. If tested on a Paladin with Divine Shield active, interrupt returns true while the Paladin is casting. Without Divine Shield active, interrupt would return false.)

	== Example ==		== Example ==

72.183.111.39: /* Returns */

2014-01-16T05:12:26Z

Returns

← Older revision		Revision as of 05:12, 16 January 2014
Line 12:		Line 12:

	=== Returns ===		=== Returns ===
	:;spell : String - The name of the spell, or nil if no spell is being cast.		:;spell
	:;rank : String - The string describing the rank of the spell, e.g. "Rank 1".		:: String - The name of the spell, or nil if no spell is being cast.
	:;displayName : String - The name to be displayed.		:;rank
	:;icon : String - The texture path associated with the spell.		:: String - The string describing the rank of the spell, e.g. "Rank 1".
	:;startTime : Number - Specifies when casting has begun, in milliseconds.		:;displayName
	:;endTime : Number - Specifies when casting will end, in milliseconds.		:: String - The name to be displayed.
	:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill		:;icon
	:;castID : Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)		:: String - The texture path associated with the spell.
	:; interrupt : (added in 3.2) Boolean - Returns true if the unit's current cast can be interrupted by abilities such as Counterspell or Kick. Otherwise, returns false if the cast is interruptible or nil if the unit is not casting. If tested on a Paladin with Divine Shield active, interrupt returns true while the Paladin is casting. Without Divine Shield active, interrupt would return false.)		:;startTime
			:: Number - Specifies when casting has begun, in milliseconds.
			:;endTime
			:: Number - Specifies when casting will end, in milliseconds.
			:;isTradeSkill
			:: Boolean - Specifies if the cast is a tradeskill
			:;castID
			:: Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)
			:; interrupt
			:: (added in 3.2) Boolean - Returns true if the unit's current cast can not be interrupted by abilities such as Counterspell or Kick. Otherwise, returns false if the cast is interruptible or nil if the unit is not casting. If tested on a Paladin with Divine Shield active, interrupt returns true while the Paladin is casting. Without Divine Shield active, interrupt would return false.)

	== Example ==		== Example ==

WoWWiki>Nilum at 08:16, 28 April 2012

2012-04-28T08:16:28Z

← Older revision		Revision as of 08:16, 28 April 2012
Line 20:		Line 20:
	:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill		:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill
	:;castID : Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)		:;castID : Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)
	:;interrupt : ? (added in 3.2... ~~not sure what this is for~~, ~~tested against interruptable player spells and gave a~~ false ~~value~~)		:; interrupt : (added in 3.2) Boolean - Returns true if the unit's current cast can be interrupted by abilities such as Counterspell or Kick. Otherwise, returns false if the cast is interruptible or nil if the unit is not casting. If tested on a Paladin with Divine Shield active, interrupt returns true while the Paladin is casting. Without Divine Shield active, interrupt would return false.)

	== Example ==		== Example ==
Line 44:		Line 44:
	As of May 10, 2008, this does not return anything while casting Hellfire, Drain Life, or Rain of Fire with my warlock. The correct API for channeled spells is [[API UnitChannelInfo\|UnitChannelInfo]]. It takes the same arguments and returns the same values, but is specific to channeled spells.		As of May 10, 2008, this does not return anything while casting Hellfire, Drain Life, or Rain of Fire with my warlock. The correct API for channeled spells is [[API UnitChannelInfo\|UnitChannelInfo]]. It takes the same arguments and returns the same values, but is specific to channeled spells.

	New in Patch 3.2 (August 2009), returns 'interrupt' as well. Believe this is a boolean value for whether it is interruptable or not, but needs confirmation.		New in Patch 3.2 (August 2009), returns 'interrupt' as well. Believe this is a boolean value for whether it is interruptable or not, but needs confirmation. Confirmed and updated.

	Also, the [http://forums.worldofwarcraft.com/thread.html?topicId=18031134556&sid=1&pageNo=1 official WoW 3.2 patch changes page] lists the returns as:		Also, the [http://forums.worldofwarcraft.com/thread.html?topicId=18031134556&sid=1&pageNo=1 official WoW 3.2 patch changes page] lists the returns as:

WoWWiki>Violation84: /* Returns */

2009-10-02T15:40:54Z

Returns

← Older revision		Revision as of 15:40, 2 October 2009
Line 19:		Line 19:
	:;endTime : Number - Specifies when casting will end, in milliseconds.		:;endTime : Number - Specifies when casting will end, in milliseconds.
	:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill		:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill
	:;castID : Number - (added either in or just before 3.2 ~~- not sure what it does~~)		:;castID : Number - Counts the spellcast(s) since the game has loaded.(added either in or just before 3.2)
	:;interrupt : ? (added in 3.2... ~~believe it's boolean~~ for ~~isInterruptable~~, ~~but not sure~~)		:;interrupt : ? (added in 3.2... not sure what this is for, tested against interruptable player spells and gave a false value)

	== Example ==		== Example ==

WoWWiki>DigitalSorceress: added castID and interrupt to the returns list

2009-08-12T19:40:00Z

added castID and interrupt to the returns list

← Older revision		Revision as of 19:40, 12 August 2009
Line 4:		Line 4:
	Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast.		Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast.

	spell, rank, displayName, icon, startTime, endTime, isTradeSkill = UnitCastingInfo("unit")		spell, rank, displayName, icon, startTime, endTime, isTradeSkill, castID, interrupt = UnitCastingInfo("unit")


Line 19:		Line 19:
	:;endTime : Number - Specifies when casting will end, in milliseconds.		:;endTime : Number - Specifies when casting will end, in milliseconds.
	:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill		:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill
			:;castID : Number - (added either in or just before 3.2 - not sure what it does)
			:;interrupt : ? (added in 3.2... believe it's boolean for isInterruptable, but not sure)

	== Example ==		== Example ==
Line 42:		Line 44:
	As of May 10, 2008, this does not return anything while casting Hellfire, Drain Life, or Rain of Fire with my warlock. The correct API for channeled spells is [[API UnitChannelInfo\|UnitChannelInfo]]. It takes the same arguments and returns the same values, but is specific to channeled spells.		As of May 10, 2008, this does not return anything while casting Hellfire, Drain Life, or Rain of Fire with my warlock. The correct API for channeled spells is [[API UnitChannelInfo\|UnitChannelInfo]]. It takes the same arguments and returns the same values, but is specific to channeled spells.

			New in Patch 3.2 (August 2009), returns 'interrupt' as well. Believe this is a boolean value for whether it is interruptable or not, but needs confirmation.

			Also, the [http://forums.worldofwarcraft.com/thread.html?topicId=18031134556&sid=1&pageNo=1 official WoW 3.2 patch changes page] lists the returns as:
			name, nameSubtext, text, texture, startTime, endTime, isTradeSkill, castID, interrupt

			Didn't see 'castID' in there before, so added it to the returns list above. Assume it's a number, but this and the return type of interrupt need to be confirmed
	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Racionen: /* Details */

2008-05-10T17:28:30Z

Details

← Older revision		Revision as of 17:28, 10 May 2008
Line 39:		Line 39:

	Not sure if displayName ever differs from spell in any other contexts.		Not sure if displayName ever differs from spell in any other contexts.

			As of May 10, 2008, this does not return anything while casting Hellfire, Drain Life, or Rain of Fire with my warlock. The correct API for channeled spells is [[API UnitChannelInfo\|UnitChannelInfo]]. It takes the same arguments and returns the same values, but is specific to channeled spells.

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Wevah: /* Details */ displayName != spell for channeled spells (not sure if there are any other times, or if this only applies to the player's spells)

2008-03-22T05:45:52Z

Details: displayName != spell for channeled spells (not sure if there are any other times, or if this only applies to the player's spells)

← Older revision		Revision as of 05:45, 22 March 2008
Line 36:		Line 36:
	==Details==		==Details==

	Not sure if displayName ever differs from spell.		For channeled spells, displayName is "Channeling".

			Not sure if displayName ever differs from spell in any other contexts.

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Thoughtlover at 08:11, 24 January 2008

2008-01-24T08:11:52Z

← Older revision		Revision as of 08:11, 24 January 2008
Line 4:		Line 4:
	Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast.		Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast.

	spell, rank, displayName, icon, startTime, endTime = UnitCastingInfo("unit")		spell, rank, displayName, icon, startTime, endTime, isTradeSkill = UnitCastingInfo("unit")


Line 18:		Line 18:
	:;startTime : Number - Specifies when casting has begun, in milliseconds.		:;startTime : Number - Specifies when casting has begun, in milliseconds.
	:;endTime : Number - Specifies when casting will end, in milliseconds.		:;endTime : Number - Specifies when casting will end, in milliseconds.
			:;isTradeSkill : Boolean - Specifies if the cast is a tradeskill

	== Example ==		== Example ==

WoWWiki>Tifi: New page: {{wowapi}} NOTOC Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast. spell, rank, displayName, icon, startTime, endTime = ...

2007-08-09T10:05:52Z

New page: {{wowapi}} __NOTOC__ Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast. spell, rank, displayName, icon, startTime, endTime = ...

New page

{{wowapi}} __NOTOC__

Returns information on the spell currently cast by the specified unit. Returns nil if no spell is being cast.

spell, rank, displayName, icon, startTime, endTime = UnitCastingInfo("unit")

== Parameters ==
=== Arguments ===
:;unit : String - The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target" etc.)

=== Returns ===
:;spell : String - The name of the spell, or nil if no spell is being cast.
:;rank : String - The string describing the rank of the spell, e.g. "Rank 1".
:;displayName : String - The name to be displayed.
:;icon : String - The texture path associated with the spell.
:;startTime : Number - Specifies when casting has begun, in milliseconds.
:;endTime : Number - Specifies when casting will end, in milliseconds.

== Example ==
local spell, _, _, _, _, endTime = UnitCastingInfo("player")
if spell then
local finish = endTime/1000 - GetTime()
ChatFrame1:AddMessage(spell .. ' will be finished casting in ' .. finish .. ' seconds.')
end

====Result====
:If you're currently casting Shadowbolt:

Shadowbolt will be finished casting in 1.234 seconds.


==Details==

Not sure if displayName ever differs from spell.

[[Category:World of Warcraft API]]