Class PlanetModeChangeEvent

java.lang.Object

org.bukkit.event.Event

ua.mcchickenstudio.opencreative.events.CreativeEvent

ua.mcchickenstudio.opencreative.events.planet.PlanetEvent

ua.mcchickenstudio.opencreative.events.planet.PlanetModeChangeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class PlanetModeChangeEvent
extends PlanetEvent
implements org.bukkit.event.Cancellable

Called when planet's mode will be changed.

If a Planet Mode Change event is cancelled, it will not change planet's mode.

NOTE: It's not recommended to cancel event, when the PlanetModeChangeEvent.Cause is CODE, because this cause is required to stop code running due to critical errors in code. Plugins should check is player a cause of Planet Mode Change event. Planet can be unloaded at the moment of mode change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlanetModeChangeEvent.Cause

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
PlanetModeChangeEvent(@NotNull Planet planet, Planet.Mode oldMode, Planet.Mode newMode)
PlanetModeChangeEvent(@NotNull Planet planet, Planet.Mode oldMode, Planet.Mode newMode, org.bukkit.entity.Player player)

Method Summary

Modifier and Type	Method	Description
@NotNull PlanetModeChangeEvent.Cause	getCause()
Planet.Mode	getNewMode()
Planet.Mode	getOldMode()
@Nullable org.bukkit.entity.Player	getPlayer()
boolean	isCancelled()
void	setCancelled(boolean cancel)

Methods inherited from class PlanetEvent

getPlanet

Modifier and Type	Method	Description
@NotNull Planet	getPlanet()

Methods inherited from class CreativeEvent

getHandlerList, getHandlers

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

PlanetModeChangeEvent

public PlanetModeChangeEvent(@NotNull
 @NotNull Planet planet,
 Planet.Mode oldMode,
 Planet.Mode newMode)

PlanetModeChangeEvent

public PlanetModeChangeEvent(@NotNull
 @NotNull Planet planet,
 Planet.Mode oldMode,
 Planet.Mode newMode,
 org.bukkit.entity.Player player)

Method Details

getOldMode

@NotNull
public Planet.Mode getOldMode()

getNewMode

@NotNull
public Planet.Mode getNewMode()

getPlayer

@Nullable
public @Nullable org.bukkit.entity.Player getPlayer()

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getCause

@NotNull
public @NotNull PlanetModeChangeEvent.Cause getCause()