Squirrel/Server/Events/Vehicle/onVehicleUpdate

Latest revision as of 02:38, 15 April 2011

Warning: This event can be called multiple times per second for any occupied or unoccupied vehicles. It is not recommended to run any heavy code under this.

This event is called every time a vehicle sync packet (player is driving a vehicle or unoccupied sync) is received.

[edit] Syntax

function onVehicleUpdate( Vehicle vehicle, Player trigger )

[edit] Arguments

• vehicle - Vehicle which was updated
• trigger - The player who triggered this event (either the vehicle driver or the player who moved an unoccupied vehicle)

[edit] Returns

• 1 - This sync packet will be transmitted to other clients normally
• 0 - Do not broadcast this sync packet to other clients

[edit] Example

This example will message the player if they move an unoccupied vehicle.

 
function onVehicleUpdate( vehicle, player )
{
     // Check that the vehicle has no driver
     if ( vehicle.Driver ) return 1;
     
     MessagePlayer( "Nice one you scratched the paint of that " + GetVehicleName( vehicle.Model ), player );
     return 1;
}
 

[edit] Notes

The functions MessagePlayer, GetVehicleName and Vehicle.Model were used in this example. More info about them can be found in the corresponding pages.

[edit] Related Events

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