WarpPedIntoVehicle: Difference between revisions

Revision as of 09:55, 3 June 2008

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

Syntax

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

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 represents the driver, any higher represent passenger seats.

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

@@ Line 20: / Line 20: @@
 ==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">
-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
-addCommandHandler ( "startrace", createstartvehicles )                   -- add a command to start race
+addCommandHandler ( "startrace", setupForRace )                   -- add a command to start race
 </syntaxhighlight>
 ==See Also==
 {{Ped functions}}