Package net.ixdarklord.coolcatcore.api.attachment

Class AttachmentRegistry

java.lang.Object

net.ixdarklord.coolcatcore.api.attachment.AttachmentRegistry

public final class AttachmentRegistry
extends Object

One mod's Attachments. A mod's values are stored under its own id: in a <modid>:attachments tag in a stack's NBT, and in entity and block entity data, so each mod's data stays separate from every other's.

 public static final AttachmentRegistry ATTACHMENTS = AttachmentRegistry.create(MOD_ID);
 public static final Attachment<Integer> MADNESS = ATTACHMENTS.builder("madness", Codec.INT, 0).build();

 // While the mod initialises:
 ATTACHMENTS.register();
 

Method Summary

Modifier and Type	Method	Description
static Collection<AttachmentRegistry>	all()	Every mod's registry.
<T> Attachment.Builder<T>	builder(String name, com.mojang.serialization.Codec<T> codec, T defaultValue)	An attachment saved with its holder.
Attachment.Builder<SlotContainer>	container(String name, ContainerLayout layout)	An inventory as an attachment, so any entity or block entity can carry one (a player's backpack slots, a mob's loot).
net.minecraft.world.level.storage.loot.functions.CopyNbtFunction.Builder	copyKeptOnDrop()	A loot function for a block's loot table that copies this mod's keepOnDrop values from the broken block entity into the dropped item, for placing it to restore them:
static AttachmentRegistry	create(String modId)	The registry of a mod; each mod creates one.
static @Nullable AttachmentRegistry	forMod(String modId)
@Nullable Attachment<?>	get(String name)
Collection<Attachment<?>>	getAttachments()
net.minecraft.resources.ResourceLocation	id(String name)	modid:name.
boolean	isRegistered()	Whether register() was called.
String	modId()
<T> Attachment.Builder<T>	mutableBuilder(String name, com.mojang.serialization.Codec<T> codec, Supplier<T> defaultValue)	An attachment saved with its holder, whose default is made fresh for each holder: for mutable values, changed with Attachment.modify(net.minecraft.world.entity.Entity, java.util.function.Consumer<T>) (or Trackable ones).
void	register()	Call once, while the mod initialises.
String	tagName()	The name of the tag (<modid>:attachments) holding this mod's values: in entity and block entity data, and in item stacks' NBT.
String	toString()
<T> Attachment.Builder<T>	transientBuilder(String name, Supplier<T> defaultValue)	An attachment that's never saved: its value is gone when the holder unloads (timers, caches, per-session state).

Methods inherited from class java.lang.Object

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

Method Details

create

public static AttachmentRegistry create(String modId)

The registry of a mod; each mod creates one.

all

public static Collection<AttachmentRegistry> all()

Every mod's registry.

forMod

@Nullable
public static @Nullable AttachmentRegistry forMod(String modId)

builder

public <T> Attachment.Builder<T> builder(String name,
 com.mojang.serialization.Codec<T> codec,
 T defaultValue)

An attachment saved with its holder. defaultValue is what holders without a value read; it must be immutable. For a mutable default, use mutableBuilder(java.lang.String, com.mojang.serialization.Codec<T>, java.util.function.Supplier<T>).

mutableBuilder

public <T> Attachment.Builder<T> mutableBuilder(String name,
 com.mojang.serialization.Codec<T> codec,
 Supplier<T> defaultValue)

An attachment saved with its holder, whose default is made fresh for each holder: for mutable values, changed with Attachment.modify(net.minecraft.world.entity.Entity, java.util.function.Consumer<T>) (or Trackable ones). Not usable on item stacks.

transientBuilder

public <T> Attachment.Builder<T> transientBuilder(String name,
 Supplier<T> defaultValue)

An attachment that's never saved: its value is gone when the holder unloads (timers, caches, per-session state). It can still be synced with Attachment.Builder.networkCodec(net.ixdarklord.coolcatcore.api.network.codec.StreamCodec<? super net.minecraft.network.FriendlyByteBuf, T>) and Attachment.Builder.sync(net.ixdarklord.coolcatcore.api.attachment.SyncPolicy). Not usable on item stacks.

container

public Attachment.Builder<SlotContainer> container(String name,
 ContainerLayout layout)

An inventory as an attachment, so any entity or block entity can carry one (a player's backpack slots, a mob's loot). Its slot changes save and sync on their own.

register

public void register()

Call once, while the mod initialises. On 1.20.1, item stacks keep their values in their NBT, so there's no item component to register; this only marks the registry ready, and is kept so code stays the same across versions.

modId

public String modId()

id

public net.minecraft.resources.ResourceLocation id(String name)

modid:name.

get

@Nullable
public @Nullable Attachment<?> get(String name)

getAttachments

public Collection<Attachment<?>> getAttachments()

tagName

public String tagName()

The name of the tag (<modid>:attachments) holding this mod's values: in entity and block entity data, and in item stacks' NBT.

isRegistered

public boolean isRegistered()

Whether register() was called.

copyKeptOnDrop

public net.minecraft.world.level.storage.loot.functions.CopyNbtFunction.Builder copyKeptOnDrop()

A loot function for a block's loot table that copies this mod's keepOnDrop values from the broken block entity into the dropped item, for placing it to restore them:

 LootItem.lootTableItem(block).apply(MyMod.ATTACHMENTS.copyKeptOnDrop())
 

In a JSON loot table, it's a minecraft:copy_nbt function from block_entity, with one "op": "replace" operation per value: from "<modid>:attachments"."<name>" to BlockEntityTag."<modid>:attachments"."<name>".

toString

public String toString()

Overrides:

toString in class Object