Class AttachmentHolder

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

All Implemented Interfaces:

IAttachmentHolder

Direct Known Subclasses:

AttachmentHolder.AsField, BlockEntity, Entity, Level

public abstract class AttachmentHolder
extends Object
implements IAttachmentHolder

Implementation class for objects that can hold data attachments. For the user-facing methods, see IAttachmentHolder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttachmentHolder.AsField	Version of the AttachmentHolder that is suitable for storing in a field.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Nullable Map<AttachmentType<?>, Object>	attachments
static final String	ATTACHMENTS_NBT_KEY
private static final boolean	IN_DEV
private static final org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
AttachmentHolder()

Method Summary

Modifier and Type	Method	Description
protected final void	deserializeAttachments(ValueInput input)	Reads serializable attachments from a tag previously created via serializeAttachments(ValueOutput).
(package private) final Map<AttachmentType<?>, Object>	getAttachmentMap()	Create the attachment map if it does not yet exist, or return the current map.
final <T> T	getData(AttachmentType<T> type)	Returns the data attachment of the given type.
<T> @Nullable T	getExistingDataOrNull(AttachmentType<T> type)
(package private) IAttachmentHolder	getExposedHolder()	Returns the attachment holder that is exposed to the user.
final boolean	hasAttachments()	Returns true if there is any data attachments, false otherwise.
final boolean	hasData(AttachmentType<?> type)	Returns true if there is a data attachment of the give type, false otherwise.
<T> @Nullable T	removeData(AttachmentType<T> type)	Removes the data attachment of the given type.
final void	serializeAttachments(ValueOutput tag)	Writes the serializable attachments to a tag.
<T> @Nullable T	setData(AttachmentType<T> type, T data)	Sets the data attachment of the given type.
private void	validateAttachmentType(AttachmentType<?> type)

Methods inherited from class Object

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

Methods inherited from interface IAttachmentHolder

getData, getExistingData, getExistingData, getExistingDataOrNull, hasData, removeData, setData, syncData, syncData

Field Details

ATTACHMENTS_NBT_KEY

public static final String ATTACHMENTS_NBT_KEY

See Also:

• Constant Field Values

IN_DEV

private static final boolean IN_DEV

LOGGER

private static final org.slf4j.Logger LOGGER

attachments

@Nullable Map<AttachmentType<?>, Object> attachments

Constructor Details

AttachmentHolder

public AttachmentHolder()

Method Details

validateAttachmentType

private void validateAttachmentType(AttachmentType<?> type)

getAttachmentMap

final Map<AttachmentType<?>, Object> getAttachmentMap()

Create the attachment map if it does not yet exist, or return the current map.

getExposedHolder

IAttachmentHolder getExposedHolder()

Returns the attachment holder that is exposed to the user. This is the same as this for most cases, but when using AttachmentHolder.AsField it is the field holder.

hasAttachments

public final boolean hasAttachments()

Description copied from interface: IAttachmentHolder

Returns true if there is any data attachments, false otherwise.

Specified by:

hasAttachments in interface IAttachmentHolder

hasData

public final boolean hasData(AttachmentType<?> type)

Description copied from interface: IAttachmentHolder

Returns true if there is a data attachment of the give type, false otherwise.

Specified by:

hasData in interface IAttachmentHolder

getData

public final <T> T getData(AttachmentType<T> type)

Description copied from interface: IAttachmentHolder

Returns the data attachment of the given type.

If there is no data attachment of the given type, the default value is stored in this holder and returned.

Specified by:

getData in interface IAttachmentHolder

Returns:

the data attachment of the given type

getExistingDataOrNull

public <T> @Nullable T getExistingDataOrNull(AttachmentType<T> type)

Specified by:

getExistingDataOrNull in interface IAttachmentHolder

Returns:

an existing data attachment value of the given type, or null if there is no data attachment of the given type

setData

@MustBeInvokedByOverriders
public <T> @Nullable T setData(AttachmentType<T> type,
 T data)

Description copied from interface: IAttachmentHolder

Sets the data attachment of the given type.

Specified by:

setData in interface IAttachmentHolder

Returns:

the previous value for that attachment type, if any, or null if there was none

removeData

@MustBeInvokedByOverriders
public <T> @Nullable T removeData(AttachmentType<T> type)

Description copied from interface: IAttachmentHolder

Removes the data attachment of the given type.

Specified by:

removeData in interface IAttachmentHolder

Returns:

the previous value for that attachment type, if any, or null if there was none

serializeAttachments

public final void serializeAttachments(ValueOutput tag)

Writes the serializable attachments to a tag.

deserializeAttachments

protected final void deserializeAttachments(ValueInput input)

Reads serializable attachments from a tag previously created via serializeAttachments(ValueOutput).

This does not trigger syncing of the deserialized attachments.