GetPlayerOccupiedVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
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>

Revision as of 14:44, 19 August 2007

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

Syntax

Click to collapse [-]
Server
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.

Click to collapse [-]
Client
vehicle getPlayerOccupiedVehicle ( )

Required Arguments

None

Returns

Returns the vehicle that the local player is in, or false if the player is not in a vehicle.

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
function showVehicleName ( thePlayer )
	local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
	if ( theVehicle ) then
		local vehicleName = getVehicleName ( theVehicle )
		outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
	end
end
addCommandHandler ( "vehiclename", showVehicleName )
Click to collapse [-]
Client
function showVehicleName ( thePlayer )
        local theVehicle = getPlayerOccupiedVehicle ( )
        if ( theVehicle ) then
                local vehicleName = getVehicleName ( theVehicle )
                outputChatBox ( "Vehicle name: " .. vehicleName, thePlayer )
        end
end
addCommandHandler ( "vehiclename", showVehicleName )

See Also


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