Package org.bukkit.event.world

Class ChunkUnloadEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.world.WorldEvent

org.bukkit.event.world.ChunkEvent

org.bukkit.event.world.ChunkUnloadEvent

All Implemented Interfaces:

Cancellable

public class ChunkUnloadEvent
extends ChunkEvent
implements Cancellable

Called when a chunk is unloaded

Nested Class Summary

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.world.ChunkEvent

chunk

Constructor Summary

Constructors

Constructor	Description
ChunkUnloadEvent(Chunk chunk)
ChunkUnloadEvent(Chunk chunk, boolean save)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isSaveChunk()	Return whether this chunk will be saved to disk.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setSaveChunk(boolean saveChunk)	Set whether this chunk will be saved to disk.

Methods inherited from class org.bukkit.event.world.ChunkEvent

getChunk

Methods inherited from class org.bukkit.event.world.WorldEvent

getWorld

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 Detail

ChunkUnloadEvent

public ChunkUnloadEvent(@NotNull
                        Chunk chunk)

ChunkUnloadEvent

public ChunkUnloadEvent(@NotNull
                        Chunk chunk,
                        boolean save)

Method Detail

isSaveChunk

public boolean isSaveChunk()

Return whether this chunk will be saved to disk.

Returns:

chunk save status

setSaveChunk

public void setSaveChunk(boolean saveChunk)

Set whether this chunk will be saved to disk.

Parameters:

saveChunk - chunk save status

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()