com.bgsoftware.superiorskyblock.api.events

Class IslandClearGeneratorRatesEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandClearGeneratorRatesEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

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

IslandClearGeneratorRatesEvent is called when clearing generator-rates of an island.

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
IslandClearGeneratorRatesEvent(SuperiorPlayer superiorPlayer, Island island, org.bukkit.World.Environment environment) The constructor of the event.

Method Summary

Modifier and Type	Method and Description
org.bukkit.World.Environment	getEnvironment() Get the environment of the world that the rates were cleared for.
SuperiorPlayer	getPlayer() Get the player that cleared the generator-rates.
boolean	isCancelled()
void	setCancelled(boolean cancelled)

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

IslandClearGeneratorRatesEvent

public IslandClearGeneratorRatesEvent(@Nullable
                                      SuperiorPlayer superiorPlayer,
                                      Island island,
                                      org.bukkit.World.Environment environment)

The constructor of the event.

Parameters:

superiorPlayer - The player that cleared the generator-rates of an island. If set to null, it means the rates were cleared via the console.

island - The island that the generator-rates were cleared for.

environment - The environment of the world that the rates were cleared for.

Method Detail

getPlayer

@Nullable
public SuperiorPlayer getPlayer()

Get the player that cleared the generator-rates. If null, it means the rates were cleared by console.

getEnvironment

public org.bukkit.World.Environment getEnvironment()

Get the environment of the world that the rates were cleared for.

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