Package org.bukkit.event.entity
Class EntityPlaceEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityPlaceEvent
- All Implemented Interfaces:
Cancellable
Triggered when a entity is created in the world by a player "placing" an item
on a block.
Note that this event is currently only fired for four specific placements: armor stands, boats, minecarts, and end crystals.
Note that this event is currently only fired for four specific placements: armor stands, boats, minecarts, and end crystals.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity
-
Constructor Summary
ConstructorDescriptionEntityPlaceEvent
(Entity entity, Player player, Block block, BlockFace blockFace) Deprecated.EntityPlaceEvent
(Entity entity, Player player, Block block, BlockFace blockFace, EquipmentSlot hand) -
Method Summary
Modifier and TypeMethodDescriptiongetBlock()
Returns the block that the entity was placed onReturns the face of the block that the entity was placed ongetHand()
Get the hand used to place the entity.static HandlerList
Returns the player placing the entityboolean
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.entity.EntityEvent
getEntity, getEntityType
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
-
Constructor Details
-
EntityPlaceEvent
public EntityPlaceEvent(@NotNull Entity entity, @Nullable Player player, @NotNull Block block, @NotNull BlockFace blockFace, @NotNull EquipmentSlot hand) -
EntityPlaceEvent
@Deprecated(since="1.19.2") public EntityPlaceEvent(@NotNull Entity entity, @Nullable Player player, @NotNull Block block, @NotNull BlockFace blockFace) Deprecated.
-
-
Method Details
-
getPlayer
Returns the player placing the entity- Returns:
- the player placing the entity
-
getBlock
Returns the block that the entity was placed on- Returns:
- the block that the entity was placed on
-
getBlockFace
Returns the face of the block that the entity was placed on- Returns:
- the face of the block that the entity was placed on
-
getHand
Get the hand used to place the entity.- Returns:
- the hand
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-