IsModifiedClick

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 2.2.0 / 1.13.2

Returns true if the modifier key needed for an an action is 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 changes

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

See Also

• GetModifiedClick
• SetModifiedClick
• IsModifierKeyDown