Squirrel/Server/Functions/Vehicles/GetPassenger
From Liberty Unleashed Wiki
(Difference between revisions)
(We don't like null passengers) |
(→Example) |
||
Line 11: | Line 11: | ||
== Example == | == Example == | ||
− | This example command returns who is | + | This example command returns the passenger who is sat in seat ID 0 of the current vehicle when a player types '/passenger'. |
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
− | if ( szCommand == " | + | if ( szCommand == "passenger" ) |
{ | { | ||
local pVehicle = pPlayer.Vehicle; | local pVehicle = pPlayer.Vehicle; | ||
if ( pVehicle ) | if ( pVehicle ) | ||
{ | { | ||
− | local | + | local pPassenger = pVehicle.GetPassenger( 0 ); |
− | if ( | + | if ( pPassenger ) MessagePlayer( "Vehicle Driver: " + pPassenger.Name, pPlayer ); |
} | } | ||
} | } |
Latest revision as of 20:34, 29 September 2010
This Vehicle class method will return the passenger pointer for the given seat. If the seat has no passenger, a null pointer will be returned.
[edit] Syntax
Player Vehicle.GetPassenger( int seat )
[edit] Arguments
- seat - The seat you wish to return the passenger for. seat is an integer from 0 to 7, 0 being the driver's seat.
[edit] Example
This example command returns the passenger who is sat in seat ID 0 of the current vehicle when a player types '/passenger'.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "passenger" ) { local pVehicle = pPlayer.Vehicle; if ( pVehicle ) { local pPassenger = pVehicle.GetPassenger( 0 ); if ( pPassenger ) MessagePlayer( "Vehicle Driver: " + pPassenger.Name, pPlayer ); } } return 1; }
[edit] Notes
The functions MessagePlayer, Player.Vehicle and event onPlayerCommand were used in this example. More info about them in the corresponding pages.
[edit] Related Functions
- CreateVehicle
- FindVehicle
- GetClosestVehicle
- GetVehicleCount
- GetVehicleHandlingData
- GetVehicleIDFromName
- GetVehicleName
- SetVehicleHandlingData
- Vehicle.Alpha
- Vehicle.Angle
- Vehicle.Colour1
- Vehicle.Colour2
- Vehicle.Driver
- Vehicle.EngineDamage
- Vehicle.Explode
- Vehicle.Fix
- Vehicle.GetAddon
- Vehicle.GetPassenger
- Vehicle.GetHandlingData
- Vehicle.GetWheelStatus
- Vehicle.Health
- Vehicle.ID
- Vehicle.IdleRespawnTime
- Vehicle.IdleTime
- Vehicle.LightState
- Vehicle.Locked
- Vehicle.Marker
- Vehicle.MarkerScale
- Vehicle.MarkerSprite
- Vehicle.Model
- Vehicle.OneTime
- Vehicle.PassengerCount
- Vehicle.Pos
- Vehicle.Remove
- Vehicle.Respawn
- Vehicle.RespawnTime
- Vehicle.RGBColour1
- Vehicle.RGBColour2
- Vehicle.SetHandlingData
- Vehicle.SetWheelStatus
- Vehicle.SpawnAngle
- Vehicle.SpawnPos
- Vehicle.SetAddon
- Vehicle.SetEngineState
- Vehicle.SetRadio
- Vehicle.Siren
- Vehicle.SirenLight
- Vehicle.TaxiLight
- Vehicle.Velocity
- Vehicle.VirtualWorld
- Vehicle.Wrecked