Package wtf.choco.veinminer.pattern

Class VeinMiningPatternTunnel

java.lang.Object

wtf.choco.veinminer.pattern.VeinMiningPatternTunnel

All Implemented Interfaces:

VeinMiningPattern

public final class VeinMiningPatternTunnel
extends Object
implements VeinMiningPattern

A tunnel VeinMiningPattern that mines a square tunnel in a direction.

Constructor Summary

Constructors

Constructor	Description
VeinMiningPatternTunnel()	Construct a new VeinMiningPatternTunnel with the default tunnel radius of 1.
VeinMiningPatternTunnel(int radius)	Construct a new VeinMiningPatternTunnel.

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

VeinMiningPatternTunnel

public VeinMiningPatternTunnel(int radius)

Construct a new VeinMiningPatternTunnel.

Parameters:

radius - the radius of the tunnel in blocks (excluding the center block).

VeinMiningPatternTunnel

public VeinMiningPatternTunnel()

Construct a new VeinMiningPatternTunnel with the default tunnel radius of 1.

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