Package org.geysermc.geyser.api.item.custom.v2.component.java

Interface JavaTool.Rule

Enclosing interface:

JavaTool

public static interface JavaTool.Rule

A rule for a tool. Consists of a Holders of block identifiers, and a speed to use for those blocks.

Since:

2.9.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JavaTool.Rule.Builder	Builder for a tool rule.

Method Summary

Modifier and Type	Method	Description
Holders	blocks()
static JavaTool.Rule.Builder	builder()	Creates a builder for a tool rule.
static JavaTool.Rule	of(Holders blocks, @org.checkerframework.checker.index.qual.Positive float speed)	Creates a rule consisting of the given blocks and the given speed.
float	speed()

Method Details

blocks

Holders blocks()

Returns:

the Holders of block identifiers that this rule is for

Since:

2.9.3

speed

float speed()

Returns:

the speed to use when mining a block that matches this rule

Since:

2.9.3

builder

static JavaTool.Rule.Builder builder()

Creates a builder for a tool rule.

Returns:

a new builder

Since:

2.9.3

of

static JavaTool.Rule of(Holders blocks,
 @org.checkerframework.checker.index.qual.Positive float speed)

Creates a rule consisting of the given blocks and the given speed.

Parameters:

blocks - the Holders of block identifiers that this rule is for

speed - the speed to use when mining a block that matches this rule

Returns:

a tool rule

Since:

2.9.3