GetPlayerOccupiedVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{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.


Line 9: Line 12:


===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.


==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.
When a player enters the 'vehiclename' command and is currently in a vehicle, this example outputs the name of the vehicle.
<syntaxhighlight lang="lua">if ( vehicle = getPlayerOccupiedVehicle ( findPlayer ( "someguy" ) ) )
<section name="Server and client" class="both" show="true">
  outputChatBox ( "Someguy is in a vehicle with " .. getVehicleHealth ( vehicle ) .. " health." )
<syntaxhighlight lang="lua">
else
function showVehicleName ( thePlayer )
  outputchatbox ( "Someguy is not in a vehicle." )
local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
end</syntaxhighlight>
if ( theVehicle ) then
local vehicleName = getVehicleName ( theVehicle )
outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
end
end
addCommandHandler ( "vehiclename", showVehicleName )
</syntaxhighlight>
</section>


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

Latest revision as of 16:13, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedOccupiedVehicle instead.


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

Syntax

vehicle getPlayerOccupiedVehicle ( player thePlayer )

Required Arguments

  • thePlayer: The player whose vehicle you're looking up.

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.

Example

When a player enters the 'vehiclename' command and is currently in a vehicle, this example outputs the name of the vehicle.

Click to collapse [-]
Server and client
function showVehicleName ( thePlayer )
	local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
	if ( theVehicle ) then
		local vehicleName = getVehicleName ( theVehicle )
		outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
	end
end
addCommandHandler ( "vehiclename", showVehicleName )

See Also

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerOccupiedVehicle?oldid=44555"