Interface DataComponent<T>

Type Parameters:

T - The value type of the component

All Superinterfaces:

Decoder<T>, Encoder<T>, Holder<DataComponent<T>>, Keyed, RegistryKey<DataComponent<T>>, StaticProtocolObject<DataComponent<T>>

public sealed interface DataComponent<T>
extends StaticProtocolObject<DataComponent<T>>, Encoder<T>, Decoder<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 Holder

Holder.Direct<T>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
@Nullable Codec<T>	codec()
static <T> DataComponent<T>	createHeadless(int id, Key key, NetworkBuffer.Type<T> network, @Nullable Codec<T> codec, @Nullable UnaryOperator<T> freeze)
T	freeze(T value)	Freezes the given value if possible.
static @Nullable DataComponent<?>	fromId(int id)
static @Nullable DataComponent<?>	fromKey(String key)
static @Nullable DataComponent<?>	fromKey(Key key)
boolean	isSerialized()
boolean	isSynced()
NetworkBuffer.Type<T>	networkType()
T	read(NetworkBuffer reader)
static Collection<DataComponent<?>>	values()
void	write(NetworkBuffer writer, T value)

Methods inherited from interface Decoder

decode

Methods inherited from interface Encoder

encode

Methods inherited from interface Holder

asKey, asValue, isDirect, resolve, unwrap

Methods inherited from interface StaticProtocolObject

id, key, name, registry

Field Details

NETWORK_TYPE

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

CODEC

static final Codec<DataComponent<?>> CODEC

MAP_NETWORK_TYPE

static final NetworkBuffer.Type<DataComponentMap> MAP_NETWORK_TYPE

MAP_NBT_TYPE

static final Codec<DataComponentMap> MAP_NBT_TYPE

PATCH_NETWORK_TYPE

static final NetworkBuffer.Type<DataComponentMap> PATCH_NETWORK_TYPE

UNTRUSTED_PATCH_NETWORK_TYPE

static final NetworkBuffer.Type<DataComponentMap> UNTRUSTED_PATCH_NETWORK_TYPE

PATCH_CODEC

static final Codec<DataComponentMap> PATCH_CODEC

Method Details

isSynced

boolean isSynced()

isSerialized

boolean isSerialized()

networkType

@Nullable
NetworkBuffer.Type<T> networkType()

codec

@Nullable
@Nullable Codec<T> codec()

read

T read(NetworkBuffer reader)

write

void write(NetworkBuffer writer,
 T value)

freeze

T freeze(T value)

Freezes the given value if possible. For example, collections should be frozen.
Note: Only T itself is required to be frozen, the objects inside T should be immutable.

Parameters:

value - the value to freeze

Returns:

the frozen value, or the original value if it could not be frozen

fromKey

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

fromKey

@Nullable
static @Nullable DataComponent<?> fromKey(Key key)

fromId

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

values

static Collection<DataComponent<?>> values()

createHeadless

@Internal
static <T> DataComponent<T> createHeadless(int id,
 Key key,
 @Nullable
 NetworkBuffer.Type<T> network,
 @Nullable
 @Nullable Codec<T> codec,
 @Nullable
 @Nullable UnaryOperator<T> freeze)