Interface IVehicleEventHandler

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

Provides the events for GetEventDispatcher().

[OpenMpEventHandler]
public interface IVehicleEventHandler : IEventHandler<IVehicleEventHandler>

Inherited Members

IEventHandler<IVehicleEventHandler>.Marshaller

Methods

OnEnterExitModShop(IPlayer, bool, int)

Called when a player enters or exits a mod shop.

void OnEnterExitModShop(IPlayer player, bool enterexit, int interiorId)

Parameters

player IPlayer

The player entering or exiting the mod shop.

enterexit bool

true if the player is entering; false if exiting.

interiorId int

The interior ID of the mod shop.

OnPlayerEnterVehicle(IPlayer, IVehicle, bool)

Called when a player enters a vehicle.

void OnPlayerEnterVehicle(IPlayer player, IVehicle vehicle, bool passenger)

Parameters

player IPlayer

The player entering the vehicle.

vehicle IVehicle

The vehicle being entered.

passenger bool

true if the player is entering as a passenger; otherwise, false.

OnPlayerExitVehicle(IPlayer, IVehicle)

Called when a player exits a vehicle.

void OnPlayerExitVehicle(IPlayer player, IVehicle vehicle)

Parameters

player IPlayer

The player exiting the vehicle.

vehicle IVehicle

The vehicle being exited.

OnTrailerUpdate(IPlayer, IVehicle)

Called when a trailer is updated.

bool OnTrailerUpdate(IPlayer player, IVehicle trailer)

Parameters

player IPlayer

The player associated with the update.

trailer IVehicle

The trailer being updated.

Returns

bool

true if the update is allowed; otherwise, false.

OnUnoccupiedVehicleUpdate(IVehicle, IPlayer, UnoccupiedVehicleUpdate)

Called when an unoccupied vehicle is updated.

bool OnUnoccupiedVehicleUpdate(IVehicle vehicle, IPlayer player, UnoccupiedVehicleUpdate updateData)

Parameters

vehicle IVehicle

The vehicle being updated.

player IPlayer

The player associated with the update.

updateData UnoccupiedVehicleUpdate

The update data for the vehicle.

Returns

bool

true if the update is allowed; otherwise, false.

OnVehicleDamageStatusUpdate(IVehicle, IPlayer)

Called when a vehicle's damage status is updated.

void OnVehicleDamageStatusUpdate(IVehicle vehicle, IPlayer player)

Parameters

vehicle IVehicle

The vehicle whose damage status was updated.

player IPlayer

The player associated with the update, if any.

OnVehicleDeath(IVehicle, IPlayer)

Called when a vehicle is destroyed.

void OnVehicleDeath(IVehicle vehicle, IPlayer player)

Parameters

vehicle IVehicle

The vehicle that was destroyed.

player IPlayer

The player associated with the destruction, if any.

OnVehicleMod(IPlayer, IVehicle, int)

Called when a player modifies a vehicle.

bool OnVehicleMod(IPlayer player, IVehicle vehicle, int component)

Parameters

player IPlayer

The player modifying the vehicle.

vehicle IVehicle

The vehicle being modified.

component int

The component ID being added.

Returns

bool

true if the modification is allowed; otherwise, false.

OnVehiclePaintJob(IPlayer, IVehicle, int)

Called when a player applies a paint job to a vehicle.

bool OnVehiclePaintJob(IPlayer player, IVehicle vehicle, int paintJob)

Parameters

player IPlayer

The player applying the paint job.

vehicle IVehicle

The vehicle being painted.

paintJob int

The paint job ID being applied.

Returns

bool

true if the paint job is allowed; otherwise, false.

OnVehicleRespray(IPlayer, IVehicle, int, int)

Called when a player resprays a vehicle.

bool OnVehicleRespray(IPlayer player, IVehicle vehicle, int colour1, int colour2)

Parameters

player IPlayer

The player respraying the vehicle.

vehicle IVehicle

The vehicle being resprayed.

colour1 int

The primary color being applied.

colour2 int

The secondary color being applied.

Returns

bool

true if the respray is allowed; otherwise, false.

OnVehicleSirenStateChange(IPlayer, IVehicle, byte)

Called when a vehicle's siren state changes.

bool OnVehicleSirenStateChange(IPlayer player, IVehicle vehicle, byte sirenState)

Parameters

player IPlayer

The player associated with the siren state change.

vehicle IVehicle

The vehicle whose siren state changed.

sirenState byte

The new siren state.

Returns

bool

true if the siren state change is allowed; otherwise, false.

OnVehicleSpawn(IVehicle)

Called when a vehicle spawns.

void OnVehicleSpawn(IVehicle vehicle)

Parameters

vehicle IVehicle

The vehicle that spawned.

OnVehicleStreamIn(IVehicle, IPlayer)

Called when a vehicle is streamed in for a player.

void OnVehicleStreamIn(IVehicle vehicle, IPlayer player)

Parameters

vehicle IVehicle

The vehicle being streamed in.

player IPlayer

The player for whom the vehicle is streamed in.

OnVehicleStreamOut(IVehicle, IPlayer)

Called when a vehicle is streamed out for a player.

void OnVehicleStreamOut(IVehicle vehicle, IPlayer player)

Parameters

vehicle IVehicle

The vehicle being streamed out.

player IPlayer

The player for whom the vehicle is streamed out.