com.bgsoftware.superiorskyblock.api.events

Class IslandUpgradeEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandUpgradeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class IslandUpgradeEvent
extends IslandEvent
implements org.bukkit.event.Cancellable

IslandCreateEvent is called when a new island is created.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class com.bgsoftware.superiorskyblock.api.events.IslandEvent

island

Constructor Summary

Constructors

Constructor and Description
IslandUpgradeEvent(SuperiorPlayer superiorPlayer, Island island, java.lang.String upgradeName, java.util.List<java.lang.String> commands, UpgradeCost upgradeCost) Deprecated. See IslandUpgradeEvent(SuperiorPlayer, Island, Upgrade, UpgradeLevel, List, UpgradeCost)
IslandUpgradeEvent(SuperiorPlayer superiorPlayer, Island island, Upgrade upgrade, UpgradeLevel upgradeLevel, java.util.List<java.lang.String> commands, UpgradeCost upgradeCost) The constructor for the event.

Method Summary

Modifier and Type	Method and Description
double	getAmountToWithdraw() Deprecated. See getCost()
java.util.List<java.lang.String>	getCommands() Get the commands that will be ran upon upgrade.
java.math.BigDecimal	getCost() Get the amount that will be withdrawn.
SuperiorPlayer	getPlayer() Get the player who upgraded the island.
Upgrade	getUpgrade() Get the name of the upgrade.
UpgradeCost	getUpgradeCost() Get the upgrade cost that is used.
UpgradeLevel	getUpgradeLevel() Get the level that will be upgraded to.
java.lang.String	getUpgradeName() Get the name of the upgrade.
boolean	isCancelled()
void	setAmountToWithdraw(double amountToWithdraw) Deprecated. See setCost(BigDecimal)
void	setCancelled(boolean cancelled)
void	setCost(java.math.BigDecimal cost) Set the amount that will be withdrawn.
void	setUpgradeCost(UpgradeCost upgradeCost) Set a new upgrade cost to be used.

Methods inherited from class com.bgsoftware.superiorskyblock.api.events.IslandEvent

getHandlerList, getHandlers, getIsland

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IslandUpgradeEvent

@Deprecated
public IslandUpgradeEvent(@Nullable
                                       SuperiorPlayer superiorPlayer,
                                       Island island,
                                       java.lang.String upgradeName,
                                       java.util.List<java.lang.String> commands,
                                       @Nullable
                                       UpgradeCost upgradeCost)

Deprecated. See IslandUpgradeEvent(SuperiorPlayer, Island, Upgrade, UpgradeLevel, List, UpgradeCost)

The constructor for the event.

Parameters:

superiorPlayer - The player who upgraded the island. Can be null if ran by the console.

island - The island that was upgraded.

upgradeName - The name of the upgrade.

commands - The commands that will be ran upon upgrade.

upgradeCost - The cost of the upgrade

IslandUpgradeEvent

public IslandUpgradeEvent(@Nullable
                          SuperiorPlayer superiorPlayer,
                          Island island,
                          Upgrade upgrade,
                          UpgradeLevel upgradeLevel,
                          java.util.List<java.lang.String> commands,
                          @Nullable
                          UpgradeCost upgradeCost)

The constructor for the event.

Parameters:

superiorPlayer - The player who upgraded the island. Can be null if ran by the console.

island - The island that was upgraded.

upgrade - The upgrade.

upgradeLevel - The level that will be upgraded into.

commands - The commands that will be running upon upgrade.

upgradeCost - The cost of the upgrade. If null, there was no cost for the upgrade (For example, setupgrade command).

Method Detail

getPlayer

@Nullable
public SuperiorPlayer getPlayer()

Get the player who upgraded the island. Can be null if ran by the console.

getUpgradeName

public java.lang.String getUpgradeName()

Get the name of the upgrade.

getUpgrade

public Upgrade getUpgrade()

Get the name of the upgrade.

getUpgradeLevel

public UpgradeLevel getUpgradeLevel()

Get the level that will be upgraded to.

getCommands

public java.util.List<java.lang.String> getCommands()

Get the commands that will be ran upon upgrade.

getUpgradeCost

@Nullable
public UpgradeCost getUpgradeCost()

Get the upgrade cost that is used.

setUpgradeCost

public void setUpgradeCost(@Nullable
                           UpgradeCost upgradeCost)

Set a new upgrade cost to be used.

Parameters:

upgradeCost - The new upgrade cost.

getAmountToWithdraw

@Deprecated
public double getAmountToWithdraw()

Deprecated. See getCost()

Get the amount that will be withdrawn.

setAmountToWithdraw

@Deprecated
public void setAmountToWithdraw(double amountToWithdraw)

Deprecated. See setCost(BigDecimal)

Set the amount that will be withdrawn.

getCost

public java.math.BigDecimal getCost()

Get the amount that will be withdrawn.

setCost

public void setCost(java.math.BigDecimal cost)
             throws java.lang.IllegalStateException

Set the amount that will be withdrawn.

Parameters:

cost - The new amount to be withdrawn.

Throws:

java.lang.IllegalStateException - If the upgradeCost is null. Use setUpgradeCost(UpgradeCost) instead.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable