WoW:API TurnOrActionStart: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
This is triggered by pressing down on the right mousebutton.  If keystate down is true of that button then this fires.  Anything contained within this function will then also fire.
<center>'''TurnOrActionStart'''</center>


Additions can be made to this functions via temporary override, as follows ...
Begin "Right click" in the 3D game world.


function AddOn_OnLoad()
TurnOrActionStart()
Override_TurnOrActionStart=TurnOrActionStart
== Parameters ==
TurnOrActionStart=Override
=== Arguments ===
end
:()


function Override()
=== Returns ===
[Do stuff.]
:<i>nil</i>
Override_TurnOrActionStart(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9)
end


So we could add the notice; "Right mouse button is down!" into the function.


function Override()
== Details ==
DEFAULT_CHAT_FRAME:AddMessage("Right mouse button is down!")
: This function is called when right clicking in the 3D world.
Override_TurnOrActionStart(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9)
end


[[Category:API Functions|TurnOrActionStart]]
: Calling this function clears the "mouseover" unit.
 
: If you hook this function be sure to grab UnitName("mouseover") or target the "mouseover" unit because once the original function is called, the "mouseover" will not have a value.
 
: When used alone, puts you into a "mouseturn" mode until [[API TurnOrActionStop|TurnOrActionStop]] is called.
 
: IMPORTANT: The normal restrictions regarding hardware event initiations still apply to anything this function might do.
 
----
__NOTOC__
{{Template:WoW API}}
[[Category:API Action Functions|TurnOrActionStart]]
[[Category:API Action Functions|TurnOrActionStart]]
[[Category:API Movement Functions|TurnOrActionStart]]
[[Category:API Camera Functions|TurnOrActionStart]]

Revision as of 02:21, 20 September 2005

TurnOrActionStart

Begin "Right click" in the 3D game world.

TurnOrActionStart()

Parameters

Arguments

()

Returns

nil


Details

This function is called when right clicking in the 3D world.
Calling this function clears the "mouseover" unit.
If you hook this function be sure to grab UnitName("mouseover") or target the "mouseover" unit because once the original function is called, the "mouseover" will not have a value.
When used alone, puts you into a "mouseturn" mode until TurnOrActionStop is called.
IMPORTANT: The normal restrictions regarding hardware event initiations still apply to anything this function might do.

Template:WoW API