OnPlayerClick: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for server events)
 
(5 intermediate revisions by 3 users not shown)
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''mouseButton''': A string representing the mousebutton that was pressed. Value can be ''left'', ''middle'' or ''right''.
*'''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''.
*'''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.
*'''clickedElement''': the [[element]] the [[player]] clicked on. This value is ''nil'' if none.
*'''worldPosX''': The X position in the world the player clicked on
*'''worldPosX''': the X position in the world the [[player]] clicked on.
*'''worldPosY''': The Y 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
*'''worldPosZ''': the Z position in the world the [[player]] clicked on.
*'''screenPosX''': The X position on the screen 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
*'''screenPosY''': the Y position on the screen the [[player]] clicked on.


==Source==
==Source==
Line 21: Line 21:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs the state of the button they just pressed.
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 outputClick(mouseButton, buttonState)
blah()
outputChatBox("Your "..mouseButton.." mouse button is now "..buttonState,source,255,255,0) -- output the state of the button they just pressed.
--This line does this...
end
mooo
addEventHandler("onPlayerClick", root, outputClick) -- When a player clicks trigger the outputClick function
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 14:58, 31 December 2022

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

The source of this event is the player that clicked.

Example

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


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerClick?oldid=75908"