WarpPlayerIntoVehicle

From Multi Theft Auto: Wiki
Revision as of 04:37, 23 October 2006 by Vandalite (talk | contribs)
Jump to navigation Jump to search

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

Syntax

bool warpPlayerIntoVehicle ( player player, vehicle vehicle, [ int seat=0 ] )          

Required Arguments

  • player: The player in which you wish to force inside the vehicle
  • vehicle: The vehicle you wish to force the player inside

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 player inside immediately

addCommandHandler ( startrace, createstartvehicles ) --add a command to start race
function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position
    racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command
    warpPlayerintoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle
end

See Also