Package wtf.choco.veinminer.pattern

Class VeinMiningPatternStaircase

java.lang.Object

wtf.choco.veinminer.pattern.VeinMiningPatternStaircase

All Implemented Interfaces:

VeinMiningPattern

public final class VeinMiningPatternStaircase
extends Object
implements VeinMiningPattern

A staircase VeinMiningPattern that digs a 1x3 column either upwards or downwards.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VeinMiningPatternStaircase.Direction	Represents the direction in which a VeinMiningPatternStaircase may mine.

Constructor Summary

Constructors

Constructor	Description
VeinMiningPatternStaircase(@NotNull VeinMiningPatternStaircase.Direction direction)	Construct a new VeinMiningPatternStaircase.

Method Summary

Modifier and Type	Method	Description
@NotNull Set<BlockPosition>	allocateBlocks(@NotNull BlockAccessor blockAccessor, @NotNull BlockPosition origin, @NotNull BlockFace destroyedFace, @NotNull VeinMinerBlock block, @NotNull VeinMiningConfig config, @Nullable BlockList aliasList)	Allocate all BlockPositions that should be mined according to the input values.
@NotNull NamespacedKey	getKey()	Get the NamespacedKey of this pattern.
@Nullable String	getPermission()	Get the permission node required to use this pattern.

Methods inherited from class java.lang.Object

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

Methods inherited from interface wtf.choco.veinminer.pattern.VeinMiningPattern

allocateBlocks

Constructor Details

VeinMiningPatternStaircase

public VeinMiningPatternStaircase(@NotNull
 @NotNull VeinMiningPatternStaircase.Direction direction)

Construct a new VeinMiningPatternStaircase.

Parameters:

direction - the direction of the staircase

Method Details

getKey

@NotNull
public @NotNull NamespacedKey getKey()

Description copied from interface: VeinMiningPattern

Get the NamespacedKey of this pattern.

Specified by:

getKey in interface VeinMiningPattern

Returns:

the key

allocateBlocks

@NotNull
public @NotNull Set<BlockPosition> allocateBlocks(@NotNull
 @NotNull BlockAccessor blockAccessor,
 @NotNull
 @NotNull BlockPosition origin,
 @NotNull
 @NotNull BlockFace destroyedFace,
 @NotNull
 @NotNull VeinMinerBlock block,
 @NotNull
 @NotNull VeinMiningConfig config,
 @Nullable
 @Nullable BlockList aliasList)

Description copied from interface: VeinMiningPattern

Allocate all BlockPositions that should be mined according to the input values.

Specified by:

allocateBlocks in interface VeinMiningPattern

Parameters:

blockAccessor - the block accessor

origin - the position at which the vein mining was initiated

destroyedFace - the face on which the block was destroyed

block - the type of VeinMinerBlock that was broken at the origin

config - the configuration applicable for this instance of vein mining

aliasList - a BlockList of all blocks that should also be considered. May be empty

Returns:

the allocated block positions

getPermission

@Nullable
public @Nullable String getPermission()

Description copied from interface: VeinMiningPattern

Get the permission node required to use this pattern.

Specified by:

getPermission in interface VeinMiningPattern

Returns:

the permission node, or null if none