Package net.neoforged.neoforge.attachment

Class AttachmentType<T>

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentType<T>

public final class AttachmentType<T>
extends Object

Represents a data attachment type: some data that can be added to any object implementing IAttachmentHolder.

Data attachment types must be registered to the registry.

BlockEntity-exclusive behavior:

• Modifications to attachments should be followed by a call to BlockEntity.setChanged().

Entity-exclusive behavior:

• Serializable entity attachments are not copied on death by default (but they are copied when returning from the end).
• Serializable entity attachments can opt into copying on death via AttachmentType.Builder.copyOnDeath().

ItemStack-exclusive behavior:

• Serializable item stack attachments are synced between the server and the client.
• Serializable item stack attachments are copied when an item stack is copied.
• Serializable item stack attachments must match for item stack comparison to succeed.

Level-exclusive behavior:

• (nothing)

ChunkAccess-exclusive behavior:

• Modifications to attachments should be followed by a call to ChunkAccess.setUnsaved(boolean).
• Serializable attachments are copied from a ProtoChunk to a LevelChunk on promotion.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttachmentType.Builder<T>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final IAttachmentCopyHandler<T>	copyHandler
(package private) final boolean	copyOnDeath
(package private) final Function<IAttachmentHolder,T>	defaultValueSupplier
(package private) final @Nullable IAttachmentSerializer<?,T>	serializer

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AttachmentType(AttachmentType.Builder<T> builder)

Method Summary

Modifier and Type	Method	Description
static <T> AttachmentType.Builder<T>	builder(Function<IAttachmentHolder,T> defaultValueConstructor)	Creates a builder for an attachment type.
static <T> AttachmentType.Builder<T>	builder(Supplier<T> defaultValueSupplier)	Creates a builder for an attachment type.
private static <T, H extends Tag> IAttachmentCopyHandler<T>	defaultCopyHandler(@Nullable IAttachmentSerializer<H,T> serializer)
static <S extends Tag, T extends INBTSerializable<S>> AttachmentType.Builder<T>	serializable(Function<IAttachmentHolder,T> defaultValueConstructor)	Create a builder for an attachment type that uses INBTSerializable for serialization.
static <S extends Tag, T extends INBTSerializable<S>> AttachmentType.Builder<T>	serializable(Supplier<T> defaultValueSupplier)	Create a builder for an attachment type that uses INBTSerializable for serialization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

defaultValueSupplier

final Function<IAttachmentHolder,T> defaultValueSupplier

serializer

@Nullable
final @Nullable IAttachmentSerializer<?,T> serializer

copyOnDeath

final boolean copyOnDeath

copyHandler

final IAttachmentCopyHandler<T> copyHandler

Constructor Details

AttachmentType

private AttachmentType(AttachmentType.Builder<T> builder)

Method Details

defaultCopyHandler

private static <T,
H extends Tag>
IAttachmentCopyHandler<T> defaultCopyHandler(@Nullable
 @Nullable IAttachmentSerializer<H,T> serializer)

builder

public static <T> AttachmentType.Builder<T> builder(Supplier<T> defaultValueSupplier)

Creates a builder for an attachment type.

See builder(Function) for attachments that want to capture a reference to their holder.

Parameters:

defaultValueSupplier - A supplier for a new default value of this attachment type.

builder

public static <T> AttachmentType.Builder<T> builder(Function<IAttachmentHolder,T> defaultValueConstructor)

Creates a builder for an attachment type.

This overload allows capturing a reference to the IAttachmentHolder for the attachment. To obtain a specific subtype, the holder can be cast. If the holder is of the wrong type, the constructor should throw an exception. See builder(Supplier) for an overload that does not capture the holder.

Parameters:

defaultValueConstructor - A constructor for a new default value of this attachment type.

serializable

public static <S extends Tag,
T extends INBTSerializable<S>>
AttachmentType.Builder<T> serializable(Supplier<T> defaultValueSupplier)

Create a builder for an attachment type that uses INBTSerializable for serialization. Other kinds of serialization can be implemented using builder(Supplier) and AttachmentType.Builder.serialize(IAttachmentSerializer).

See serializable(Function) for attachments that want to capture a reference to their holder.

serializable

public static <S extends Tag,
T extends INBTSerializable<S>>
AttachmentType.Builder<T> serializable(Function<IAttachmentHolder,T> defaultValueConstructor)

Create a builder for an attachment type that uses INBTSerializable for serialization. Other kinds of serialization can be implemented using builder(Supplier) and AttachmentType.Builder.serialize(IAttachmentSerializer).

This overload allows capturing a reference to the IAttachmentHolder for the attachment. To obtain a specific subtype, the holder can be cast. If the holder is of the wrong type, the constructor should throw an exception. See serializable(Supplier) for an overload that does not capture the holder.