OnElementClicked: Difference between revisions
Jump to navigation
Jump to search
JonChappell (talk | contribs) No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server event}} | |||
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== | |||
== | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string mouseButton, string buttonState, player playerWhoClicked, float clickPosX, float clickPosY, float clickPosZ | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''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 [[event system#Event source|source]] of this event is the [[element]] that got clicked by the player. | |||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | |||
This example does... | 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... | --This line does... | ||
blah() | |||
--This line does this... | --This line does this... | ||
mooo | mooo | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | |||
{{Event_functions}} | |||
[[Category:Needs Example]] | |||
Revision as of 04:49, 30 December 2007
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 does...
--This line does... blah() --This line does this... mooo