GetPlayerContactElement - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:30:51Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:30, 13 February 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{~~DeprecatedWithAlt~~\|getPedContactElement\|}}		{{Deprecated\|getPedContactElement\|}}

	This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.		This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

AlexTMjugador: Visual improvement

2014-06-25T14:26:19Z

Visual improvement

← Older revision		Revision as of 14:26, 25 June 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{~~Deprecated~~}}		{{DeprecatedWithAlt\|getPedContactElement\|}}

	~~Please use [[getPedContactElement]]~~

	This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.		This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

Arran Fortuna at 20:58, 20 April 2011

2011-04-20T20:58:08Z

← Older revision		Revision as of 20:58, 20 April 2011
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	{{Deprecated}}		{{Deprecated}}

			Please use [[getPedContactElement]]

	This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.		This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

Ccw at 14:13, 20 January 2009

2009-01-20T14:13:09Z

← Older revision		Revision as of 14:13, 20 January 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
			{{Deprecated}}
	This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.		This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

Talidan at 17:44, 1 June 2008

2008-06-01T17:44:27Z

← Older revision		Revision as of 17:44, 1 June 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Client~~ function}}		{{Server client function}}
	This function detects the element a player is standing on. This can be a vehicle or an object.		This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

	==Syntax==		==Syntax==

Jbeta: Removed comments, updated page, improved example

2007-08-08T16:59:22Z

Removed comments, updated page, improved example

← Older revision		Revision as of 16:59, 8 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		This function detects the element a player is standing on. This can be a vehicle or an object.
	This function detects the ~~vehicle~~ a player is standing on.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element getPlayerContactElement ( player thePlayer )		element getPlayerContactElement ( player thePlayer )
Line 11:		Line 9:

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~		*'''thePlayer:''' The [[player]] you want to get the [[element]] he is touching from.
	*'''thePlayer:''' The player you want to get the ~~vehicle~~ he is touching from.

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~		Returns an [[object]] or a [[vehicle]] if the player is standing on one, ''false'' if he is touching none or is a invalid player.
	Returns a [[vehicle]] if the player is ~~touching~~ one, ''false'' if he is touching none or is a invalid player.

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This clientside function outputs the name of the vehicle the specified player is standing on, or a message saying he isn't on one.
	This ~~example shows~~ the name of the vehicle the player is standing on~~. It will output~~ '~~false' if he is not.~~
	~~<!-- 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">
	local ~~vehicle~~ = ~~getPlayerContactVehicle~~ ( ~~getLocalPlayer~~() )		function outputContactVehicleMessage ( thePlayer )
	local ~~name~~ = getVehicleName(~~vehicle~~)		local elementStandingOn = getPlayerContactElement( thePlayer )
	outputChatBox(~~tostring~~(~~name)~~)		if getElementType( elementStandingOn ) == "vehicle" then
			local vehicleName = getVehicleName( elementStandingOn )
			outputChatBox( "The player is standing on a " .. vehicleName .. "." )
			else
			outputChatBox( "The player isn't standing on any vehicle." )
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~
	{{Player functions}}		{{Player functions}}

MrJax: New page: NOTOC {{Client function}} This function detects the vehicle a player is standi...

2007-08-07T21:10:16Z

New page: __NOTOC__ {{Client function}}  This function detects the vehicle a player is standi...

New page

__NOTOC__
{{Client function}}

This function detects the vehicle a player is standing on.

==Syntax==

<syntaxhighlight lang="lua">
element getPlayerContactElement ( player thePlayer )
</syntaxhighlight>

===Required Arguments===

*'''thePlayer:''' The player you want to get the vehicle he is touching from.

===Returns===

Returns a [[vehicle]] if the player is touching one, ''false'' if he is touching none or is a invalid player.

==Example==

This example shows the name of the vehicle the player is standing on. It will output 'false' if he is not.

<syntaxhighlight lang="lua">
local vehicle = getPlayerContactVehicle ( getLocalPlayer() )
local name = getVehicleName(vehicle)
outputChatBox(tostring(name))
</syntaxhighlight>

==See Also==

{{Player functions}}