onPlayerClick | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

onPlayerClick

Client-side
Server-side
Shared

This event is triggered when a player clicks using the mouse cursor.

Parameters

string mouseButton, string buttonState, element clickedElement, float worldPosX, float worldPosY, float worldPosZ, float screenPosX, float screenPosY
  • mouseButton: a string representing the mouse button that was pressed. Value can be left, middle or right.
  • buttonState: a string representing the button state. Value can be up or down.
  • clickedElement: the element the player clicked on. This value is nil if none.
  • worldPosX: the X position in the world the player clicked on.
  • worldPosY: the Y position in the world the player clicked on.
  • worldPosZ: the Z position in the world the player clicked on.
  • screenPosX: the X position on the screen the player clicked on.
  • screenPosY: the Y position on the screen the player clicked on.

Source

element: The source of this event is the player that clicked.

Code Examples

server

This example outputs the state of the button they just pressed.

function outputClick(mouseButton, buttonState)
  outputChatBox("Your "..mouseButton.." mouse button is now "..buttonState,source,255,255,0) -- output the state of the button they just pressed.
end
addEventHandler("onPlayerClick", root, outputClick) -- When a player clicks trigger the outputClick function

See Also

Player Events
Player Functions
Reference