com.bgsoftware.superiorskyblock.api.handlers

Interface UpgradesManager

public interface UpgradesManager

Method Summary

Modifier and Type	Method and Description
void	addUpgrade(Upgrade upgrade) Add a new upgrade.
Upgrade	getDefaultUpgrade() Get an upgrade object that contains all the default values from config.
Upgrade	getUpgrade(int slot) Get an upgrade by it's menu slot.
Upgrade	getUpgrade(java.lang.String upgradeName) Get an upgrade by it's name.
UpgradeCostLoader	getUpgradeCostLoader(java.lang.String id) Get upgrade cost loader by its id
java.util.Collection<Upgrade>	getUpgrades() Get all the upgrades of the plugin.
java.util.Collection<UpgradeCostLoader>	getUpgradesCostLoaders() Get all registered cost loader
boolean	isUpgrade(java.lang.String upgradeName) Check whether or not an upgrade with the provided name exists or not.
void	registerUpgradeCostLoader(java.lang.String id, UpgradeCostLoader costLoader) Register custom upgrade cost loader

Method Detail

getUpgrade

@Nullable
Upgrade getUpgrade(java.lang.String upgradeName)

Get an upgrade by it's name.

Parameters:

upgradeName - The name of the upgrade.

getUpgrade

@Nullable
Upgrade getUpgrade(int slot)

Get an upgrade by it's menu slot.

Parameters:

slot - The slot of the upgrade.

addUpgrade

void addUpgrade(Upgrade upgrade)

Add a new upgrade.

Parameters:

upgrade - The upgrade to add.

getDefaultUpgrade

Upgrade getDefaultUpgrade()

Get an upgrade object that contains all the default values from config.

isUpgrade

boolean isUpgrade(java.lang.String upgradeName)

Check whether or not an upgrade with the provided name exists or not.

Parameters:

upgradeName - The name to check.

getUpgrades

java.util.Collection<Upgrade> getUpgrades()

Get all the upgrades of the plugin.

registerUpgradeCostLoader

void registerUpgradeCostLoader(java.lang.String id,
                               UpgradeCostLoader costLoader)

Register custom upgrade cost loader

Parameters:

id - The id of the loader.

costLoader - the loader you're registering

getUpgradesCostLoaders

java.util.Collection<UpgradeCostLoader> getUpgradesCostLoaders()

Get all registered cost loader

getUpgradeCostLoader

@Nullable
UpgradeCostLoader getUpgradeCostLoader(java.lang.String id)

Get upgrade cost loader by its id