OnPlayerClick - Revision history

Mkl: /* Use of predefined variable in example */

2022-12-31T14:58:53Z

Use of predefined variable in example

← Older revision		Revision as of 14:58, 31 December 2022
Line 23:		Line 23:
	This example outputs the state of the button they just pressed.		This example outputs the state of the button they just pressed.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function outputClick(mouseButton,buttonState)		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.		outputChatBox("Your "..mouseButton.." mouse button is now "..buttonState,source,255,255,0) -- output the state of the button they just pressed.
	end		end
	addEventHandler("onPlayerClick",~~getRootElement()~~,outputClick) -- When a player clicks trigger the outputClick function		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}}

Botder at 02:59, 27 September 2018

2018-09-27T02:59:56Z

← Older revision		Revision as of 02:59, 27 September 2018
Line 29:		Line 29:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Player events}}
	~~===~~Player events~~===~~
	~~{{Player_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

Botder at 02:12, 27 September 2018

2018-09-27T02:12:45Z

← Older revision		Revision as of 02:12, 27 September 2018
Line 29:		Line 29:
	</syntaxhighlight>		</syntaxhighlight>

	{{See ~~also/Server event\|~~Player events}}		==See Also==
			===Player events===
			{{Player_events}}
			===Event functions===
			{{Event functions}}

Myonlake: /* Parameters */

2018-04-02T21:41:03Z

Parameters

← Older revision		Revision as of 21:41, 2 April 2018
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==

Myonlake: /* Parameters */

2018-04-02T21:27:17Z

Parameters

← Older revision		Revision as of 21:27, 2 April 2018
Line 11:		Line 11:
	*'''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==

Ca11um: Added an example.

2010-06-05T03:44:23Z

Added an example.

← Older revision		Revision as of 03:44, 5 June 2010
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",getRootElement(),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]]~~

D0c: See Also for server events

2008-01-12T17:47:35Z

Jbeta at 23:41, 4 January 2008

2008-01-04T23:41:43Z

← Older revision		Revision as of 23:41, 4 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server event}}		{{Server event}}
	This event is triggered when a player clicks ~~on an element~~.		This event is triggered when a player clicks using the mouse cursor.

	==Parameters==		==Parameters==
Line 17:		Line 17:
	*'''screenPosY''': The Y position on the screen the player clicked on		*'''screenPosY''': The Y position on the screen the player clicked on

	~~<!-- Add the event's source in the section below -->~~
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the [[player]] that clicked.		The [[event system#Event source\|source]] of this event is the [[player]] that clicked.

Talidan at 23:40, 4 January 2008

2008-01-04T23:40:58Z

← Older revision		Revision as of 23:40, 4 January 2008
Line 12:		Line 12:
	*'''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
	*'''~~worldPosX~~''': The Y position in the world the player clicked on		*'''worldPosY''': The Y position in the world the player clicked on
	*'''~~worldPosX~~''': 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

ChrML at 05:45, 30 December 2007

2007-12-30T05:45:56Z

← Older revision		Revision as of 05:45, 30 December 2007
Line 1:		Line 1:
	{{~~Needs_Checking\|Lua and MTA do not like 2DposX and 2DposY stored varibles by the~~ event}}		__NOTOC__
			{{Server event}}
			This event is triggered when a player clicks on an element.

	~~[[Category:Incomplete Event]]~~		==Parameters==
			<syntaxhighlight lang="lua">
			string mouseButton, string buttonState, element clickedElement, float worldPosX, float worldPosY, float worldPosZ, float screenPosX, float screenPosY
			</syntaxhighlight>

	~~__NOTOC__~~		*'''mouseButton''': A string representing the mousebutton that was pressed. Value can be ''left'', ''middle'' or ''right''.
	This ~~event~~ is ~~triggered when a~~ player ~~clicks an element with~~ the ~~mouse cursor.~~		*'''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
			*'''worldPosX''': The Y position in the world the player clicked on
			*'''worldPosX''': 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

	==~~Syntax~~==		<!-- Add the event's source in the section below -->
	~~<syntaxhighlight lang="lua">~~		==Source==
	~~void onPlayerClick ( string button, string state, element clickedElement, float posX, float posY, float posZ, float 2DposX, float 2DposY )~~		The [[event system#Event source\|source]] of this event is the [[player]] that clicked.
	~~</syntaxhighlight>~~

	==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...
	~~blabhalbalhb --abababa~~		blah()
	--This line does this...		--This line does this...
	mooo		mooo
	</syntaxhighlight>		</syntaxhighlight>

			==See Also==
			{{Event_functions}}
			[[Category:Needs Example]]

← Older revision		Revision as of 17:47, 12 January 2008
Line 31:		Line 31:
	</syntaxhighlight>		</syntaxhighlight>

	~~==See Also==~~		{{See also/Server event\|Player events}}
	{{~~Event_functions~~}}
	[[Category:Needs Example]]		[[Category:Needs Example]]