WarpPlayerIntoVehicle: Difference between revisions

Revision as of 21:39, 13 August 2006

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

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
 __NOTOC__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function is used to warp or force a player into a vehicle.  There are no animations involved when this happens.
 ==Syntax==
@@ Line 10: / Line 8: @@
 ===Required Arguments===
-*'''argumentName:''' description
+*'''player:''' The player in which you wish to force inside the vehicle
+*'''vehicle:''' The vehicle you wish to force the player inside
 ===Optional Arguments===
 {{OptionalArg}}
-*'''argumentName2:''' descriptiona
+*'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns ''true'' if the operation is successful, ''false'' otherwise.
 ==Example==
-This example does...
+This example creates a vehicle and warps a player inside immediately
 <syntaxhighlight lang="lua">
---This line does...
+addCommandHandler ( startrace, createstartvehicles ) --add a command to start race
-blabhalbalhb --abababa
+function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position
---This line does this...
+    racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command
-mooo
+    warpPlayerintoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle
+end
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Vehicle functions}}