Package org.spongepowered.api.data.type

Interface ToolRule

public interface ToolRule

A tool rule that applied via Keys.TOOL_RULES to an ItemStack determines what block types can be mined at what speed and whether they drop items.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ToolRule.Factory

Method Summary

Modifier and Type	Method	Description
Set<BlockType>	blocks()	Returns the block types this rule applies to.
static ToolRule	deniesDrops(List<BlockType> blocks)
static ToolRule	deniesDrops(Tag<BlockType> blockTypeTag)
Optional<Boolean>	drops()	Returns the drops override.
static ToolRule	forBlocks(List<BlockType> blocks, @Nullable Double speed, @Nullable Boolean drops)
static ToolRule	forTag(Tag<BlockType> blockTypeTag, @Nullable Double speed, @Nullable Boolean drops)
static ToolRule	minesAndDrops(List<BlockType> blocks, double speed)
static ToolRule	minesAndDrops(Tag<BlockType> blockTypeTag, double speed)
static ToolRule	overrideSpeed(List<BlockType> blocks, double speed)
static ToolRule	overrideSpeed(Tag<BlockType> blockTypeTag, double speed)
Optional<Double>	speed()	Returns the speed override.

Method Details

minesAndDrops

static ToolRule minesAndDrops(List<BlockType> blocks,
 double speed)

minesAndDrops

static ToolRule minesAndDrops(Tag<BlockType> blockTypeTag,
 double speed)

deniesDrops

static ToolRule deniesDrops(List<BlockType> blocks)

deniesDrops

static ToolRule deniesDrops(Tag<BlockType> blockTypeTag)

overrideSpeed

static ToolRule overrideSpeed(List<BlockType> blocks,
 double speed)

overrideSpeed

static ToolRule overrideSpeed(Tag<BlockType> blockTypeTag,
 double speed)

forBlocks

static ToolRule forBlocks(List<BlockType> blocks,
 @Nullable Double speed,
 @Nullable Boolean drops)

forTag

static ToolRule forTag(Tag<BlockType> blockTypeTag,
 @Nullable Double speed,
 @Nullable Boolean drops)

blocks

Set<BlockType> blocks()

Returns the block types this rule applies to.

Returns:

the affected blocks

speed

Optional<Double> speed()

Returns the speed override.

If present overrides the default mining speed.

Returns:

the speed override

drops

Optional<Boolean> drops()

Returns the drops override.

If present determines whether a block mined with this rule drops its item

Returns:

the drops override