API IsModifiedClick

From Wowpedia
Jump to: navigation, search

Indicates whether the modifier keys for the selected action are pressed.

isHeld = IsModifiedClick("action")

Arguments

action 
String - The action to check for. Actions defined by Blizzard:
AUTOLOOTTOGGLE, CHATLINK, COMPAREITEMS, DRESSUP, FOCUSCAST, OPENALLBAGS, PICKUPACTION, QUESTWATCHTOGGLE, SELFCAST, SHOWITEMFLYOUT, SOCKETITEM, SPLITSTACK, STICKYCAMERA, TOKENWATCHTOGGLE

Returns

isHeld 
boolean - true if the modifier is being held, false otherwise

Details

Despite the name, this function does not have anything to do with mouse buttons and can be used at any time to check the state of a modifier key; it is not limited to use in click-related scripts.

This function can be called with no argument to check whether *any* modifier key is pressed; in this case it behaves just like IsModifierKeyDown.

Patch history

Patch 2.2 (2007-09-25): Added.

See Also