GetVehicleOccupant

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function gets the player sitting/trying to enter the specified vehicle.

Syntax

player getVehicleOccupant ( vehicle theVehicle, [ int seat=0 ] )            

OOP Syntax Help! I don't understand this!

Method: vehicle:getOccupant(...)
Variable: .occupant

Required Arguments

  • theVehicle: the vehicle of which you wish to retrieve the driver or a passenger.

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: the seat where the player is sitting (0 for driver, 1+ for passengers).

Returns

Returns the player sitting in the vehicle, or false if the seat is unoccupied or doesn't exist.

Example

This example announces the driver of a certain vehicle whenever it is damaged:

function onStolenVehicleDamage ( loss )
    local driver = getVehicleOccupant ( source ) -- get the player sitting in seat 0
    if ( driver ) then -- if the driver exists, display a message
        outputChatBox ( getPlayerName ( driver ) .. " is wrecking the vehicle he stole!" )
    end
end
addEventHandler ( "onVehicleDamage", stolenVehicle, onStolenVehicleDamage )

See Also

FROM VERSION 1.6 r7485 ONWARDS
FROM VERSION 1.6 r7485 ONWARDS