com.bgsoftware.wildstacker.api.upgrades

Interface SpawnerUpgrade

public interface SpawnerUpgrade

Method Summary

Modifier and Type	Method and Description
double	getCost() Get the cost of the upgrade.
java.lang.String	getDisplayName() Get the display name of the upgrade.
org.bukkit.inventory.ItemStack	getIcon() Get the icon of the upgrade that is displayed on the upgrade menu.
int	getId() Get the id of the upgrade.
int	getMaxNearbyEntities() Get the maximum nearby entities allowed around spawners.
int	getMaxSpawnDelay() Get the maximum spawn delay of spawners.
int	getMinSpawnDelay() Get the minimum spawn delay of spawners.
java.lang.String	getName() Get the name of the upgrade.
SpawnerUpgrade	getNextUpgrade() Get the next upgrade in the ladder.
int	getRequiredPlayerRange() Get the required player range from spawners.
int	getSpawnCount() Get the entities spawn count of spawners.
int	getSpawnRange() Get the spawn range of spawners.
boolean	isDefault() Check if this upgrade is a default upgrade.
boolean	isEntityAllowed(org.bukkit.entity.EntityType entityType) Check if an entity is allowed to be upgraded to this upgrade.
void	setAllowedEntities(java.util.List<java.lang.String> allowedEntities) Set all the allowed entities for this upgrade.
void	setCost(double cost) Set the cost of the upgrade.
void	setDisplayName(java.lang.String displayName) Set the display name of the upgrade.
void	setIcon(org.bukkit.inventory.ItemStack icon) Set the icon of the upgrade that will be displayed on the upgrade menu.
void	setMaxNearbyEntities(int maxNearbyEntities) Set the maximum nearby entities allowed around spawners.
void	setMaxSpawnDelay(int maxSpawnDelay) Set the maximum spawn delay of spwaners.
void	setMinSpawnDelay(int minSpawnDelay) Set the minimum spawn delay of spawners.
void	setNextUpgrade(SpawnerUpgrade nextUpgrade) Set the next upgrade in the ladder.
void	setRequiredPlayerRange(int requiredPlayerRange) Set the required player range from spawners.
void	setSpawnCount(int spawnCount) Set the maximum spawn count of spawners.
void	setSpawnRange(int spawnRange) Set the spawn range of spawners.

Method Detail

getName

java.lang.String getName()

Get the name of the upgrade.

getId

int getId()

Get the id of the upgrade.

isDefault

boolean isDefault()

Check if this upgrade is a default upgrade.

Returns:

This returns true if the id is set to 0.

getNextUpgrade

SpawnerUpgrade getNextUpgrade()

Get the next upgrade in the ladder. If null, it means that this upgrade is the last in the ladder.

setNextUpgrade

void setNextUpgrade(SpawnerUpgrade nextUpgrade)

Set the next upgrade in the ladder.

Parameters:

nextUpgrade - The next upgrade to set.

getIcon

org.bukkit.inventory.ItemStack getIcon()

Get the icon of the upgrade that is displayed on the upgrade menu. The returned icon will be parsed with all the upgrade's data.

setIcon

void setIcon(org.bukkit.inventory.ItemStack icon)

Set the icon of the upgrade that will be displayed on the upgrade menu. If set to null, the default icon will be used.

Parameters:

icon - The icon to set.

getCost

double getCost()

Get the cost of the upgrade.

setCost

void setCost(double cost)

Set the cost of the upgrade. If you want this upgrade to be free of charge, use 0 or below.

Parameters:

cost - The cost to set.

getDisplayName

java.lang.String getDisplayName()

Get the display name of the upgrade.

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of the upgrade.

Parameters:

displayName - The display name.

isEntityAllowed

boolean isEntityAllowed(org.bukkit.entity.EntityType entityType)

Check if an entity is allowed to be upgraded to this upgrade.

Parameters:

entityType - The type of the entity.

setAllowedEntities

void setAllowedEntities(java.util.List<java.lang.String> allowedEntities)

Set all the allowed entities for this upgrade. If the list is null or empty, all the entities will be allowed.

Parameters:

allowedEntities - The allowed entities.

getMinSpawnDelay

int getMinSpawnDelay()

Get the minimum spawn delay of spawners.

setMinSpawnDelay

void setMinSpawnDelay(int minSpawnDelay)

Set the minimum spawn delay of spawners.

Parameters:

minSpawnDelay - The minimum spawn delay.

getMaxSpawnDelay

int getMaxSpawnDelay()

Get the maximum spawn delay of spawners.

setMaxSpawnDelay

void setMaxSpawnDelay(int maxSpawnDelay)

Set the maximum spawn delay of spwaners.

Parameters:

maxSpawnDelay - The maximum spawn delay.

getSpawnCount

int getSpawnCount()

Get the entities spawn count of spawners.

setSpawnCount

void setSpawnCount(int spawnCount)

Set the maximum spawn count of spawners.

Parameters:

spawnCount - The spawn count.

getMaxNearbyEntities

int getMaxNearbyEntities()

Get the maximum nearby entities allowed around spawners.

setMaxNearbyEntities

void setMaxNearbyEntities(int maxNearbyEntities)

Set the maximum nearby entities allowed around spawners.

Parameters:

maxNearbyEntities - The maximum allowed nearby entities.

getRequiredPlayerRange

int getRequiredPlayerRange()

Get the required player range from spawners.

setRequiredPlayerRange

void setRequiredPlayerRange(int requiredPlayerRange)

Set the required player range from spawners.

Parameters:

requiredPlayerRange - The required player range.

getSpawnRange

int getSpawnRange()

Get the spawn range of spawners.

setSpawnRange

void setSpawnRange(int spawnRange)

Set the spawn range of spawners.

Parameters:

spawnRange - The spawn range.