WarpPedIntoVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function is used to warp or force a ped into a vehicle. There are no animations involved when this happens. ==Syntax== <syntaxhighlight lang="lua"> bool warpPedIntoV...)
 
No edit summary
 
(15 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server client function}}
This function is used to warp or force a ped into a vehicle.  There are no animations involved when this happens.
This function is used to warp or force a ped into a vehicle.  There are no animations involved when this happens.
[[File:vehicle seat ids.png|200px|thumb|right|Vehicle seat ids]]
'''Available client side from 1.3.1''' (It will only work with client side vehicles and peds)
{{Important Note|If you used [[setElementPosition]] to spawn the [[ped]]/[[player]], this function will not work and returns '''false'''.}}


==Syntax==  
==Syntax==  
Line 7: Line 12:
bool warpPedIntoVehicle ( ped thePed, vehicle theVehicle, [ int seat=0 ] )           
bool warpPedIntoVehicle ( ped thePed, vehicle theVehicle, [ int seat=0 ] )           
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|Set the variable to nil to execute [[removePedFromVehicle]]|[[ped]]:warpIntoVehicle|vehicle|getPedOccupiedVehicle}}


===Required Arguments===  
===Required Arguments===  
Line 14: Line 21:
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats.
*'''seat:''' An integer representing the seat ID.
** '''0:''' Front-left
** '''1:''' Front-right
** '''2:''' Rear-left
** '''3:''' Rear-right


===Returns===
===Returns===
Line 20: Line 31:


==Example==  
==Example==  
This example creates a vehicle and warps a ped inside immediately
This example creates a vehicle and warps a ped inside immediately.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function createstartvehicles ( playerSource, commandName, car, x, y, z ) -- the function allows specification of your car, and the position
function setupForRace ( )
     local racevehicle = createVehicle ( car, x, y, z )                   -- create a vehicle at the position specified by the startrace command
    local RacerPed = createPed ( 252, 0, 0, 3 )
     warpPedIntoVehicle ( playerSource, racevehicle )                  -- warp them straight into the vehicle
     local RaceVehicle = createVehicle ( 411, 4, 0, 3 )           -- create a vehicle.
     warpPedIntoVehicle ( RacerPed, RaceVehicle )                  -- warp the ped straight into the vehicle
end
end
addCommandHandler ( "startrace", createstartvehicles )                  -- add a command to start race
addCommandHandler ( "startrace", setupForRace )                  -- add a command to start race
</syntaxhighlight>
</syntaxhighlight>
==Issues==
{{Issues|
{{Issue|475|Network trouble when calling warpPedIntoVehicle on resourceStart}}
}}


==See Also==
==See Also==
{{Ped functions}}
{{Ped functions}}
[[ru:warpPedIntoVehicle]]

Latest revision as of 19:02, 30 January 2022

This function is used to warp or force a ped into a vehicle. There are no animations involved when this happens.

Vehicle seat ids

Available client side from 1.3.1 (It will only work with client side vehicles and peds)

[[{{{image}}}|link=|]] Important Note: If you used setElementPosition to spawn the ped/player, this function will not work and returns false.

Syntax

bool warpPedIntoVehicle ( ped thePed, vehicle theVehicle, [ int seat=0 ] )


OOP Syntax Help! I don't understand this!

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


Required Arguments

  • thePed: The ped which you wish to force inside the vehicle
  • theVehicle: The vehicle you wish to force the ped into

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • seat: An integer representing the seat ID.
    • 0: Front-left
    • 1: Front-right
    • 2: Rear-left
    • 3: Rear-right

Returns

Returns true if the operation is successful, false otherwise.

Example

This example creates a vehicle and warps a ped inside immediately. 

function setupForRace ( )
    local RacerPed = createPed ( 252, 0, 0, 3 )
    local RaceVehicle = createVehicle ( 411, 4, 0, 3 )            -- create a vehicle.
    warpPedIntoVehicle ( RacerPed, RaceVehicle )                  -- warp the ped straight into the vehicle
end
addCommandHandler ( "startrace", setupForRace )                   -- add a command to start race

Issues

Issue ID Description
#475 Network trouble when calling warpPedIntoVehicle on resourceStart

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/WarpPedIntoVehicle?oldid=73920"