Package org.bukkit.event.world

Class AsyncStructureSpawnEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.world.WorldEvent

org.bukkit.event.world.AsyncStructureSpawnEvent

All Implemented Interfaces:

Cancellable

public class AsyncStructureSpawnEvent
extends WorldEvent
implements Cancellable

Called when a Structure is naturally generated in the world.

Nested Class Summary

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
AsyncStructureSpawnEvent(@NotNull World world, @NotNull Structure structure, @NotNull BoundingBox boundingBox, int chunkX, int chunkZ)

Method Summary

Modifier and Type	Method	Description
@NotNull BoundingBox	getBoundingBox()	Get the bounding box of the structure.
int	getChunkX()	Get the x coordinate of the origin chunk of the structure.
int	getChunkZ()	Get the z coordinate of the origin chunk of the structure.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Structure	getStructure()	Get the structure reference that is generated.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

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

getWorld

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncStructureSpawnEvent

public AsyncStructureSpawnEvent(@NotNull
 @NotNull World world,
 @NotNull
 @NotNull Structure structure,
 @NotNull
 @NotNull BoundingBox boundingBox,
 int chunkX,
 int chunkZ)

Method Details

getStructure

@NotNull
public @NotNull Structure getStructure()

Get the structure reference that is generated.

Returns:

the structure

getBoundingBox

@NotNull
public @NotNull BoundingBox getBoundingBox()

Get the bounding box of the structure.

Returns:

the bounding box

getChunkX

public int getChunkX()

Get the x coordinate of the origin chunk of the structure. Note, it is not safe to attempt to retrieve or interact with this chunk. This event is informative only!

Returns:

the chunk x coordinate

getChunkZ

public int getChunkZ()

Get the z coordinate of the origin chunk of the structure. Note, it is not safe to attempt to retrieve or interact with this chunk. This event is informative only!

Returns:

the chunk z coordinate

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 @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()