Skip to main content
The UpgradesManager handles island upgrades, including registering custom upgrades and upgrade cost loaders.

​
Methods

​
getUpgrade (By Name)

Upgrade getUpgrade(String upgradeName)
Get an upgrade by its name.
​
upgradeName
String
required
The name of the upgrade
​
return
Upgrade
The upgrade instance or null if not found

​
getUpgrade (By Slot)

Upgrade getUpgrade(int slot)
Get an upgrade by its menu slot.
​
slot
int
required
The slot of the upgrade
​
return
Upgrade
The upgrade instance or null if not found

​
addUpgrade

void addUpgrade(Upgrade upgrade)
Add a new upgrade.
​
upgrade
Upgrade
required
The upgrade to add

​
getDefaultUpgrade

Upgrade getDefaultUpgrade()
Get an upgrade object that contains all the default values from config.
​
return
Upgrade
The default upgrade configuration

​
isUpgrade

boolean isUpgrade(String upgradeName)
Check whether or not an upgrade with the provided name exists or not.
​
upgradeName
String
required
The name to check
​
return
boolean
True if the upgrade exists, false otherwise

​
getUpgrades

Collection<Upgrade> getUpgrades()
Get all the upgrades of the plugin.
​
return
Collection<Upgrade>
Collection of all upgrades

​
Upgrade Cost Loaders

​
registerUpgradeCostLoader

void registerUpgradeCostLoader(String id, UpgradeCostLoader costLoader)
Register custom upgrade cost loader.
​
id
String
required
The id of the loader
​
costLoader
UpgradeCostLoader
required
The loader you’re registering

​
getUpgradesCostLoaders

Collection<UpgradeCostLoader> getUpgradesCostLoaders()
Get all registered cost loaders.
​
return
Collection<UpgradeCostLoader>
Collection of all registered cost loaders

​
getUpgradeCostLoader

UpgradeCostLoader getUpgradeCostLoader(String id)
Get upgrade cost loader by its id.
​
id
String
required
The id of the cost loader
​
return
UpgradeCostLoader
The cost loader or null if not found