GetPlayerOccupiedVehicle - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:13:56Z

Changed "DeprecatedWithAlt" template to "Deprecated"

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

	This function gets the [[vehicle]] that the player is currently in, if any.		This function gets the [[vehicle]] that the player is currently in, if any.

AlexTMjugador: Visual improvement

2014-06-25T14:27:54Z

Visual improvement

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

	~~Please use [[getPedOccupiedVehicle]]~~

	This function gets the [[vehicle]] that the player is currently in, if any.		This function gets the [[vehicle]] that the player is currently in, if any.

Arran Fortuna at 20:59, 20 April 2011

2011-04-20T20:59:15Z

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

			Please use [[getPedOccupiedVehicle]]

	This function gets the [[vehicle]] that the player is currently in, if any.		This function gets the [[vehicle]] that the player is currently in, if any.

Ccw at 14:13, 20 January 2009

2009-01-20T14:13:55Z

← 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 gets the [[vehicle]] that the player is currently in, if any.		This function gets the [[vehicle]] that the player is currently in, if any.

Arc: Removed the client-specific syntax. Client side function also has a player argument.

2007-11-24T13:56:47Z

Removed the client-specific syntax. Client side function also has a player argument.

← Older revision		Revision as of 13:56, 24 November 2007
Line 4:		Line 4:

	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( player thePlayer )</syntaxhighlight>		<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( player thePlayer )</syntaxhighlight>

Line 12:		Line 11:
	===Returns===		===Returns===
	Returns the vehicle that the specified player is in, or ''false'' if the player is not in a vehicle or is an invalid player.		Returns the vehicle that the specified player is in, or ''false'' if the player is not in a vehicle or is an invalid player.
	~~</section>~~
	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( )</syntaxhighlight>~~

	~~===Required Arguments===~~
	~~''None''~~

	~~===Returns===~~
	~~Returns the vehicle that the local player is in, or ''false'' if the player is not in a vehicle.~~
	~~</section>~~

	==Example==		==Example==
	When a player enters the 'vehiclename' command and is currently in a vehicle, this example outputs the name of the vehicle.		When a player enters the 'vehiclename' command and is currently in a vehicle, this example outputs the name of the vehicle.
	<section name="Server" class="~~server~~" show="true">		<section name="Server and client" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showVehicleName ( thePlayer )		function showVehicleName ( thePlayer )
Line 33:		Line 22:
	outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )		outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
	end		end
	~~end~~
	~~addCommandHandler ( "vehiclename", showVehicleName )~~
	~~</syntaxhighlight>~~
	~~</section>~~

	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">~~
	~~function showVehicleName ( thePlayer )~~
	~~local theVehicle = getPlayerOccupiedVehicle ( )~~
	~~if ( theVehicle ) then~~
	~~local vehicleName = getVehicleName ( theVehicle )~~
	~~outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )~~
	~~end~~
	end		end
	addCommandHandler ( "vehiclename", showVehicleName )		addCommandHandler ( "vehiclename", showVehicleName )

Arc at 14:44, 19 August 2007

2007-08-19T14:44:00Z

← Older revision		Revision as of 14:44, 19 August 2007
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns the vehicle that the player is in, or ''false'' if the player is not in a vehicle or is an invalid player.		Returns the vehicle that the specified player is in, or ''false'' if the player is not in a vehicle or is an invalid player.
	</section>		</section>
	<section name="Client" class="client">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( )</syntaxhighlight>		<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~thePlayer~~'~~'': The [[player]] whose vehicle you're looking up.~~		''None''

	===Returns===		===Returns===
	Returns the vehicle that the player is in, or ''false'' if the player is not in a vehicle ~~or is an invalid player~~.		Returns the vehicle that the local player is in, or ''false'' if the player is not in a vehicle.
	</section>		</section>

	==Example==		==Example==
	~~This~~ example outputs the ~~vehicle~~ name of the vehicle ~~if the player is currently occupying one, when he enters the 'vehicleName' command~~.		When a player enters the 'vehiclename' command and is currently in a vehicle, this example outputs the name of the vehicle.
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showVehicleName(~~player~~)		function showVehicleName ( thePlayer )
	local ~~vehicle~~ = getPlayerOccupiedVehicle(~~player~~)		local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
	if (~~vehicle ~= false~~) then		if ( theVehicle ) then
	local vehicleName = getVehicleName(~~vehicle~~)		local vehicleName = getVehicleName ( theVehicle )
	outputChatBox("Vehicle name: "..vehicleName,~~player~~)		outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
	end		end
	end		end
	addCommandHandler("~~vehicleName~~",showVehicleName)		addCommandHandler ( "vehiclename", showVehicleName )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	~~This example outputs the vehicle name of the vehicle if the player is currently occupying one, when he enters the 'vehicleName' command.~~		<section name="Client" class="client" show="true">
	<section name="Client" class="client">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showVehicleName()		function showVehicleName ( thePlayer )
			local theVehicle = getPlayerOccupiedVehicle ( )
	local ~~vehicle~~ = getPlayerOccupiedVehicle()		if ( theVehicle ) then
	if (~~vehicle ~= false~~) then		local vehicleName = getVehicleName ( theVehicle )
	local vehicleName = getVehicleName(~~vehicle~~)		outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
	outputChatBox("Vehicle name: "..vehicleName,~~player~~)
	end		end
	end		end
	addCommandHandler("~~vehicleName~~",showVehicleName)		addCommandHandler ( "vehiclename", showVehicleName )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Driver2 at 11:55, 7 August 2007

2007-08-07T11:55:08Z

@@ Line 4: / Line 4: @@
 ==Syntax==
 <syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( player thePlayer )</syntaxhighlight>
@@ Line 11: / Line 12: @@
 ===Returns===
 Returns the vehicle that the player is in, or ''false'' if the player is not in a vehicle or is an invalid player.
 ==Example==
 This example outputs the vehicle name of the vehicle if the player is currently occupying one, when he enters the 'vehicleName' command.
 <syntaxhighlight lang="lua">
 function showVehicleName(player)
@@ Line 24: / Line 36: @@
 addCommandHandler("vehicleName",showVehicleName)
 </syntaxhighlight>
 ==See Also==
 {{Player functions}}

Driver2 at 11:31, 7 August 2007

2007-08-07T11:31:14Z

← Older revision		Revision as of 11:31, 7 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function gets the [[vehicle]] that the player is currently in, if any.		This function gets the [[vehicle]] that the player is currently in, if any.

Driver2 at 12:57, 27 July 2007

2007-07-27T12:57:45Z

← Older revision		Revision as of 12:57, 27 July 2007
Line 12:		Line 12:

	==Example==		==Example==
	This example ~~finds~~ if the player ~~called ''someguy''~~ is ~~in a vehicle~~, ~~if they it shows~~ the ~~vehicle~~'~~s health in the chatbox~~.		This example outputs the vehicle name of the vehicle if the player is currently occupying one, when he enters the 'vehicleName' command.
	<syntaxhighlight lang="lua">if ( vehicle = getPlayerOccupiedVehicle ( ~~findPlayer~~ ( ~~"someguy" )~~ ) )		<syntaxhighlight lang="lua">
	outputChatBox ( "~~Someguy is in a vehicle with~~ " .. ~~getVehicleHealth ( vehicle ) .. " health."~~ )		function showVehicleName(player)
	~~else~~		local vehicle = getPlayerOccupiedVehicle(player)
	~~outputchatbox~~ ( "~~Someguy is not in a vehicle.~~" )		if (vehicle ~= false) then
	~~end~~</syntaxhighlight>		local vehicleName = getVehicleName(vehicle)
			outputChatBox("Vehicle name: "..vehicleName,player)
			end
			end
			addCommandHandler("vehicleName",showVehicleName)
			</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

EAi at 11:14, 14 August 2006

2006-08-14T11:14:26Z

← Older revision		Revision as of 11:14, 14 August 2006
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~==Description==~~		This function gets the [[vehicle]] that the player is currently in, if any.
	This function ~~returns a~~ [[vehicle]] that the player is currently in, if any~~. This function returns false if the player is on foot, or the player doesn't exist~~.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( player ~~player~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">vehicle getPlayerOccupiedVehicle ( player thePlayer )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~player~~''': The [[player]] whose vehicle you're looking up.		*'''thePlayer''': The [[player]] whose vehicle you're looking up.

			===Returns===
			Returns the vehicle that the player is in, or ''false'' if the player is not in a vehicle or is an invalid player.

	==Example==		==Example==
	<syntaxhighlight lang="lua">if ( vehicle = getPlayerOccupiedVehicle ( findPlayer ( "~~Someguy~~" ) ) )		This example finds if the player called ''someguy'' is in a vehicle, if they it shows the vehicle's health in the chatbox.
	~~OutputChatBox~~ ( "Someguy is in a vehicle with ", getVehicleHealth ( vehicle ), " health." )		<syntaxhighlight lang="lua">if ( vehicle = getPlayerOccupiedVehicle ( findPlayer ( "someguy" ) ) )
			outputChatBox ( "Someguy is in a vehicle with " .. getVehicleHealth ( vehicle ) .. " health." )
	else		else
	~~Outputchatbox~~ ( "Someguy is not in a vehicle." )		outputchatbox ( "Someguy is not in a vehicle." )
	end</syntaxhighlight>		end</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}