team.unnamed.creative.blockstate

Interface BlockState

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed, ResourcePackPart

@ApiStatus.NonExtendable
public interface BlockState
extends ResourcePackPart, net.kyori.adventure.key.Keyed, net.kyori.examination.Examinable

There are several variants of some blocks (like doors, which can be open or closed), hence each block has its own block state file, which lists all its existing variants and links them to their corresponding models

Blocks can also be compound of several models at the same time, called "multipart". The models are then used depending on the block states of the block

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this block state to the given resource container
@NotNull net.kyori.adventure.key.Key	key()
java.util.List<Selector>	multipart()
static BlockState	of(net.kyori.adventure.key.Key key, java.util.List<Selector> multipart) Creates a new BlockState instance from the given block state multipart info
static BlockState	of(net.kyori.adventure.key.Key key, java.util.Map<java.lang.String,MultiVariant> variants) Creates a new BlockState instance with the given block state variants
static BlockState	of(net.kyori.adventure.key.Key key, java.util.Map<java.lang.String,MultiVariant> variants, java.util.List<Selector> multipart) Creates a new BlockState object from the given values
static BlockState	of(net.kyori.adventure.key.Key key, Selector... multipart)
java.util.Map<java.lang.String,MultiVariant>	variants()

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

key

@NotNull
@NotNull net.kyori.adventure.key.Key key()

Specified by:

key in interface net.kyori.adventure.key.Keyed

variants

java.util.Map<java.lang.String,MultiVariant> variants()

multipart

java.util.List<Selector> multipart()

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this block state to the given resource container

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0

of

static BlockState of(net.kyori.adventure.key.Key key,
                     java.util.Map<java.lang.String,MultiVariant> variants,
                     java.util.List<Selector> multipart)

Creates a new BlockState object from the given values

Parameters:

variants - The block state variants

multipart - The block state variants (multipart)

Returns:

A new BlockState instance

Since:

1.0.0

of

static BlockState of(net.kyori.adventure.key.Key key,
                     java.util.Map<java.lang.String,MultiVariant> variants)

Creates a new BlockState instance with the given block state variants

Parameters:

variants - The block state variants

Returns:

A new BlockState variants

Since:

1.0.0

of

static BlockState of(net.kyori.adventure.key.Key key,
                     java.util.List<Selector> multipart)

Creates a new BlockState instance from the given block state multipart info

Parameters:

multipart - The block state cases to use

Returns:

A new BlockState instance

Since:

1.0.0

of

static BlockState of(net.kyori.adventure.key.Key key,
                     Selector... multipart)