GetPedOccupiedVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function gets the [[vehicle]] that the ped is currently in, if any.
This function gets the [[vehicle]] that the ped is currently in or is trying to enter, if any.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">vehicle getPedOccupiedVehicle ( ped thePed )</syntaxhighlight>
<syntaxhighlight lang="lua">vehicle getPedOccupiedVehicle ( ped thePed )</syntaxhighlight>
{{OOP|Set the variable to nil to execute [[removePedFromVehicle]]|[[ped]]:getOccupiedVehicle|vehicle|warpPedIntoVehicle}}


===Required Arguments===
===Required Arguments===
Line 15: Line 16:
When a ped enters the 'getcarname' command and is currently in a vehicle, this example outputs the name of the vehicle.
When a ped enters the 'getcarname' command and is currently in a vehicle, this example outputs the name of the vehicle.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function showVehicleName ( player )
function showVehicleName ( thePlayer )
   local vehicle = getPedOccupiedVehicle ( player )
   local theVehicle = getPedOccupiedVehicle ( thePlayer )
   if vehicle then
   if theVehicle then
       outputChatBox ( "Name of the Vehicle: " .. getVehicleName ( vehicle ), player )
       outputChatBox ( "Name of the Vehicle: " .. getVehicleName ( theVehicle ), thePlayer )
   else
   else
       outputChatBox ( "You do not have a Vehicle!", player, 255, 0, 0, true )
       outputChatBox ( "You do not have a Vehicle!", thePlayer, 255, 0, 0, true )
   end
   end
end
end
Line 28: Line 29:
==See Also==
==See Also==
{{Client_ped_functions}}
{{Client_ped_functions}}
[[hu:getPedOccupiedVehicle]]

Latest revision as of 17:54, 7 October 2018

This function gets the vehicle that the ped is currently in or is trying to enter, if any.

Syntax

vehicle getPedOccupiedVehicle ( ped thePed )

OOP Syntax Help! I don't understand this!

Note: Set the variable to nil to execute removePedFromVehicle
Method: ped:getOccupiedVehicle(...)
Variable: .vehicle
Counterpart: warpPedIntoVehicle


Required Arguments

  • thePed: The ped whose vehicle you're looking up.

Returns

Returns the vehicle that the specified ped is in, or false if the ped is not in a vehicle or is an invalid ped.

Example

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

function showVehicleName ( thePlayer )
   local theVehicle = getPedOccupiedVehicle ( thePlayer )
   if theVehicle then
      outputChatBox ( "Name of the Vehicle: " .. getVehicleName ( theVehicle ), thePlayer )
   else
      outputChatBox ( "You do not have a Vehicle!", thePlayer, 255, 0, 0, true )
   end
end
addCommandHandler ( "getcarname", showVehicleName )

See Also