Squirrel/Server/Events/Vehicle/onPlayerEnteredVehicle

Latest revision as of 13:04, 11 November 2010

This is called when a player has successfully entered a vehicle.

[edit] Syntax

function onPlayerEnteredVehicle( Player player, Vehicle vehicle, int seat )

[edit] Arguments

• player - The player entered a vehicle
• vehicle - The vehicle the player entered
• seat - The vehicle seat player is currently occupying
  • 0 - Driver
  • 1 - Front passenger
  • 2 - Back left passenger
  • 3 - Back right passenger
  • 4- - Other passenger seats (coach, bus)

[edit] Returns

This event does not handle return values.

[edit] Example

This example will message player the name of the vehicle they just entered.

 
function onPlayerEnteredVehicle( player, vehicle, seat )
{
     MessagePlayer( "You entered a " + vehicle.tostring(), player );
     
     return 1;
}
 

[edit] Notes

The function MessagePlayer was used in this example. More info about it can be found in the corresponding page.

[edit] Related Events

• onPlayerEnteredTrain
• onPlayerEnteredVehicle
• onPlayerEnteringVehicle
• onPlayerExitedTrain
• onPlayerExitedVehicle
• onPlayerExitingVehicle
• onPlayerFailedVehicleEntry
• onVehicleHealthChange
• onVehicleRespawn
• onVehicleUpdate
• onVehicleWrecked