com.bgsoftware.wildstacker.api.objects

Interface StackedEntity

All Superinterfaces:

AsyncStackedObject<org.bukkit.entity.LivingEntity>, StackedObject<org.bukkit.entity.LivingEntity>, UpgradeableStackedObject

public interface StackedEntity
extends AsyncStackedObject<org.bukkit.entity.LivingEntity>, UpgradeableStackedObject

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomName() Get the custom name of the living-entity.
int	getDefaultUnstack() Gets the default unstack amount for this entity.
java.util.List<org.bukkit.inventory.ItemStack>	getDrops(int lootBonusLevel) Get the drops of this entity with a specific fortune level.
java.util.List<org.bukkit.inventory.ItemStack>	getDrops(int lootBonusLevel, int stackAmount) Get the drops of this entity with a specific fortune level and a stack size.
int	getExp(int stackAmount, int defaultExp) Get the exp of this entity with a stack size.
double	getHealth() Get the health of the living-entity.
org.bukkit.entity.LivingEntity	getLivingEntity() Get the living-entity object of bukkit.
SpawnCause	getSpawnCause() Returns the spawn cause of this entity
org.bukkit.entity.EntityType	getType() Get the entity-type of the living-entity.
java.util.UUID	getUniqueId() Get the uuid of the living-entity.
boolean	hasNameTag() Checks if entity has a name tag.
boolean	isCustomNameVisible() Check whether or not the name of the living entity is visible.
boolean	isInstantKill(org.bukkit.event.entity.EntityDamageEvent.DamageCause damageCause) Checks if the entity should be instant-killed or not.
boolean	isNameBlacklisted() Checks if the name of the entity is blacklisted.
boolean	isNerfed() Checks if the entity is nerfed or not.
void	runSpawnerStackAsync(StackedSpawner stackedSpawner, java.util.function.Consumer<java.util.Optional<org.bukkit.entity.LivingEntity>> result) Try to stack the living-entity the same as if it was spawned by a spawner.
void	setCustomName(java.lang.String customName) Set a custom-name to the living-entity.
void	setCustomNameVisible(boolean visible) Set visible custom name flag to the living-entity.
void	setDrops(java.util.List<org.bukkit.inventory.ItemStack> itemStacks) Set a temporary loot-table for this entity.
void	setDropsMultiplier(int multiplier) Set a multiplier for loot.
void	setHealth(double health) Set the health to the living-entity.
void	setLootMultiplier(int multiplier) Deprecated. See setDropsMultiplier
void	setNerfed(boolean nerfed) Set whether the entity should be nerfed or not.
void	setSpawnCause(SpawnCause spawnCause) Set the spawn cause of the entity.
void	setTempLootTable(java.util.List<org.bukkit.inventory.ItemStack> itemStacks) Deprecated. see setDrops
void	spawnCorpse() Spawn a corpse for this entity.
StackedEntity	spawnDuplicate(int amount) Spawn a duplicate entity with a specific stack amount.
org.bukkit.entity.LivingEntity	trySpawnerStack(StackedSpawner stackedSpawner) Deprecated. Should not be used. See runSpawnerStackAsync
void	updateNerfed() Set whether the entity should be nerfed or not using the isNerfed flag.

Methods inherited from interface com.bgsoftware.wildstacker.api.objects.AsyncStackedObject

runStackAsync, runStackAsync

Methods inherited from interface com.bgsoftware.wildstacker.api.objects.StackedObject

canStackInto, getLocation, getMergeRadius, getStackAmount, getStackLimit, getWorld, isBlacklisted, isCached, isSimilar, isWhitelisted, isWorldDisabled, remove, runStack, runStack, runStackCheck, runUnstack, runUnstack, setStackAmount, spawnStackParticle, tryStack, tryStackInto, tryUnstack, updateName

Methods inherited from interface com.bgsoftware.wildstacker.api.objects.UpgradeableStackedObject

getUpgrade, setUpgrade

Method Detail

getLivingEntity

org.bukkit.entity.LivingEntity getLivingEntity()

Get the living-entity object of bukkit.

getUniqueId

java.util.UUID getUniqueId()

Get the uuid of the living-entity.

getType

org.bukkit.entity.EntityType getType()

Get the entity-type of the living-entity.

setHealth

void setHealth(double health)

Set the health to the living-entity.

Parameters:

health - new health to set

getHealth

double getHealth()

Get the health of the living-entity.

getCustomName

java.lang.String getCustomName()

Get the custom name of the living-entity.

setCustomName

void setCustomName(java.lang.String customName)

Set a custom-name to the living-entity.

Parameters:

customName - a new custom name

isCustomNameVisible

boolean isCustomNameVisible()

Check whether or not the name of the living entity is visible.

setCustomNameVisible

void setCustomNameVisible(boolean visible)

Set visible custom name flag to the living-entity.

Parameters:

visible - should the custom name of the living-entity be visible or not

runSpawnerStackAsync

void runSpawnerStackAsync(StackedSpawner stackedSpawner,
                          java.util.function.Consumer<java.util.Optional<org.bukkit.entity.LivingEntity>> result)

Try to stack the living-entity the same as if it was spawned by a spawner.

Parameters:

stackedSpawner - The spawner that spawned the entity.

result - The entity that this entity was stacked into.

trySpawnerStack

@Deprecated
org.bukkit.entity.LivingEntity trySpawnerStack(StackedSpawner stackedSpawner)

Deprecated. Should not be used. See runSpawnerStackAsync

Try to stack the living-entity the same as if it was spawned by a spawner.

Parameters:

stackedSpawner - the spawner

Returns:

the entity it got stacked into. If none, null will be returned.

spawnDuplicate

StackedEntity spawnDuplicate(int amount)

Spawn a duplicate entity with a specific stack amount.

Parameters:

amount - the stack amount it will have

Returns:

The stacked entity object of the new entity that was spawned

spawnCorpse

void spawnCorpse()

Spawn a corpse for this entity.

getDrops

java.util.List<org.bukkit.inventory.ItemStack> getDrops(int lootBonusLevel)

Get the drops of this entity with a specific fortune level. SHOULD BE USED ASYNC OR MAY CAUSE LAG WITH LARGE STACK SIZES!!!

Parameters:

lootBonusLevel - the fortune level

getDrops

java.util.List<org.bukkit.inventory.ItemStack> getDrops(int lootBonusLevel,
                                                        int stackAmount)

Get the drops of this entity with a specific fortune level and a stack size. SHOULD BE USED ASYNC OR MAY CAUSE LAG WITH LARGE STACK SIZES!!!

Parameters:

lootBonusLevel - the fortune level

stackAmount - the stack size

setDrops

void setDrops(java.util.List<org.bukkit.inventory.ItemStack> itemStacks)

Set a temporary loot-table for this entity. This loot table can be used one, and getDrops method will remove the temp loot-table.

Parameters:

itemStacks - The loot to set

setTempLootTable

@Deprecated
void setTempLootTable(java.util.List<org.bukkit.inventory.ItemStack> itemStacks)

Deprecated. see setDrops

Set a temporary loot-table for this entity. This loot table can be used one, and getDrops method will remove the temp loot-table.

Parameters:

itemStacks - The loot to set

setDropsMultiplier

void setDropsMultiplier(int multiplier)

Set a multiplier for loot. It will multiply all the drops by the given multiplier.

Parameters:

multiplier - The multiplier

setLootMultiplier

@Deprecated
void setLootMultiplier(int multiplier)

Deprecated. See setDropsMultiplier

Set a multiplier for loot. It will multiply all the drops by the given multiplier.

Parameters:

multiplier - The multiplier

getExp

int getExp(int stackAmount,
           int defaultExp)

Get the exp of this entity with a stack size.

Parameters:

stackAmount - the stack size

defaultExp - the default exp to return if not found

getSpawnCause

SpawnCause getSpawnCause()

Returns the spawn cause of this entity

setSpawnCause

void setSpawnCause(SpawnCause spawnCause)

Set the spawn cause of the entity.

Parameters:

spawnCause - The spawn cause

isNerfed

boolean isNerfed()

Checks if the entity is nerfed or not.

Returns:

True if entity is nerfed, otherwise false.

setNerfed

void setNerfed(boolean nerfed)

Set whether the entity should be nerfed or not.

updateNerfed

void updateNerfed()

Set whether the entity should be nerfed or not using the isNerfed flag.

isNameBlacklisted

boolean isNameBlacklisted()

Checks if the name of the entity is blacklisted.

isInstantKill

boolean isInstantKill(org.bukkit.event.entity.EntityDamageEvent.DamageCause damageCause)

Checks if the entity should be instant-killed or not.

Parameters:

damageCause - The damage to check (can be null)

getDefaultUnstack

int getDefaultUnstack()

Gets the default unstack amount for this entity.

hasNameTag

boolean hasNameTag()

Checks if entity has a name tag.