WoW:Detecting an instant cast spell - Revision history

Move page script: Move page script moved page Detecting an instant cast spell to WoW:Detecting an instant cast spell without leaving a redirect

2023-08-15T04:48:06Z

Move page script moved page Detecting an instant cast spell to Detecting an instant cast spell without leaving a redirect

← Older revision

Revision as of 04:48, 15 August 2023

WoWWiki>Casull: rewrote for clarity, brevity, and correctness; old code misbehaved rarely (or often, in laggy situations)

2008-07-25T07:52:11Z

rewrote for clarity, brevity, and correctness; old code misbehaved rarely (or often, in laggy situations)

Show changes

WoWWiki>Pcj at 18:03, 12 July 2007

2007-07-12T18:03:34Z

← Older revision		Revision as of 18:03, 12 July 2007
Line 1:		Line 1:
	'''I believe this page is out of date. Currently you can detect instant cast spells by listening for a UNIT_SPELLCAST_SUCCEEDED without a preceding UNIT_SPELLCAST_START. If someone could look into this, I'd be grateful, otherwise I'll do it when I get home.'''		{{outdated}}

	== Important note regarding 2.0 changes ==		== Important note regarding 2.0 changes ==
	This article is deprecated since the release of World of Warcraft version 2.0. It is no longer possible to hook the casting, action, targeting, or camera functions in addon code in the manner described below.		This article is deprecated since the release of World of Warcraft version 2.0. It is no longer possible to hook the casting, action, targeting, or camera functions in addon code in the manner described below.

69.248.50.236: Page is out of date - help

2007-07-12T17:42:36Z

Page is out of date - help

← Older revision		Revision as of 17:42, 12 July 2007
Line 1:		Line 1:
			'''I believe this page is out of date. Currently you can detect instant cast spells by listening for a UNIT_SPELLCAST_SUCCEEDED without a preceding UNIT_SPELLCAST_START. If someone could look into this, I'd be grateful, otherwise I'll do it when I get home.'''

	== Important note regarding 2.0 changes ==		== Important note regarding 2.0 changes ==
	This article is deprecated since the release of World of Warcraft version 2.0. It is no longer possible to hook the casting, action, targeting, or camera functions in addon code in the manner described below.		This article is deprecated since the release of World of Warcraft version 2.0. It is no longer possible to hook the casting, action, targeting, or camera functions in addon code in the manner described below.

WoWWiki>Fighteer: Deprecated page.

2007-03-12T19:28:23Z

Deprecated page.

← Older revision		Revision as of 19:28, 12 March 2007
Line 1:		Line 1:
			== Important note regarding 2.0 changes ==
			This article is deprecated since the release of World of Warcraft version 2.0. It is no longer possible to hook the casting, action, targeting, or camera functions in addon code in the manner described below.

			Instead, an entire new set of UNIT_SPELLCAST events have been created that allow addons to detect spellcasting with complete accuracy and without requiring any function hooks.

	== Explanation of SPELLCAST_STOP ==		== Explanation of SPELLCAST_STOP ==

WoWWiki>VoidvectorBot: Robot: converting/fixing HTML

2007-01-20T10:06:09Z

Robot: converting/fixing HTML

← Older revision		Revision as of 10:06, 20 January 2007
Line 15:		Line 15:
	* [[API_TargetUnit]] - Called to change the physical target (in game) to a specific unit		* [[API_TargetUnit]] - Called to change the physical target (in game) to a specific unit
	* [[API_SpellStopTargeting]] - Stops the targeting for the current spell awaiting targeting		* [[API_SpellStopTargeting]] - Stops the targeting for the current spell awaiting targeting
	* [[API_CameraOrSelectOrMoveStart]] - Called when a spell is waiting targeting, and you click on the 3-D world. ~~<i>~~This function is blocked in 1.10.~~</i>~~		* [[API_CameraOrSelectOrMoveStart]] - Called when a spell is waiting targeting, and you click on the 3-D world. ''This function is blocked in 1.10.''
	* OnMouseDown - Hook this event to detect clicks on the 3-D world. ([[XML_User_Interface#Event_Handler_reference]])		* OnMouseDown - Hook this event to detect clicks on the 3-D world. ([[XML_User_Interface#Event_Handler_reference]])

WoWWiki>Hobinbot: demoted headings

2007-01-07T17:49:15Z

demoted headings

← Older revision		Revision as of 17:49, 7 January 2007
Line 1:		Line 1:
	= Explanation of SPELLCAST_STOP =		== Explanation of SPELLCAST_STOP ==

	Unfortunately until more information is exposed to us through events or the API, there isn't currently a very reliable manner to catch instant cast spells being cast by the player, for interaction with the UI. For a spell with a casting time, we get SPELLCAST_START with the spell name and the length of the cast time. When the spell is finished (successfully) casting, we get a SPELLCAST_STOP. In between we could get SPELLCAST_FAILED, SPELLCAST_INTERRUPTED, etc. which help us keep our states straight.		Unfortunately until more information is exposed to us through events or the API, there isn't currently a very reliable manner to catch instant cast spells being cast by the player, for interaction with the UI. For a spell with a casting time, we get SPELLCAST_START with the spell name and the length of the cast time. When the spell is finished (successfully) casting, we get a SPELLCAST_STOP. In between we could get SPELLCAST_FAILED, SPELLCAST_INTERRUPTED, etc. which help us keep our states straight.
Line 5:		Line 5:
	With an instant cast spell, we get one single SPELLCAST_STOP message, with no information (no spell name, no target, nothing). As a result any mod that tries to track something involving these instant cast spells has to guess and play around. I finished writing a Heal Tracking addon that me asures your healing efficiency, and for this purpose-- I needed those instant cast spells. This is the method I used to get them reliably.		With an instant cast spell, we get one single SPELLCAST_STOP message, with no information (no spell name, no target, nothing). As a result any mod that tries to track something involving these instant cast spells has to guess and play around. I finished writing a Heal Tracking addon that me asures your healing efficiency, and for this purpose-- I needed those instant cast spells. This is the method I used to get them reliably.

	== Spellcasting functions and timeline ==		=== Spellcasting functions and timeline ===

	We have the following functions involved in the casting/targeting process:		We have the following functions involved in the casting/targeting process:
Line 20:		Line 20:
	Keep in mind when looking at this world, there are plenty of combinations that need to be considered when trying to detect instant cast spells. I try to take these into consideration with my hooks.		Keep in mind when looking at this world, there are plenty of combinations that need to be considered when trying to detect instant cast spells. I try to take these into consideration with my hooks.

	= Implementing this system =		== Implementing this system ==

	== Caveats ==		=== Caveats ===

	This code will grab every spell that is being cast as well as every action that is being used on the client side. Due to global cooldowns and other timing the overhead we incur here is very small, and I've done everything I can to make the code efficient and to ensure that the original functions are called as quickly as possible.		This code will grab every spell that is being cast as well as every action that is being used on the client side. Due to global cooldowns and other timing the overhead we incur here is very small, and I've done everything I can to make the code efficient and to ensure that the original functions are called as quickly as possible.
Line 28:		Line 28:
	If you are interested in grabbing just a subset of instant cast functions, you can put them in a localized table and use that lookup to determine whether or not you change the MyMod_Spell variable.		If you are interested in grabbing just a subset of instant cast functions, you can put them in a localized table and use that lookup to determine whether or not you change the MyMod_Spell variable.

	== Provide a custom tooltip ==		=== Provide a custom tooltip ===

	As much as I wish it wasn't necessary, we need some way to glean the spell information. This step is somewhat optional if you have your own tooltip to look this up, but I like my functions to be somewhat complete in providing accurate information. Let's create a tooltip in our XML file so we can use it later.		As much as I wish it wasn't necessary, we need some way to glean the spell information. This step is somewhat optional if you have your own tooltip to look this up, but I like my functions to be somewhat complete in providing accurate information. Let's create a tooltip in our XML file so we can use it later.
Line 43:		Line 43:
	</GameTooltip>		</GameTooltip>

	== Variables ==		=== Variables ===

	We could use some variables here to store information as we progress, so we'll define the following in the LUA body:		We could use some variables here to store information as we progress, so we'll define the following in the LUA body:
Line 54:		Line 54:
	MyMod_Target = nil		MyMod_Target = nil

	== Hooking the casting functions ==		=== Hooking the casting functions ===

	=== CastSpell ===		==== CastSpell ====

	MyMod_oldCastSpell = CastSpell;		MyMod_oldCastSpell = CastSpell;
Line 80:		Line 80:
	CastSpell = MyMod_newCastSpell		CastSpell = MyMod_newCastSpell

	=== CastSpellByName ===		==== CastSpellByName ====
	Corrected syntax for 1.10 patch.		Corrected syntax for 1.10 patch.

Line 107:		Line 107:
	CastSpellByName = MyMod_newCastSpellByName		CastSpellByName = MyMod_newCastSpellByName

	=== UseAction ===		==== UseAction ====
	MyMod_oldUseAction = UseAction		MyMod_oldUseAction = UseAction
	function MyMod_newUseAction(a1, a2, a3)		function MyMod_newUseAction(a1, a2, a3)
Line 130:		Line 130:
	UseAction = MyMod_newUseAction		UseAction = MyMod_newUseAction

	== Hooking the targeting functions ==		=== Hooking the targeting functions ===

	=== SpellTargetUnit ===		==== SpellTargetUnit ====

	This one is nice, and provides us with a good framwork because of its limitations. Since SpellTargetUnit can ONLY be called after a spellcast has been issued, we can always be sure of who we're casting the spell on. Even if ClearTarget is used, it just triggers the need to target after casting.		This one is nice, and provides us with a good framwork because of its limitations. Since SpellTargetUnit can ONLY be called after a spellcast has been issued, we can always be sure of who we're casting the spell on. Even if ClearTarget is used, it just triggers the need to target after casting.
Line 155:		Line 155:
	SpellTargetUnit = MyMod_newSpellTargetUnit		SpellTargetUnit = MyMod_newSpellTargetUnit

	=== TargetUnit ===		==== TargetUnit ====

	This is the same code from SpellTargetUnit, with the names changed to protect the innocent.		This is the same code from SpellTargetUnit, with the names changed to protect the innocent.
Line 178:		Line 178:
	TargetUnit = MyMod_newTargetUnit		TargetUnit = MyMod_newTargetUnit

	=== SpellStopTargeting ===		==== SpellStopTargeting ====

	All we need to do here is clear MyMod_Spell to ensure we keep our state clean.		All we need to do here is clear MyMod_Spell to ensure we keep our state clean.
Line 194:		Line 194:
	SpellStopTargeting = MyMod_newSpellStopTargeting		SpellStopTargeting = MyMod_newSpellStopTargeting

	=== CameraOrSelectOrMoveStart ===		==== CameraOrSelectOrMoveStart ====

	After the 1.10 patch, CameraOrSelectOrMoveStart may no longer be hooked by custom UI mods. The below code is preserved for historical purposes, but will no longer work.		After the 1.10 patch, CameraOrSelectOrMoveStart may no longer be hooked by custom UI mods. The below code is preserved for historical purposes, but will no longer work.
Line 222:		Line 222:
	CameraOrSelectOrMoveStart = MyMod_newCameraOrSelectOrMoveStart		CameraOrSelectOrMoveStart = MyMod_newCameraOrSelectOrMoveStart

	== Hooking the mouse click ==		=== Hooking the mouse click ===
	In the 1.10 patch, CameraOrSelectOrMoveStart can no longer be hooked by the user interface. Attempting to call the hooked function will cause your addon to be reported as blocked by the game. The solution to this problem is to hook the mouse click itself. Since the user clicks on the screen to target a spell, all we have to do is add a call to our custom script when this occurs.		In the 1.10 patch, CameraOrSelectOrMoveStart can no longer be hooked by the user interface. Attempting to call the hooked function will cause your addon to be reported as blocked by the game. The solution to this problem is to hook the mouse click itself. Since the user clicks on the screen to target a spell, all we have to do is add a call to our custom script when this occurs.

	=== OnMouseDown ===		==== OnMouseDown ====

	function myMouseDown()		function myMouseDown()
Line 250:		Line 250:
	end		end

	== Watching for SPELLCAST events ==		=== Watching for SPELLCAST events ===

	In your OnLoad handler, register the following events:		In your OnLoad handler, register the following events:

WoWWiki>Kobel: /* SpellStopTargeting */

2006-08-25T08:32:15Z

SpellStopTargeting

← Older revision		Revision as of 08:32, 25 August 2006
Line 105:		Line 105:
	end		end
	end		end
	CastSpellByName = ~~MyMod_CastSpellByName~~		CastSpellByName = MyMod_newCastSpellByName

	=== UseAction ===		=== UseAction ===
Line 182:		Line 182:
	All we need to do here is clear MyMod_Spell to ensure we keep our state clean.		All we need to do here is clear MyMod_Spell to ensure we keep our state clean.

	~~MyMod_SpellStopTargeting~~ = SpellStopTargeting		MyMod_oldSpellStopTargeting = SpellStopTargeting
	function MyMod_newSpellStopTargeting()		function MyMod_newSpellStopTargeting()
	MyMod_oldSpellStopTargeting()		MyMod_oldSpellStopTargeting()
Line 193:		Line 193:
	end		end
	SpellStopTargeting = MyMod_newSpellStopTargeting		SpellStopTargeting = MyMod_newSpellStopTargeting

	=== CameraOrSelectOrMoveStart ===		=== CameraOrSelectOrMoveStart ===

WoWWiki>Archivar: /* OnMouseDown */

2006-05-22T10:36:37Z

OnMouseDown

← Older revision		Revision as of 10:36, 22 May 2006
Line 231:		Line 231:
	local targetName;		local targetName;

	if MyMod_Spell and ~~ExistsName~~("mouseover") then		if MyMod_Spell and UnitExists("mouseover") then
	targetName = UnitName("mouseover")		targetName = UnitName("mouseover")
	end		end

WoWWiki>Jbcc: /* OnMouseDown */ cleaned code sample slightly

2006-04-03T19:02:30Z

OnMouseDown: cleaned code sample slightly

← Older revision		Revision as of 19:02, 3 April 2006
Line 226:		Line 226:

	=== OnMouseDown ===		=== OnMouseDown ===

	~~WorldFrame:SetScript("OnMouseDown", myMouseDown)~~		function myMouseDown()

	function myMouseDown()
	if arg1 == "LeftButton" then		if arg1 == "LeftButton" then
	local targetName ~~= nil~~		local targetName;

	if MyMod_Spell and ~~UnitName~~("mouseover") then		if MyMod_Spell and ExistsName("mouseover") then
	targetName = UnitName("mouseover")		targetName = UnitName("mouseover")
	end		end
Line 243:		Line 241:
	end		end
	end		end
			end

			local oldFunc = WorldFrame:GetScript("OnMouseDown");
			if ( oldFunc ) then --hook the old function if one already exists
			WorldFrame:SetScript("OnMouseDown", function() oldFunc(); myMouseDown(); end );
			else
			WorldFrame:SetScript("OnMouseDown", myMouseDown);
	end		end