Component holders usually have "base" components and the overrides to the base + COMMENT (usually referred to as "changes"). The overrides may set additional components, + COMMENT modify the values from the base-provided default, or "unset"/remove base values. + COMMENT Methods in this interface expose the final value, after applying the changes. + COMMENT + COMMENT @see ComponentMap + COMMENT @see ComponentChanges METHOD method_57353 getComponents ()Lnet/minecraft/class_9323; METHOD method_57824 get (Lnet/minecraft/class_9331;)Ljava/lang/Object; + COMMENT {@return the value for the component {@code type}, or {@code null} if the + COMMENT component is missing} + COMMENT + COMMENT
The returned value should never be mutated. ARG 1 type METHOD method_57825 getOrDefault (Lnet/minecraft/class_9331;Ljava/lang/Object;)Ljava/lang/Object; + COMMENT {@return the value for the component {@code type}, or {@code fallback} if the + COMMENT component is missing} + COMMENT + COMMENT
This method does not initialize the components with {@code fallback}.
+ COMMENT The returned value should never be mutated.
ARG 1 type
ARG 2 fallback
METHOD method_57826 contains (Lnet/minecraft/class_9331;)Z
+ COMMENT {@return whether the held components include {@code type}}
+ COMMENT
+ COMMENT @implNote This is implemented as {@code get(type) != null}.
ARG 1 type
diff --git a/mappings/net/minecraft/component/type/LoreComponent.mapping b/mappings/net/minecraft/component/type/LoreComponent.mapping
index 196fa3dd33..111de50811 100644
--- a/mappings/net/minecraft/component/type/LoreComponent.mapping
+++ b/mappings/net/minecraft/component/type/LoreComponent.mapping
@@ -6,7 +6,7 @@ CLASS net/minecraft/class_9290 net/minecraft/component/type/LoreComponent
FIELD field_49344 STYLE Lnet/minecraft/class_2583;
METHOD Components can be used to store data specific to the item stack.
+ COMMENT Use {@link ComponentHolder#get} or {@link ComponentHolder#getOrDefault} to
+ COMMENT get the component values. Use {@link #set} or {@link #remove} to set the components.
COMMENT
- COMMENT An Item Stack can be serialized with {@link #encode(RegistryWrapper.WrapperLookup)}, and deserialized with {@link #fromNbt(RegistryWrapper.WrapperLookup, NbtCompound)}.
COMMENT
COMMENT In practice, {@code applier} is a reference to a method of the component
+ COMMENT class with one parameter, that returns a new instance of the component with the
+ COMMENT specific value changed to {@code change}. For example, adding a lore can be accomplished
+ COMMENT by passing reference to {@link net.minecraft.component.type.LoreComponent#with}
+ COMMENT and the added lore, like
+ COMMENT {@code stack.apply(DataComponentTypes.LORE, LoreComponent.DEFAULT, text, LoreComponent::with)}.
+ COMMENT
+ COMMENT @implNote This is the same as setting {@code applier.apply(stack.getOrDefault(type, defaultValue), change)}.
+ COMMENT
+ COMMENT @return the previous value set
+ COMMENT @see #apply(DataComponentType, Object, UnaryOperator)
+ COMMENT @see #set
ARG 1 type
ARG 2 defaultValue
ARG 3 change
ARG 4 applier
METHOD method_57368 apply (Lnet/minecraft/class_9331;Ljava/lang/Object;Ljava/util/function/UnaryOperator;)Ljava/lang/Object;
+ COMMENT Sets the component {@code type} by passing the current value (or {@code defaultValue}
+ COMMENT if the component is missing) to {@code applier} and then setting its return value as
+ COMMENT the value.
+ COMMENT
+ COMMENT @implNote This is the same as setting {@code applier.apply(stack.getOrDefault(type, defaultValue))}.
+ COMMENT
+ COMMENT @return the previous value set
+ COMMENT @see #set
+ COMMENT @see #apply(DataComponentType, Object, Object, BiFunction)
ARG 1 type
ARG 2 defaultValue
ARG 3 applier
@@ -267,10 +294,24 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
METHOD method_57378 (Ljava/util/Optional;)Lnet/minecraft/class_1799;
ARG 0 optional
METHOD method_57379 set (Lnet/minecraft/class_9331;Ljava/lang/Object;)Ljava/lang/Object;
+ COMMENT Sets the component {@code type} for this item stack to {@code value}.
+ COMMENT
+ COMMENT If {@code value} is {@code null}, the component is removed and the base component
+ COMMENT is unset. To reverse the stack-specific change, instead pass the default value
+ COMMENT as {@code value}.
+ COMMENT
+ COMMENT @return the previous value set
+ COMMENT @see #apply(DataComponentType, Object, UnaryOperator)
+ COMMENT @see #apply(DataComponentType, Object, Object, BiFunction)
ARG 1 type
ARG 2 value
METHOD method_57380 getComponentChanges ()Lnet/minecraft/class_9326;
METHOD method_57381 remove (Lnet/minecraft/class_9331;)Ljava/lang/Object;
+ COMMENT Removes the component {@code type}. If it is in the stack's base component,
+ COMMENT it is unset and the component becomes missing. To reverse the stack-specific change,
+ COMMENT instead pass the default value as {@code value}.
+ COMMENT
+ COMMENT @return the previous value set
ARG 1 type
METHOD method_57382 (Lnet/minecraft/class_1799;)Ljava/util/Optional;
ARG 0 stack
NBT operations
+ COMMENT Components
+ COMMENT NBT serialization
- COMMENT
- COMMENT An Item Stack can be serialized with {@link #encode(RegistryWrapper.WrapperLookup)}, and deserialized with {@link #fromNbt(RegistryWrapper.WrapperLookup, NbtCompound)}.
+ COMMENT NBT serialization
+ COMMENT
@@ -234,11 +236,36 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
METHOD method_57366 applyChanges (Lnet/minecraft/class_9326;)V
ARG 1 changes
METHOD method_57367 apply (Lnet/minecraft/class_9331;Ljava/lang/Object;Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object;
+ COMMENT Sets the component {@code type} by passing the current value and {@code change}
+ COMMENT to {@code applier}, then setting its return value as the value. If the component is
+ COMMENT missing, {@code defaultValue} is used as the default.
+ COMMENT
+ COMMENT