GetVehicleOccupant

From Multi Theft Auto: Wiki
Revision as of 20:25, 28 August 2006 by Erorr404 (talk | contribs)
Jump to navigation Jump to search


This function gets the player sitting in the specified vehicle.

Syntax

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

Required Arguments

  • theVehicle: The vehicle from which you wish to retrive the player.

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:

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

See Also

Template:FunctionArea Functions