FANDOM


 
(Note)
 
(15 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<center>'''IsShiftKeyDown''' ''-Documentation by AlexanderYoshi-''</center>
+
{{wowapi}} __NOTOC__
  +
Returns true if the shift/ctrl/alt key is currently depressed.
   
Returns true if the shift key is currently depressed.
+
shiftDown = IsShiftKeyDown();
  +
ctrlDown = IsControlKeyDown();
  +
altDown = IsAltKeyDown();
   
IsShiftKeyDown();
+
== Arguments ==
  +
:''none''
   
----
+
== Returns ==
;''Arguments''
+
:;Boolean : 1 (true) if the given key is currently held down, nil otherwise.
   
:''none''
+
== Related Events ==
  +
:[[Events/M#MODIFIER_STATE_CHANGED|MODIFIER_STATE_CHANGED]] - fires when shift/ctrl/alt keys are pressed or released
   
----
+
== Example ==
;''Returns''
 
   
:;Boolean
 
 
----
 
;''Example''
 
 
if ( IsShiftKeyDown() ) then DoSomething(); end
 
if ( IsShiftKeyDown() ) then DoSomething(); end
   
;''Result''
+
== Note ==
true | false
 
 
----
 
;''Description''
 
   
: Returns true if the shift key is currently depressed.
+
These functions will only return true if one of the keys is considered a modifier. If the code executing is started with Shift/Control/Alt as part of the key binding, it will return nil.
  +
[[User:Govtgeek|Govtgeek]] ([[User talk:Govtgeek|talk]]) 01:30, 8 March 2009 (UTC)
   
----
+
These functions actually return the value 1 at this time (when evaluated true).  After the WoD 6.0 API goes into affect the values returned will be boolean true and false (nil).
{{Template:WoW API}}
 

Latest revision as of 03:14, August 21, 2014

WoW API < IsShiftKeyDown

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

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

Arguments Edit

none

Returns Edit

Boolean 
1 (true) if the given key is currently held down, nil otherwise.

Related Events Edit

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

Example Edit

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

Note Edit

These functions will only return true if one of the keys is considered a modifier. If the code executing is started with Shift/Control/Alt as part of the key binding, it will return nil. Govtgeek (talk) 01:30, 8 March 2009 (UTC)

These functions actually return the value 1 at this time (when evaluated true).  After the WoD 6.0 API goes into affect the values returned will be boolean true and false (nil).

Community content is available under CC-BY-SA unless otherwise noted.