org.bukkit.entity

Interface Item

All Superinterfaces:

net.kyori.adventure.audience.Audience, CommandSender, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, ServerOperator

public interface Item
extends Entity

Represents a dropped item.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
boolean	canMobPickup() Gets if non-player entities can pick this Item up
boolean	canPlayerPickup() Gets whether the player can pickup the item or not
@NotNull ItemStack	getItemStack() Gets the item stack associated with this item drop.
@Nullable UUID	getOwner() Get the owner of this item.
int	getPickupDelay() Gets the delay before this Item is available to be picked up by players
@Nullable UUID	getThrower() Get the thrower of this item.
void	setCanMobPickup(boolean canMobPickup) Sets if non-player entities can pick this Item up
void	setCanPlayerPickup(boolean canPlayerPickup) Sets whether the item can be picked up or not.
void	setItemStack(@NotNull ItemStack stack) Sets the item stack associated with this item drop.
void	setOwner(@Nullable UUID owner) Sets the owner of this item.
void	setPickupDelay(int delay) Sets the delay before this Item is available to be picked up by players
void	setThrower(@Nullable UUID uuid) Set the thrower of this item.
void	setWillAge(boolean willAge) Sets whether the item will age or not.
boolean	willAge() Gets whether the item will age and despawn from being on the ground too long

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface net.kyori.adventure.audience.Audience

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Method Detail

getItemStack

@NotNull
@NotNull ItemStack getItemStack()

Gets the item stack associated with this item drop.

Returns:

An item stack.

setItemStack

void setItemStack(@NotNull
                  @NotNull ItemStack stack)

Sets the item stack associated with this item drop.

Parameters:

stack - An item stack.

getPickupDelay

int getPickupDelay()

Gets the delay before this Item is available to be picked up by players

Returns:

Remaining delay

setPickupDelay

void setPickupDelay(int delay)

Sets the delay before this Item is available to be picked up by players

Parameters:

delay - New delay

setOwner

void setOwner(@Nullable
              @Nullable UUID owner)

Sets the owner of this item. Other entities will not be able to pickup this item when an owner is set.

Parameters:

owner - UUID of new owner

getOwner

@Nullable
@Nullable UUID getOwner()

Get the owner of this item.

Returns:

UUID of owner

setThrower

void setThrower(@Nullable
                @Nullable UUID uuid)

Set the thrower of this item. The thrower is the entity which dropped the item. This affects the trigger criteria for item pickups, for things such as advancements.

Parameters:

uuid - UUID of thrower

getThrower

@Nullable
@Nullable UUID getThrower()

Get the thrower of this item. The thrower is the entity which dropped the item.

Returns:

UUID of thrower

canMobPickup

boolean canMobPickup()

Gets if non-player entities can pick this Item up

Returns:

True if non-player entities can pickup

setCanMobPickup

void setCanMobPickup(boolean canMobPickup)

Sets if non-player entities can pick this Item up

Parameters:

canMobPickup - True to allow non-player entity pickup

canPlayerPickup

boolean canPlayerPickup()

Gets whether the player can pickup the item or not

Returns:

True if a player can pickup the item

setCanPlayerPickup

void setCanPlayerPickup(boolean canPlayerPickup)

Sets whether the item can be picked up or not. Modifies the pickup delay value to do so.

Parameters:

canPlayerPickup - True if the player can pickup the item

willAge

boolean willAge()

Gets whether the item will age and despawn from being on the ground too long

Returns:

True if the item will age

setWillAge

void setWillAge(boolean willAge)

Sets whether the item will age or not. If the item is not ageing, it will not despawn by being on the ground for too long.

Parameters:

willAge - True if the item should age