WoW:API IsShiftKeyDown: Difference between revisions

Revision as of 12:06, 4 July 2007

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

Returns true if the shift/ctrl/alt key is currently depressed.

shiftDown = IsShiftKeyDown();
ctrlDown  = IsControlKeyDown();
altDown   = IsAltKeyDown();

none

MODIFIER_STATE_CHANGED - fires when shift/ctrl/alt keys are pressed or released

 if ( IsShiftKeyDown() ) then DoSomething(); end

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-Returns true if the shift key is currently depressed.
+Returns true if the shift/ctrl/alt key is currently depressed.
-  IsShiftKeyDown();
+  shiftDown = IsShiftKeyDown();
+ ctrlDown  = IsControlKeyDown();
+ altDown   = IsAltKeyDown();
-----
+== Arguments ==
-;''Arguments''
+:''none''
-:''none''
+== Returns ==
+:;Boolean : 1 (true) if the given key is currently held down, nil otherwise.
-----
+== Related Events ==
-;''Returns''
+:[[Events/M#MODIFIER_STATE_CHANGED|MODIFIER_STATE_CHANGED]] - fires when shift/ctrl/alt keys are pressed or released
-:;Boolean : 1 (true) if SHIFT is currently held down, nil otherwise.
+== Example ==
-----
-;''Example''
    if ( IsShiftKeyDown() ) then DoSomething(); end
-;''Result''
- true | nil