OnElementClicked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for server events)
(Example added)
Line 19: Line 19:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example prints type of the element you clicked to chatbox when you click it.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function elementClicked( theButton, theState, thePlayer )
blah()
    if theButton == "left" and theState == "down" then -- if left mouse button was pressed down
--This line does this...
        outputChatBox( "You clicked " .. getElementType( source ), thePlayer ) -- print the element type to players chatbox
mooo
    end
end
addEventHandler( "onElementClicked", getRootElement(), elementClicked ) -- add a handler function for the event
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Element events}}
{{See also/Server event|Element events}}
[[Category:Needs Example]]

Revision as of 18:04, 3 February 2008

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 mousebutton 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

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

Example

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", getRootElement(), elementClicked ) -- add a handler function for the event

See Also

Element events


Event functions