Package org.bukkit.event.world

Class AsyncStructureGenerateEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.world.WorldEvent

org.bukkit.event.world.AsyncStructureGenerateEvent

@Experimental
public class AsyncStructureGenerateEvent
extends WorldEvent

This event will sometimes fire synchronously, depending on how it was triggered.

The constructor provides a boolean to indicate if the event was fired synchronously or asynchronously. When asynchronous, this event can be called from any thread, sans the main thread, and has limited access to the API.

If a Structure is naturally placed in a chunk of the world, this event will be asynchronous. If a player executes the '/place structure' command, this event will be synchronous. Allows to register transformers that can modify the blocks placed and entities spawned by the structure.

Care should be taken to check Event.isAsynchronous() and treat the event appropriately.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AsyncStructureGenerateEvent.Cause

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
AsyncStructureGenerateEvent(@NotNull World world, boolean async, @NotNull AsyncStructureGenerateEvent.Cause cause, @NotNull Structure structure, @NotNull BoundingBox boundingBox, int chunkX, int chunkZ)

Method Summary

Modifier and Type	Method	Description
void	clearBlockTransformers()	Removes all block transformers.
void	clearEntityTransformers()	Removes all entity transformers.
@Nullable BlockTransformer	getBlockTransformer(@NotNull NamespacedKey key)	Gets a block transformer by key.
@NotNull Map<NamespacedKey,BlockTransformer>	getBlockTransformers()	Gets all block transformers in a unmodifiable map.
@NotNull BoundingBox	getBoundingBox()	Get the bounding box of the structure.
@NotNull AsyncStructureGenerateEvent.Cause	getCause()	Gets the event cause.
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.
@Nullable EntityTransformer	getEntityTransformer(@NotNull NamespacedKey key)	Gets a entity transformer by key.
@NotNull Map<NamespacedKey,EntityTransformer>	getEntityTransformers()	Gets all entity transformers in a unmodifiable map.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Structure	getStructure()	Get the structure reference that is generated.
void	removeBlockTransformer(@NotNull NamespacedKey key)	Removes a block transformer.
void	removeEntityTransformer(@NotNull NamespacedKey key)	Removes a entity transformer.
void	setBlockTransformer(@NotNull NamespacedKey key, @NotNull BlockTransformer transformer)	Sets a block transformer to a key.
void	setEntityTransformer(@NotNull NamespacedKey key, @NotNull EntityTransformer transformer)	Sets a entity transformer to a key.

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

AsyncStructureGenerateEvent

public AsyncStructureGenerateEvent(@NotNull
 @NotNull World world,
 boolean async,
 @NotNull
 @NotNull AsyncStructureGenerateEvent.Cause cause,
 @NotNull
 @NotNull Structure structure,
 @NotNull
 @NotNull BoundingBox boundingBox,
 int chunkX,
 int chunkZ)

Method Details

getCause

@NotNull
public @NotNull AsyncStructureGenerateEvent.Cause getCause()

Gets the event cause.

Returns:

the event cause

getBlockTransformer

@Nullable
public @Nullable BlockTransformer getBlockTransformer(@NotNull
 @NotNull NamespacedKey key)

Gets a block transformer by key.

Parameters:

key - the key of the block transformer

Returns:

the block transformer or null

setBlockTransformer

public void setBlockTransformer(@NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull BlockTransformer transformer)

Sets a block transformer to a key.

Parameters:

key - the key

transformer - the block transformer

removeBlockTransformer

public void removeBlockTransformer(@NotNull
 @NotNull NamespacedKey key)

Removes a block transformer.

Parameters:

key - the key of the block transformer

clearBlockTransformers

public void clearBlockTransformers()

Removes all block transformers.

getBlockTransformers

@NotNull
public @NotNull Map<NamespacedKey,BlockTransformer> getBlockTransformers()

Gets all block transformers in a unmodifiable map.

Returns:

the block transformers in a map

getEntityTransformer

@Nullable
public @Nullable EntityTransformer getEntityTransformer(@NotNull
 @NotNull NamespacedKey key)

Gets a entity transformer by key.

Parameters:

key - the key of the entity transformer

Returns:

the entity transformer or null

setEntityTransformer

public void setEntityTransformer(@NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull EntityTransformer transformer)

Sets a entity transformer to a key.

Parameters:

key - the key

transformer - the entity transformer

removeEntityTransformer

public void removeEntityTransformer(@NotNull
 @NotNull NamespacedKey key)

Removes a entity transformer.

Parameters:

key - the key of the entity transformer

clearEntityTransformers

public void clearEntityTransformers()

Removes all entity transformers.

getEntityTransformers

@NotNull
public @NotNull Map<NamespacedKey,EntityTransformer> getEntityTransformers()

Gets all entity transformers in a unmodifiable map.

Returns:

the entity transformers in a map

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.

Returns:

the chunk x coordinate

getChunkZ

public int getChunkZ()

Get the z coordinate of the origin chunk of the structure.

Returns:

the chunk z coordinate

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()