net.risingworld.api.events

Interface Cancellable

All Known Implementing Classes:

AddAdminEvent, ExplosionEvent, ItemTransformEvent, NpcDeathEvent, NpcHitNpcEvent, NpcSpawnEvent, PlantGrowEvent, PlayerBanEvent, PlayerCatchFishEvent, PlayerChangeBlockPositionEvent, PlayerChangeGamemodeEvent, PlayerChangeObjectStatusEvent, PlayerChangePositionEvent, PlayerChatEvent, PlayerChestAccessEvent, PlayerChestDropEvent, PlayerChestToInventoryEvent, PlayerCommandEvent, PlayerConnectEvent, PlayerCraftItemEvent, PlayerCreateBlueprintEvent, PlayerCreativePlaceBlockEvent, PlayerCreativePlaceVegetationEvent, PlayerCreativeRemoveConstructionEvent, PlayerCreativeRemoveObjectEvent, PlayerCreativeRemoveVegetationEvent, PlayerCreativeTerrainEditEvent, PlayerCustomImageDeleteEvent, PlayerCustomImageUploadRequestEvent, PlayerDamageEvent, PlayerDeathEvent, PlayerDestroyBlockEvent, PlayerDestroyConstructionEvent, PlayerDestroyObjectEvent, PlayerDestroyTerrainEvent, PlayerDestroyVegetationEvent, PlayerDismountNpcEvent, PlayerDropItemEvent, PlayerEditConstructionEvent, PlayerElementInteractionEvent, PlayerEnterAreaEvent, PlayerEnterChunkEvent, PlayerEnterVehicleEvent, PlayerEnterWorldpartEvent, PlayerExitVehicleEvent, PlayerHitEvent, PlayerHitNpcEvent, PlayerInventoryAddEvent, PlayerInventoryToChestEvent, PlayerKickEvent, PlayerLeaveAreaEvent, PlayerMountNpcEvent, PlayerNpcInteractionEvent, PlayerNpcInventoryAccessEvent, PlayerObjectInteractionEvent, PlayerPermissionGroupChangeEvent, PlayerPickupItemEvent, PlayerPlaceBlockEvent, PlayerPlaceBlueprintEvent, PlayerPlaceConstructionEvent, PlayerPlaceGrassEvent, PlayerPlaceObjectEvent, PlayerPlaceTerrainEvent, PlayerPlaceVegetationEvent, PlayerPlaceWaterEvent, PlayerPlayerInteractionEvent, PlayerPrivateMessageEvent, PlayerRemoveConstructionEvent, PlayerRemoveGrassEvent, PlayerRemoveObjectEvent, PlayerRemoveVegetationEvent, PlayerRemoveWaterEvent, PlayerRespawnEvent, PlayerSetSignTextEvent, PlayerStartFishingEvent, PlayerStartFlyingEvent, PlayerStopFlyingEvent, PlayerTeleportEvent, PlayerWorldEditEvent, PlayerWorldHitEvent, RemoveAdminEvent, ShutdownEvent, WeatherChangeEvent

public interface Cancellable

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

Method Detail

isCancelled

boolean isCancelled()

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Returns:

true if the event is cancelled, or false if not.

setCancelled

void setCancelled(boolean cancel)

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Parameters:

cancel - set to true if you want to cancel this event.

Example: Cancel "PlayerEnterAreaEvent", i.e. prevent player from entering the area

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onEnterArea(PlayerEnterAreaEvent evt){
5	//Now the player will not be able to enter the area, i.e.
6	//he will be teleported back to his old position (outside the area)
7	evt.setCancelled(true);
8	}
9	}