Package net.minestom.server.component

Interface DataComponent<T>

Type Parameters:

T - The value type of the component

All Superinterfaces:

Codec<T>, Decoder<T>, Encoder<T>, Holder<DataComponent<T>>, net.kyori.adventure.key.Keyed, RegistryKey<DataComponent<T>>, StaticProtocolObject<DataComponent<T>>

public sealed interface DataComponent<T>
extends StaticProtocolObject<DataComponent<T>>, Codec<T>

A common type to represent all forms of component in the game. Each group of component types has its own declaration file (see DataComponent for example).

See Also:

• DataComponent
• EffectComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataComponent.Holder	Represents any type which can hold data components.
static final record	DataComponent.Value

Nested classes/interfaces inherited from interface net.minestom.server.codec.Codec

Codec.RawValue

Nested classes/interfaces inherited from interface net.minestom.server.registry.Holder

Holder.Direct<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull Codec<DataComponent<?>>	CODEC
static final @NotNull Codec<DataComponentMap>	MAP_NBT_TYPE
static final NetworkBuffer.Type<DataComponentMap>	MAP_NETWORK_TYPE
static final NetworkBuffer.Type<DataComponent<?>>	NETWORK_TYPE
static final @NotNull Codec<DataComponentMap>	PATCH_CODEC
static final NetworkBuffer.Type<DataComponentMap>	PATCH_NETWORK_TYPE
static final NetworkBuffer.Type<DataComponentMap>	UNTRUSTED_PATCH_NETWORK_TYPE

Fields inherited from interface net.minestom.server.codec.Codec

BLOCK_POSITION, BOOLEAN, BYTE, BYTE_ARRAY, COMPONENT, DOUBLE, FLOAT, INT, INT_ARRAY, KEY, LONG, LONG_ARRAY, NBT, NBT_COMPOUND, RAW_VALUE, SHORT, STRING, UNIT, UUID, UUID_COERCED, VECTOR3D

Method Summary

Modifier and Type	Method	Description
static <T> DataComponent<T>	createHeadless(int id, @NotNull net.kyori.adventure.key.Key key, NetworkBuffer.Type<T> network, @Nullable Codec<T> codec)
static @Nullable DataComponent<?>	fromId(int id)
static @Nullable DataComponent<?>	fromKey(@NotNull String key)
static @Nullable DataComponent<?>	fromKey(@NotNull net.kyori.adventure.key.Key key)
boolean	isSerialized()
boolean	isSynced()
T	read(@NotNull NetworkBuffer reader)
static @NotNull Collection<DataComponent<?>>	values()
void	write(@NotNull NetworkBuffer writer, T value)

Methods inherited from interface net.minestom.server.codec.Codec

list, list, listOrSingle, listOrSingle, mapValue, mapValue, optional, optional, orElse, set, set, transform, unionType, unionType

Methods inherited from interface net.minestom.server.codec.Decoder

decode

Methods inherited from interface net.minestom.server.codec.Encoder

encode

Methods inherited from interface net.minestom.server.registry.Holder

asKey, asValue, isDirect, resolve, unwrap

Methods inherited from interface net.minestom.server.registry.StaticProtocolObject

id, key, name, registry

Field Details

NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<DataComponent<?>> NETWORK_TYPE

CODEC

@NotNull
static final @NotNull Codec<DataComponent<?>> CODEC

MAP_NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<DataComponentMap> MAP_NETWORK_TYPE

MAP_NBT_TYPE

@NotNull
static final @NotNull Codec<DataComponentMap> MAP_NBT_TYPE

PATCH_NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<DataComponentMap> PATCH_NETWORK_TYPE

UNTRUSTED_PATCH_NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<DataComponentMap> UNTRUSTED_PATCH_NETWORK_TYPE

PATCH_CODEC

@NotNull
static final @NotNull Codec<DataComponentMap> PATCH_CODEC

Method Details

isSynced

boolean isSynced()

isSerialized

boolean isSerialized()

read

@NotNull
T read(@NotNull
 @NotNull NetworkBuffer reader)

write

void write(@NotNull
 @NotNull NetworkBuffer writer,
 @NotNull
 T value)

fromKey

@Nullable
static @Nullable DataComponent<?> fromKey(@NotNull
 @NotNull String key)

fromKey

@Nullable
static @Nullable DataComponent<?> fromKey(@NotNull
 @NotNull net.kyori.adventure.key.Key key)

fromId

@Nullable
static @Nullable DataComponent<?> fromId(int id)

values

@NotNull
static @NotNull Collection<DataComponent<?>> values()

createHeadless

@Internal
static <T> DataComponent<T> createHeadless(int id,
 @NotNull
 @NotNull net.kyori.adventure.key.Key key,
 @Nullable
 NetworkBuffer.Type<T> network,
 @Nullable
 @Nullable Codec<T> codec)