Package wtf.choco.veinminer.util

Class VMEventFactory

java.lang.Object

wtf.choco.veinminer.util.VMEventFactory

public final class VMEventFactory
extends Object

A collection of factory methods for VeinMiner events.

Method Summary

Modifier and Type	Method	Description
static @NotNull PlayerVeinMineEvent	callPlayerVeinMineEvent(@NotNull Player player, @NotNull Block block, @NotNull VeinMinerBlock veinMinerBlock, @Nullable ItemStack item, @NotNull VeinMinerToolCategory category, @NotNull Set<Block> blocks, @NotNull VeinMiningPattern pattern)	Call the PlayerVeinMineEvent.
static @NotNull PlayerVeinMiningPatternChangeEvent	callPlayerVeinMiningPatternChangeEvent(@NotNull Player player, @NotNull VeinMiningPattern currentPattern, @NotNull VeinMiningPattern newPattern, PatternChangeEvent.Cause cause)	Call the PlayerVeinMiningPatternChangeEvent.
static boolean	handlePlayerClientActivateVeinMinerEvent(@NotNull Player player, boolean activated)	Call the PlayerClientActivateVeinMinerEvent.

Methods inherited from class java.lang.Object

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

Method Details

callPlayerVeinMineEvent

@NotNull
public static @NotNull PlayerVeinMineEvent callPlayerVeinMineEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Block block,
 @NotNull
 @NotNull VeinMinerBlock veinMinerBlock,
 @Nullable
 @Nullable ItemStack item,
 @NotNull
 @NotNull VeinMinerToolCategory category,
 @NotNull
 @NotNull Set<Block> blocks,
 @NotNull
 @NotNull VeinMiningPattern pattern)

Call the PlayerVeinMineEvent.

Parameters:

player - the player

block - the origin block that was broken by the player

veinMinerBlock - the type of block being vein mined

item - the item used to vein mine

category - the tool category

blocks - the blocks being vein mined

pattern - the pattern being used to vein mine

Returns:

the event

handlePlayerClientActivateVeinMinerEvent

public static boolean handlePlayerClientActivateVeinMinerEvent(@NotNull
 @NotNull Player player,
 boolean activated)

Call the PlayerClientActivateVeinMinerEvent.

Parameters:

player - the player

activated - the new activation state

Returns:

true if not cancelled, false if cancelled

callPlayerVeinMiningPatternChangeEvent

@NotNull
public static @NotNull PlayerVeinMiningPatternChangeEvent callPlayerVeinMiningPatternChangeEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull VeinMiningPattern currentPattern,
 @NotNull
 @NotNull VeinMiningPattern newPattern,
 @NotNull
 PatternChangeEvent.Cause cause)

Call the PlayerVeinMiningPatternChangeEvent.

Parameters:

player - the player whose pattern was changed

currentPattern - the player's current pattern

newPattern - the pattern to be set

cause - the cause of the event

Returns:

the called event