Package org.bukkit.inventory.meta

Interface SpawnEggMeta

All Superinterfaces:

Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder, PersistentDataViewHolder

public interface SpawnEggMeta
extends ItemMeta

Represents a spawn egg and it's spawned type.

Method Summary

Modifier and Type	Method	Description
@NotNull SpawnEggMeta	clone()
@Nullable EntityType	getCustomSpawnedType()	Get the custom type of entity this egg will spawn.
@Nullable EntitySnapshot	getSpawnedEntity()	Gets the EntitySnapshot that will be spawned by this spawn egg or null if no entity has been set.
EntityType	getSpawnedType()	Deprecated, for removal: This API element is subject to removal in a future version. different types are different items
void	setCustomSpawnedType(@Nullable EntityType type)	Set the custom type of entity this egg will spawn.
void	setSpawnedEntity(@NotNull EntitySnapshot snapshot)	Sets the EntitySnapshot that will be spawned by this spawn egg.
void	setSpawnedType(EntityType type)	Deprecated, for removal: This API element is subject to removal in a future version. different types are different items

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Methods inherited from interface org.bukkit.inventory.meta.ItemMeta

addAttributeModifier, addEnchant, addItemFlags, customName, customName, displayName, displayName, getAsComponentString, getAsString, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomModelData, getCustomModelDataComponent, getCustomTagContainer, getDamageResistant, getDestroyableKeys, getDisplayName, getDisplayNameComponent, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getLocalizedName, getLore, getLoreComponents, getMaxStackSize, getPlaceableKeys, getRarity, getTool, getTooltipStyle, getUseCooldown, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasCustomName, hasDamageResistant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasLocalizedName, hasLore, hasMaxStackSize, hasPlaceableKeys, hasRarity, hasTool, hasTooltipStyle, hasUseCooldown, hasUseRemainder, isFireResistant, isGlider, isHideTooltip, isUnbreakable, itemName, itemName, lore, lore, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setCustomModelData, setCustomModelDataComponent, setDamageResistant, setDestroyableKeys, setDisplayName, setDisplayNameComponent, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setLocalizedName, setLore, setLoreComponents, setMaxStackSize, setPlaceableKeys, setRarity, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseRemainder, setVersion

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Method Details

getSpawnedType

@Deprecated(since="1.13",
            forRemoval=true)
@Contract("-> fail")
EntityType getSpawnedType()

Deprecated, for removal: This API element is subject to removal in a future version.

different types are different items

Get the type of entity this egg will spawn.

Returns:

The entity type. May be null for implementation specific default.

setSpawnedType

@Deprecated(since="1.13",
            forRemoval=true)
@Contract("_ -> fail")
void setSpawnedType(EntityType type)

Deprecated, for removal: This API element is subject to removal in a future version.

different types are different items

Set the type of entity this egg will spawn.

Parameters:

type - The entity type. May be null for implementation specific default.

getSpawnedEntity

@Nullable
@Nullable EntitySnapshot getSpawnedEntity()

Gets the EntitySnapshot that will be spawned by this spawn egg or null if no entity has been set.

All applicable data from the egg will be copied, such as custom name, health, and velocity.

Returns:

the entity snapshot or null if no entity has been set

setSpawnedEntity

void setSpawnedEntity(@NotNull
 @NotNull EntitySnapshot snapshot)

Sets the EntitySnapshot that will be spawned by this spawn egg.

All applicable data from the entity will be copied, such as custom name, health, and velocity.

Parameters:

snapshot - the snapshot

getCustomSpawnedType

@Nullable
@Nullable EntityType getCustomSpawnedType()

Get the custom type of entity this egg will spawn.

Returns:

the entity type or null if no custom type is set

setCustomSpawnedType

void setCustomSpawnedType(@Nullable
 @Nullable EntityType type)

Set the custom type of entity this egg will spawn.

Parameters:

type - the entity type or null to clear the custom type

clone

@NotNull
@NotNull SpawnEggMeta clone()

Specified by:

clone in interface ItemMeta