com.bgsoftware.wildstacker.api.handlers

Interface SystemManager

public interface SystemManager

Method Summary

Modifier and Type	Method and Description
void	addSpawnCondition(SpawnCondition spawnCondition, org.bukkit.entity.EntityType... entityTypes) Add a spawn condition to entities.
void	clearSpawnConditions(org.bukkit.entity.EntityType entityType) Clear all the spawn conditions of an entity.
java.util.List<UnloadedStackedBarrel>	getAllStackedBarrels() Get all the stacked barrels on the server.
java.util.List<UnloadedStackedSpawner>	getAllStackedSpawners() Get all the stacked spawners on the server.
LootTable	getLootTable(org.bukkit.entity.LivingEntity livingEntity) Get a loot-table from a living-entity.
java.util.Optional<SpawnCondition>	getSpawnCondition(java.lang.String id) Get a spawn condition by it's id.
java.util.Collection<SpawnCondition>	getSpawnConditions(org.bukkit.entity.EntityType entityType) Get all the spawn conditions of an entity.
StackedBarrel	getStackedBarrel(org.bukkit.block.Block block) Get the stacked barrel object of a block.
StackedBarrel	getStackedBarrel(org.bukkit.Location location) Get the stacked barrel object of a block by location.
java.util.List<StackedBarrel>	getStackedBarrels() Get all the stacked barrels from cache.
java.util.List<StackedBarrel>	getStackedBarrels(org.bukkit.Chunk chunk) Get all the stacked barrels from cache in a chunk.
java.util.List<StackedBarrel>	getStackedBarrels(org.bukkit.World world, int chunkX, int chunkZ) Get all the stacked barrels from cache in a chunk.
java.util.List<StackedEntity>	getStackedEntities() Get all the stacked entities from cache.
StackedEntity	getStackedEntity(org.bukkit.entity.LivingEntity livingEntity) Get the stacked entity object of a living-entity.
StackedItem	getStackedItem(org.bukkit.entity.Item item) Get the stacked item object of an item.
java.util.List<StackedItem>	getStackedItems() Get all the stacked items from cache.
StackedSnapshot	getStackedSnapshot(org.bukkit.Chunk chunk) Get a stacked snapshot of a chunk.
StackedSnapshot	getStackedSnapshot(org.bukkit.Chunk chunk, boolean loadData) Deprecated. see getStackedSnapshot(Chunk chunk)
StackedSpawner	getStackedSpawner(org.bukkit.block.CreatureSpawner spawner) Get the stacked spawner object of a creature-spawner.
StackedSpawner	getStackedSpawner(org.bukkit.Location location) Get the stacked spawner object of a creature-spawner by location.
java.util.List<StackedSpawner>	getStackedSpawners() Get all the stacked spawners from cache.
java.util.List<StackedSpawner>	getStackedSpawners(org.bukkit.Chunk chunk) Get all the stacked spawners from cache in a chunk.
java.util.List<StackedSpawner>	getStackedSpawners(org.bukkit.World world, int chunkX, int chunkZ) Get all the stacked spawners from cache in a chunk.
boolean	hasEntityNamesToggledOff(org.bukkit.entity.Player player) Check whether or not a player has entity names toggled off.
boolean	hasItemNamesToggledOff(org.bukkit.entity.Player player) Check whether or not a player has item names toggled off.
boolean	isStackedBarrel(org.bukkit.block.Block block) Checks if a block is a stacked barrel.
boolean	isStackedBarrel(org.bukkit.Location location) Checks if a block is a stacked barrel.
boolean	isStackedSpawner(org.bukkit.block.Block block) Checks if a block is a stacked spawner.
boolean	isStackedSpawner(org.bukkit.Location location) Checks if a block is a stacked spawner.
void	performCacheClear() Performs a cache clear.
void	performCacheSave() Performs a cache save.
void	performKillAll() Perform a kill all.
void	performKillAll(boolean applyTaskFilter) Perform a kill all.
void	performKillAll(java.util.function.Predicate<org.bukkit.entity.Entity> entityPredicate, java.util.function.Predicate<org.bukkit.entity.Item> itemPredicate) Perform a kill all.
void	performKillAll(java.util.function.Predicate<org.bukkit.entity.Entity> entityPredicate, java.util.function.Predicate<org.bukkit.entity.Item> itemPredicate, boolean applyTaskFilter) Perform a kill all.
SpawnCondition	registerSpawnCondition(SpawnCondition spawnCondition) Register a new spawn condition into the system.
void	removeSpawnCondition(org.bukkit.entity.EntityType entityType, SpawnCondition spawnCondition) Remove a spawn condition from an entity.
void	removeStackObject(StackedObject stackedObject) Remove a stacked object from cache.
void	spawnCorpse(StackedEntity stackedEntity) Spawn a corpse for a stacked entity.
<T extends org.bukkit.entity.Entity> T	spawnEntityWithoutStacking(org.bukkit.Location location, java.lang.Class<T> type) Spawns a new entity without stacking it.
<T extends org.bukkit.entity.Entity> T	spawnEntityWithoutStacking(org.bukkit.Location location, java.lang.Class<T> type, org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason spawnReason) Deprecated. see spawnEntityWithoutStacking(Location location, Class type, SpawnCause spawnCause)
<T extends org.bukkit.entity.Entity> T	spawnEntityWithoutStacking(org.bukkit.Location location, java.lang.Class<T> type, SpawnCause spawnCause) Spawns a new entity without stacking it.
StackedItem	spawnItemWithAmount(org.bukkit.Location location, org.bukkit.inventory.ItemStack itemStack) Drops an item with the amount of the item stack.
StackedItem	spawnItemWithAmount(org.bukkit.Location location, org.bukkit.inventory.ItemStack itemStack, int amount) Drops an item with a specific amount for the stack.
void	toggleEntityNames(org.bukkit.entity.Player player) Toggle entity names for a player.
void	toggleItemNames(org.bukkit.entity.Player player) Toggle item names for a player.
void	updateLinkedEntity(org.bukkit.entity.LivingEntity livingEntity, org.bukkit.entity.LivingEntity newLivingEntity) Updates all spawners that the entity is linked into.

Method Detail

removeStackObject

void removeStackObject(StackedObject stackedObject)

Remove a stacked object from cache.

Parameters:

stackedObject - the stacked object

getStackedEntity

StackedEntity getStackedEntity(org.bukkit.entity.LivingEntity livingEntity)

Get the stacked entity object of a living-entity.

Parameters:

livingEntity - The living-entity

Returns:

stacked entity object

getStackedItem

StackedItem getStackedItem(org.bukkit.entity.Item item)

Get the stacked item object of an item.

Parameters:

item - The item

Returns:

stacked item object

getStackedSpawner

StackedSpawner getStackedSpawner(org.bukkit.block.CreatureSpawner spawner)

Get the stacked spawner object of a creature-spawner.

Parameters:

spawner - The creature-spawner.

Returns:

stacked spawner object

getStackedSpawner

StackedSpawner getStackedSpawner(org.bukkit.Location location)

Get the stacked spawner object of a creature-spawner by location.

Parameters:

location - The location of the creature-spawner.

Returns:

stacked spawner object

getStackedBarrel

StackedBarrel getStackedBarrel(org.bukkit.block.Block block)

Get the stacked barrel object of a block.

Parameters:

block - The block

Returns:

stacked barrel object

getStackedBarrel

StackedBarrel getStackedBarrel(org.bukkit.Location location)

Get the stacked barrel object of a block by location.

Parameters:

location - The location of the block.

Returns:

stacked barrel object

getStackedEntities

java.util.List<StackedEntity> getStackedEntities()

Get all the stacked entities from cache.

Returns:

A list of stacked entities

getStackedItems

java.util.List<StackedItem> getStackedItems()

Get all the stacked items from cache.

Returns:

A list of stacked items

getStackedSpawners

java.util.List<StackedSpawner> getStackedSpawners()

Get all the stacked spawners from cache.

Returns:

A list of stacked spawners

getStackedSpawners

java.util.List<StackedSpawner> getStackedSpawners(org.bukkit.Chunk chunk)

Get all the stacked spawners from cache in a chunk.

Parameters:

chunk - The chunk to retrieve spawners from.

Returns:

A list of stacked spawners

getStackedSpawners

java.util.List<StackedSpawner> getStackedSpawners(org.bukkit.World world,
                                                  int chunkX,
                                                  int chunkZ)

Get all the stacked spawners from cache in a chunk.

Parameters:

world - The world of the chunk.

chunkX - The chunk's x-coords.

chunkZ - The chunk's z-coords.

Returns:

A list of stacked spawners

getAllStackedSpawners

java.util.List<UnloadedStackedSpawner> getAllStackedSpawners()

Get all the stacked spawners on the server.

Returns:

A list of pairs for locations and stack amounts of the spawners.

getStackedBarrels

java.util.List<StackedBarrel> getStackedBarrels()

Get all the stacked barrels from cache.

Returns:

A list of stacked barrels

getStackedBarrels

java.util.List<StackedBarrel> getStackedBarrels(org.bukkit.Chunk chunk)

Get all the stacked barrels from cache in a chunk.

Parameters:

chunk - The chunk to retrieve barrels from.

Returns:

A list of stacked barrels

getStackedBarrels

java.util.List<StackedBarrel> getStackedBarrels(org.bukkit.World world,
                                                int chunkX,
                                                int chunkZ)

Get all the stacked barrels from cache in a chunk.

Parameters:

world - The world of the chunk.

chunkX - The chunk's x-coords.

chunkZ - The chunk's z-coords.

Returns:

A list of stacked barrels

getAllStackedBarrels

java.util.List<UnloadedStackedBarrel> getAllStackedBarrels()

Get all the stacked barrels on the server.

Returns:

A list of pairs for locations and stack amounts of the barrels.

isStackedSpawner

boolean isStackedSpawner(org.bukkit.block.Block block)

Checks if a block is a stacked spawner.

Returns:

True if block is a stacked spawner, otherwise false

isStackedSpawner

boolean isStackedSpawner(org.bukkit.Location location)

Checks if a block is a stacked spawner.

Parameters:

location - The location of the spawner.

Returns:

True if block is a stacked spawner, otherwise false

isStackedBarrel

boolean isStackedBarrel(org.bukkit.block.Block block)

Checks if a block is a stacked barrel. Unlike isStackedBlock(Location), this will also check if the block is a cauldron.

Returns:

True if block is a stacked barrel, otherwise false

isStackedBarrel

boolean isStackedBarrel(org.bukkit.Location location)

Checks if a block is a stacked barrel.

Parameters:

location - The location of the block.

Returns:

True if block is a stacked barrel, otherwise false

performCacheClear

void performCacheClear()

Performs a cache clear.

performCacheSave

void performCacheSave()

Performs a cache save.

updateLinkedEntity

void updateLinkedEntity(org.bukkit.entity.LivingEntity livingEntity,
                        org.bukkit.entity.LivingEntity newLivingEntity)

Updates all spawners that the entity is linked into.

Parameters:

livingEntity - the entity that is already linked

newLivingEntity - a new entity to be replaced with the old one

spawnEntityWithoutStacking

<T extends org.bukkit.entity.Entity> T spawnEntityWithoutStacking(org.bukkit.Location location,
                                                                  java.lang.Class<T> type)

Spawns a new entity without stacking it. The entity will have a default spawn reason of SPAWNER.

Parameters:

location - the location to spawn the entity at

type - the entity class type

Returns:

The new entity object

spawnEntityWithoutStacking

@Deprecated
<T extends org.bukkit.entity.Entity> T spawnEntityWithoutStacking(org.bukkit.Location location,
                                                                               java.lang.Class<T> type,
                                                                               org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason spawnReason)

Deprecated. see spawnEntityWithoutStacking(Location location, Class type, SpawnCause spawnCause)

Spawns a new entity without stacking it..

Parameters:

location - the location to spawn the entity at

type - the entity class type

spawnReason - the spawn reason to be set in the entity

Returns:

The new entity object

spawnEntityWithoutStacking

<T extends org.bukkit.entity.Entity> T spawnEntityWithoutStacking(org.bukkit.Location location,
                                                                  java.lang.Class<T> type,
                                                                  SpawnCause spawnCause)

Spawns a new entity without stacking it.

Parameters:

location - the location to spawn the entity at

type - the entity class type

spawnCause - the spawn cause to be set in the entity

Returns:

The new entity object

spawnItemWithAmount

StackedItem spawnItemWithAmount(org.bukkit.Location location,
                                org.bukkit.inventory.ItemStack itemStack)

Drops an item with the amount of the item stack.

Parameters:

location - the location to spawn the item at

itemStack - the item to drop.

Returns:

The new item object

spawnItemWithAmount

StackedItem spawnItemWithAmount(org.bukkit.Location location,
                                org.bukkit.inventory.ItemStack itemStack,
                                int amount)

Drops an item with a specific amount for the stack.

Parameters:

location - the location to spawn the item at

itemStack - the item to drop.

amount - the amount of the item to drop.

Returns:

The new item object

spawnCorpse

void spawnCorpse(StackedEntity stackedEntity)

Spawn a corpse for a stacked entity.

Parameters:

stackedEntity - the stacked entity.

performKillAll

void performKillAll()

Perform a kill all.

performKillAll

void performKillAll(boolean applyTaskFilter)

Perform a kill all.

performKillAll

void performKillAll(java.util.function.Predicate<org.bukkit.entity.Entity> entityPredicate,
                    java.util.function.Predicate<org.bukkit.entity.Item> itemPredicate)

Perform a kill all.

performKillAll

void performKillAll(java.util.function.Predicate<org.bukkit.entity.Entity> entityPredicate,
                    java.util.function.Predicate<org.bukkit.entity.Item> itemPredicate,
                    boolean applyTaskFilter)

Perform a kill all.

getLootTable

LootTable getLootTable(org.bukkit.entity.LivingEntity livingEntity)

Get a loot-table from a living-entity.

Parameters:

livingEntity - the living-entity

Returns:

loot-table

getStackedSnapshot

@Deprecated
StackedSnapshot getStackedSnapshot(org.bukkit.Chunk chunk,
                                                boolean loadData)

Deprecated. see getStackedSnapshot(Chunk chunk)

Get a stacked snapshot of a chunk.

Parameters:

chunk - The chunk

loadData - Should data be loaded if isn't already?

Returns:

StackedSnapshot object

getStackedSnapshot

StackedSnapshot getStackedSnapshot(org.bukkit.Chunk chunk)

Get a stacked snapshot of a chunk.

Parameters:

chunk - The chunk

Returns:

StackedSnapshot object

hasItemNamesToggledOff

boolean hasItemNamesToggledOff(org.bukkit.entity.Player player)

Check whether or not a player has item names toggled off.

Parameters:

player - The player to check.

toggleItemNames

void toggleItemNames(org.bukkit.entity.Player player)

Toggle item names for a player.

Parameters:

player - The player to toggle for.

hasEntityNamesToggledOff

boolean hasEntityNamesToggledOff(org.bukkit.entity.Player player)

Check whether or not a player has entity names toggled off.

Parameters:

player - The player to check.

toggleEntityNames

void toggleEntityNames(org.bukkit.entity.Player player)

Toggle entity names for a player.

Parameters:

player - The player to toggle for.

addSpawnCondition

void addSpawnCondition(SpawnCondition spawnCondition,
                       org.bukkit.entity.EntityType... entityTypes)

Add a spawn condition to entities.

Parameters:

spawnCondition - The spawn condition to add.

entityTypes - All the entity types to add the spawn condition to.

getSpawnConditions

java.util.Collection<SpawnCondition> getSpawnConditions(org.bukkit.entity.EntityType entityType)

Get all the spawn conditions of an entity.

Parameters:

entityType - The entity's type.

removeSpawnCondition

void removeSpawnCondition(org.bukkit.entity.EntityType entityType,
                          SpawnCondition spawnCondition)

Remove a spawn condition from an entity.

Parameters:

entityType - The entity's type

spawnCondition - The spawn condition to remove.

clearSpawnConditions

void clearSpawnConditions(org.bukkit.entity.EntityType entityType)

Clear all the spawn conditions of an entity.

Parameters:

entityType - The entity's type.

getSpawnCondition

java.util.Optional<SpawnCondition> getSpawnCondition(java.lang.String id)

Get a spawn condition by it's id.

Parameters:

id - The id of the spawn condition.

registerSpawnCondition

SpawnCondition registerSpawnCondition(SpawnCondition spawnCondition)

Register a new spawn condition into the system. If a spawn condition already exists with a similar id, the new one will override the old one.

Parameters:

spawnCondition - The spawn condition to register.