Package wtf.choco.veinminer.pattern

Class PatternDefault

java.lang.Object

wtf.choco.veinminer.pattern.PatternDefault

All Implemented Interfaces:

org.bukkit.Keyed, VeinMiningPattern

public final class PatternDefault
extends Object
implements VeinMiningPattern

The default VeinMiningPattern implementation used by all players unless explicitly set.

Author:

Parker Hawke - 2008Choco

Method Summary

Modifier and Type	Method	Description
void	allocateBlocks(Set<org.bukkit.block.Block> blocks, VeinBlock type, org.bukkit.block.Block origin, ToolCategory category, MaterialAlias alias)	Allocate the blocks that should be broken by the vein mining pattern.
static PatternDefault	get()	Get a singleton instance of the default pattern.
org.bukkit.NamespacedKey	getKey()

Methods inherited from class java.lang.Object

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

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

allocateBlocks

Method Detail

allocateBlocks

public void allocateBlocks(Set<org.bukkit.block.Block> blocks,
                           VeinBlock type,
                           org.bukkit.block.Block origin,
                           ToolCategory category,
                           MaterialAlias alias)

Description copied from interface: VeinMiningPattern

Allocate the blocks that should be broken by the vein mining pattern. Note that the breaking of the blocks should not be handled by the pattern, but rather the plugin itself. This method serves primarily to search for valid blocks to break in a vein.

NOTE: If null is added to the "blocks" set, a NullPointerException will be thrown and the method will fail.

Specified by:

allocateBlocks in interface VeinMiningPattern

Parameters:

blocks - a set of all blocks to break. Valid blocks should be added here. The "origin" block passed to this method will be added automatically

type - the type of VeinBlock being vein mined

origin - the block where the vein mine was initiated

category - the tool category used to break the block

alias - an alias of the block being broken if one exists. May be null

getKey

public org.bukkit.NamespacedKey getKey()

Specified by:

getKey in interface org.bukkit.Keyed

get

public static PatternDefault get()

Get a singleton instance of the default pattern.

Returns:

the default pattern