OnPlayerClick: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Server event}}
This event is triggered when a player clicks using the mouse cursor.


__NOTOC__
==Parameters==
This event is triggered when a player clicks an element with the mouse cursor.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onPlayerClick ( string button, string state, element clickedElement, float posX, float posY, float posZ, float 2DposX, float 2DposY )
string mouseButton, string buttonState, element clickedElement, float worldPosX, float worldPosY, float worldPosZ, float screenPosX, float screenPosY
</syntaxhighlight>  
</syntaxhighlight>  
*'''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 [[event system#Event source|source]] of this event is the [[player]] that clicked.


==Example==  
==Example==  
This example does...
This example outputs the state of the button they just pressed.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function outputClick(mouseButton, buttonState)
blabhalbalhb --abababa
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}}

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"