# Mouse Clicked

Grammar — Player player clicks button|Button mouse button down|up/down.
Flags — Native | Event

Only register for this event when you absolutely need it, as it will generate network traffic from all players for every mouse click they make. This event fires when a player clicks a mouse button. Use “Mouse Clicked Button” to get the button that was clicked. Use “Mouse Clicked UI Pos X” and “Mouse Clicked UI Pos Y” to get the UI X,Y position where the player clicked the mouse. Use “Mouse Clicked World Pos X”, “Mouse Clicked World Pos Y”, and “Mouse Clicked World Pos Z” to get the X,Y,Z world position where the player clicked the mouse. Use “Alt Key Pressed”, “Control Key Pressed”, and “Shift Key Pressed” to find out what modifier keys were pressed.

# Arguments

• int — Player
• int [ preset::MouseButton ] — Mouse Button
• bool [ preset::UpDownOption ] — Down

Returns — void

native void TriggerAddEventMouseClicked(
	trigger t,
	int player,
	int mouseButton,
	bool down,
);

# Event parameters

• Triggering Game User — EventGameUser
• Triggering Player — EventPlayer
• Control Key Pressed — EventKeyControl
• Alt Key Pressed — EventKeyAlt
• Shift Key Pressed — EventKeyShift
• Mouse Clicked Button — EventMouseClickedButton
• Mouse Clicked UI Pos X — EventMouseClickedPosXUI
• Mouse Clicked UI Pos Y — EventMouseClickedPosYUI
• Mouse Clicked World Pos X — EventMouseClickedPosXWorld
• Mouse Clicked World Pos Y — EventMouseClickedPosYWorld
• Mouse Clicked World Pos Z — EventMouseClickedPosZWorld

# Related

Category: UI / Input

• [F] — void — Key Pressed — ( TriggerAddEventKeyPressed )
• [F] — void — Hotkey Pressed — ( TriggerAddEventHotkeyPressed )
• [F] — void — Button Pressed — ( TriggerAddEventButtonPressed )
• [F] — void — Mouse Clicked — ( TriggerAddEventMouseClicked )
• [F] — void — Mouse Moved — ( TriggerAddEventMouseMoved )
• [F] — void — Mouse Wheel — ( TriggerAddEventMouseWheel )
• [F] — string [ gamelink::Button ] — Button Pressed — ( EventButtonPressed )
• [F] — int [ preset::Key ] — Key Pressed — ( EventKeyPressed )
• [F] — int [ preset::Key ] — Hotkey Pressed — ( EventHotkeyPressed )
• [F] — bool — Control Key Pressed — ( EventKeyControl )
• [F] — bool — Alt Key Pressed — ( EventKeyAlt )
• [F] — bool — Shift Key Pressed — ( EventKeyShift )
• [F] — int [ preset::MouseButton ] — Mouse Clicked Button — ( EventMouseClickedButton )
• [F] — int — Mouse Clicked UI Pos X — ( EventMouseClickedPosXUI )
• [F] — int — Mouse Clicked UI Pos Y — ( EventMouseClickedPosYUI )
• [F] — fixed — Mouse Clicked World Pos X — ( EventMouseClickedPosXWorld )
• [F] — fixed — Mouse Clicked World Pos Y — ( EventMouseClickedPosYWorld )
• [F] — fixed — Mouse Clicked World Pos Z — ( EventMouseClickedPosZWorld )
• [F] — int — Mouse Moved UI Pos X — ( EventMouseMovedPosXUI )
• [F] — int — Mouse Moved UI Pos Y — ( EventMouseMovedPosYUI )
• [F] — fixed — Mouse Moved World Pos X — ( EventMouseMovedPosXWorld )
• [F] — fixed — Mouse Moved World Pos Y — ( EventMouseMovedPosYWorld )
• [F] — fixed — Mouse Moved World Pos Z — ( EventMouseMovedPosZWorld )
• [F] — fixed — Mouse Wheel Spin — ( EventMouseWheelSpin )

# Examples

# campaigns/liberty.sc2campaign

— MapScript.galaxy

// L15031
TriggerAddEventMouseClicked(gt_PinboardItemBack, c_playerAny, c_mouseButtonNone, true)

// L37418
TriggerAddEventMouseClicked(gt_TVNewsBack, c_playerAny, c_mouseButtonNone, true)

// L15031
TriggerAddEventMouseClicked(gt_PinboardItemBack, c_playerAny, c_mouseButtonNone, true)

// L37418
TriggerAddEventMouseClicked(gt_TVNewsBack, c_playerAny, c_mouseButtonNone, true)

// L9960
TriggerAddEventMouseClicked(gt_CampaignIntroCinematicContinue, c_playerAny, c_mouseButtonNone, true)

// L9960
TriggerAddEventMouseClicked(gt_CampaignIntroCinematicContinue, c_playerAny, c_mouseButtonNone, true)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L6564
TriggerAddEventMouseClicked(libVCUI_gt_PU_ArmyRotateUnitStart, c_playerAny, c_mouseButtonLeft, true)

// L6618
TriggerAddEventMouseClicked(libVCUI_gt_PU_ArmyRotateUnitEnd, c_playerAny, c_mouseButtonNone, false)

# mods/frontiers.sc2mod

— Lib6CB3363F.galaxy

// L1564
TriggerAddEventMouseClicked(lib6CB3363F_gt_MouseRightClickPressedMelee, c_playerAny, c_mouseButtonRight, true)

// L1606
TriggerAddEventMouseClicked(lib6CB3363F_gt_MouseLeftClickPressedFireWeapon, c_playerAny, c_mouseButtonLeft, true)

// L1646
TriggerAddEventMouseClicked(lib6CB3363F_gt_MouseLeftClickReleased, c_playerAny, c_mouseButtonLeft, false)

# mods/heroesdata.stormmod

— GameDataHelperLib.galaxy

// L22994
TriggerAddEventMouseClicked(libGDHL_gt_HeroTinkerDethLazorLeftClick, lv_player, c_mouseButtonLeft, true)

# mods/heromods/alarak.stormmod

— LibHALA.galaxy

// L166
TriggerAddEventMouseClicked(libHALA_gt_HeroAlarakDeadlyChargeCasterClicked, lv_player, c_mouseButtonLeft, true)

# mods/heromods/chogall.stormmod

— LibHCHO.galaxy

// L1526
TriggerAddEventMouseClicked(libHCHO_gt_SurgingFistExecuteChargetomouse, lv_playerID, c_mouseButtonLeft,true)

// L1783
TriggerAddEventMouseClicked(libHCHO_gt_SurgingFistExecuteChargetomouse, lv_gallPlayer, c_mouseButtonLeft,true)

# mods/heromods/yrel.stormmod

— LibHYRL.galaxy

// L118
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelVindicationPlayerClicked, lv_playerID, c_mouseButtonLeft,true)

// L119
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelRighteousHammerPlayerClicked, lv_playerID, c_mouseButtonLeft,true)

// L120
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelAvengingWrathPlayerClicked, lv_playerID, c_mouseButtonLeft,true)

// L154
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelVindicationPlayerClicked, lv_playerID, c_mouseButtonLeft,true)

// L155
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelRighteousHammerPlayerClicked, lv_playerID, c_mouseButtonLeft,true)

// L156
TriggerAddEventMouseClicked(libHYRL_gt_HeroYrelAvengingWrathPlayerClicked, lv_playerID, c_mouseButtonLeft,true)