onElementClicked

Client-side

Server-side

Shared

This event is triggered when an element is clicked on by the client. These events can only trigger when the client has its cursor enabled. It triggers for all three mousebuttons in both their up and down states.

Parameters

string mouseButton, string buttonState, player playerWhoClicked, float clickPosX, float clickPosY, float clickPosZ

mouseButton: a string representing the mouse button that was clicked. This might be left, middle or right.

buttonState: a string representing what state the button clicked is in. This might be up or down.

playerWhoClicked: the player that clicked on the element.

clickPosX: the X position in the world the player clicked at.

clickPosY: the Y position in the world the player clicked at.

clickPosZ: the Z position in the world the player clicked at.

Source

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

Code Examples

server

This example prints type of the element you clicked to chatbox when you click it.

function elementClicked( theButton, theState, thePlayer )
    if theButton == "left" and theState == "down" then -- if left mouse button was pressed down
        outputChatBox( "You clicked " .. getElementType( source ), thePlayer ) -- print the element type to players chatbox
    end
end
addEventHandler( "onElementClicked", root, elementClicked ) -- add a handler function for the event

onElementClicked

Parameters

Source

Code Examples

See Also

Element Events

Element Functions

Reference