Package nl.sbdeveloper.vehiclesplus.api.events.impl

Class VehicleDespawnEvent

java.lang.Object

org.bukkit.event.Event

nl.sbdeveloper.vehiclesplus.api.events.Event

nl.sbdeveloper.vehiclesplus.api.events.VehicleEvent<SpawnedVehicle>

nl.sbdeveloper.vehiclesplus.api.events.CancellableVehicleEvent<SpawnedVehicle>

nl.sbdeveloper.vehiclesplus.api.events.impl.VehicleDespawnEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class VehicleDespawnEvent
extends CancellableVehicleEvent<SpawnedVehicle>

This event gets fired when a SpawnedVehicle gets despawned.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VehicleDespawnEvent.DespawnReason

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
VehicleDespawnEvent(SpawnedVehicle vehicle, boolean force, org.bukkit.entity.Player despawner)	Construct a new VehicleDespawnEvent.
VehicleDespawnEvent(SpawnedVehicle vehicle, VehicleDespawnEvent.DespawnReason reason, boolean force)	Construct a new VehicleDespawnEvent.

Method Summary

Modifier and Type	Method	Description
org.bukkit.entity.Player	getDespawner()	The Player that despawns the vehicle.
VehicleDespawnEvent.DespawnReason	getReason()	The reason why the vehicle gets despawned.
boolean	isForce()	Whether the vehicle is forced to despawn.
void	setCancelled(boolean cancelled)	Set if this event gets cancelled.

Methods inherited from class nl.sbdeveloper.vehiclesplus.api.events.CancellableVehicleEvent

isCancelled

Methods inherited from class nl.sbdeveloper.vehiclesplus.api.events.VehicleEvent

getVehicle

Methods inherited from class nl.sbdeveloper.vehiclesplus.api.events.Event

getHandlerList, getHandlers

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VehicleDespawnEvent

public VehicleDespawnEvent(SpawnedVehicle vehicle,
 VehicleDespawnEvent.DespawnReason reason,
 boolean force)

Construct a new VehicleDespawnEvent.

Parameters:

vehicle - The SpawnedVehicle that gets despawned.

VehicleDespawnEvent

public VehicleDespawnEvent(SpawnedVehicle vehicle,
 boolean force,
 @Nullable
 org.bukkit.entity.Player despawner)

Construct a new VehicleDespawnEvent.

Parameters:

vehicle - The SpawnedVehicle that gets despawned.

despawner - The Player that despawns the vehicle.

Method Details

setCancelled

public void setCancelled(boolean cancelled)

Description copied from class: CancellableVehicleEvent

Set if this event gets cancelled.

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

Overrides:

setCancelled in class CancellableVehicleEvent<SpawnedVehicle>

Parameters:

cancelled - true if you wish to cancel this event

getReason

public VehicleDespawnEvent.DespawnReason getReason()

The reason why the vehicle gets despawned.

isForce

public boolean isForce()

Whether the vehicle is forced to despawn.

getDespawner

@Nullable
public org.bukkit.entity.Player getDespawner()

The Player that despawns the vehicle.