Package wtf.choco.veinminer.api.event.player

Class PlayerVeinMiningPatternChangeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

wtf.choco.veinminer.api.event.player.PlayerVeinMiningPatternChangeEvent

All Implemented Interfaces:

Cancellable, PatternChangeEvent

public final class PlayerVeinMiningPatternChangeEvent
extends PlayerEvent
implements Cancellable, PatternChangeEvent

Called when a Player changes their VeinMiningPattern either by command or with the client-sided mod.

Nested Class Summary

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

Event.Result

Nested classes/interfaces inherited from interface wtf.choco.veinminer.api.event.player.PatternChangeEvent

PatternChangeEvent.Cause

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerVeinMiningPatternChangeEvent(@NotNull Player player, @NotNull VeinMiningPattern pattern, @NotNull VeinMiningPattern newPattern, @NotNull PatternChangeEvent.Cause cause)	Construct a new PlayerVeinMiningPatternChangeEvent.

Method Summary

Modifier and Type	Method	Description
@NotNull PatternChangeEvent.Cause	getCause()	Get the Cause of this event.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull VeinMiningPattern	getNewPattern()	Get the VeinMiningPattern to change to.
@NotNull VeinMiningPattern	getPattern()	Get the player's current VeinMiningPattern.
boolean	isCancelled()	Checks whether or not this event has been cancelled.
void	setCancelled(boolean cancelled)
void	setNewPattern(@NotNull VeinMiningPattern newPattern)	Set the VeinMiningPattern to change to.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

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 Details

PlayerVeinMiningPatternChangeEvent

public PlayerVeinMiningPatternChangeEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull VeinMiningPattern pattern,
 @NotNull
 @NotNull VeinMiningPattern newPattern,
 @NotNull
 @NotNull PatternChangeEvent.Cause cause)

Construct a new PlayerVeinMiningPatternChangeEvent.

Parameters:

player - the player whose pattern was changed

pattern - the player's current pattern

newPattern - the pattern to be set

cause - the cause of this event

Method Details

getPattern

@NotNull
public @NotNull VeinMiningPattern getPattern()

Get the player's current VeinMiningPattern.

Returns:

the current pattern

setNewPattern

public void setNewPattern(@NotNull
 @NotNull VeinMiningPattern newPattern)

Set the VeinMiningPattern to change to.

Parameters:

newPattern - the new pattern

getNewPattern

@NotNull
public @NotNull VeinMiningPattern getNewPattern()

Description copied from interface: PatternChangeEvent

Get the VeinMiningPattern to change to.

Specified by:

getNewPattern in interface PatternChangeEvent

Returns:

the new pattern

getCause

@NotNull
public @NotNull PatternChangeEvent.Cause getCause()

Description copied from interface: PatternChangeEvent

Get the Cause of this event.

Specified by:

getCause in interface PatternChangeEvent

Returns:

the cause

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface Cancellable

isCancelled

public boolean isCancelled()

Description copied from interface: PatternChangeEvent

Checks whether or not this event has been cancelled.

Specified by:

isCancelled in interface Cancellable

Specified by:

isCancelled in interface PatternChangeEvent

Returns:

true if cancelled, false otherwise

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()