Interface RuleBasedStateProvider

All Superinterfaces:

BlockStateProvider, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface RuleBasedStateProvider
extends BlockStateProvider

A provider that provides a block and block state depending on the block that currently exists in the world using a series of rules.

Since:

3.0.0

See Also:

• Rule-based block state provider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RuleBasedStateProvider.Builder	A builder for RuleBasedStateProvider.
static final record	RuleBasedStateProvider.Rule	A rule.

Method Summary

Modifier and Type	Method	Description
static RuleBasedStateProvider.Builder	builder()	Creates a new builder.
Optional<BlockStateProvider>	fallback()	The block to use when no rules' predicates match.
static RuleBasedStateProvider	of(@Nullable BlockStateProvider fallback, List<RuleBasedStateProvider.Rule> rules)	Creates a new rule-based block state provider.
static RuleBasedStateProvider.Rule	rule(BlockPredicate ifTrue, BlockStateProvider then)	Creates a new builder.
List<RuleBasedStateProvider.Rule>	rules()	Rules of the block to use.
default RuleBasedStateProvider.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

fallback

@AsOf("3.0.0")
Optional<BlockStateProvider> fallback()

The block to use when no rules' predicates match. If unspecified and no rules' predicates match, then no block is placed.

Returns:

the fallback block state provider

Since:

3.0.0

rules

@AsOf("3.0.0")
List<RuleBasedStateProvider.Rule> rules()

Rules of the block to use. This can be empty.

Returns:

the list of rules

Since:

3.0.0

toBuilder

default RuleBasedStateProvider.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.0.0

of

@AsOf("3.0.0")
static RuleBasedStateProvider of(@Nullable BlockStateProvider fallback,
 List<RuleBasedStateProvider.Rule> rules)

Creates a new rule-based block state provider.

Parameters:

fallback - the fallback block state provider, or null to have no fallback

rules - the rules of the block state provider

Returns:

a new rule-based block state provider

Since:

3.0.0

builder

@AsOf("3.0.0")
static RuleBasedStateProvider.Builder builder()

Creates a new builder.

Returns:

a new builder

Since:

3.0.0

rule

@AsOf("3.0.0")
static RuleBasedStateProvider.Rule rule(BlockPredicate ifTrue,
 BlockStateProvider then)

Creates a new builder.

Parameters:

ifTrue - The block predicate of this rule.

then - The block to use when the predicate is passed.

Returns:

a new rule