WoW:API TurnOrActionStop: Difference between revisions

Latest revision as of 04:47, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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

TurnOrActionStop()

()

nil

This function is called when right clicking in the 3D world. Most usefull it can initiate attack on the selected unit if no move occurs.

When used alone, can cancel a "mouseturn" started by a call to TurnOrActionStart.

IMPORTANT: The normal restrictions regarding hardware event initiations still apply to anything this function might do.

@@ Line 1: / Line 1: @@
-This is triggered by releasing the right mousebutton.  If keystate up is true of that button then this fires.  Anything contained within this function will then also fire.
+{{wowapi}}{{protectedapi|1.10|}}
-Additions can be made to this functions via temporary override, as follows ...
+End "Right click" in the 3D game world.
-function AddOn_OnLoad()
+ TurnOrActionStop()
-Override_TurnOrActionStop=TurnOrActionStop
+== Parameters ==
-TurnOrActionStop=Override
+=== Arguments ===
-end
+:()
-function Override()
+=== Returns ===
-[Do stuff.]
+:''nil''
-Override_TurnOrActionStop(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9)
-end
-So we could add the notice; "Right mouse button released!" 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. Most usefull it can initiate attack on the selected unit if no move occurs.
-Override_TurnOrActionStop(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9)
-end
+: When used alone, can cancel a "mouseturn" started by a call to [[API TurnOrActionStart|TurnOrActionStart]].
+: IMPORTANT: The normal restrictions regarding hardware event initiations still apply to anything this function might do.
+__NOTOC__