a few more renames and javadoc tweaks

This commit is contained in:
Shnupbups 2024-03-01 23:21:01 +11:00
parent bc7a71327b
commit a9eb4a5b08
2 changed files with 20 additions and 20 deletions

View File

@ -44,7 +44,7 @@ CLASS net/minecraft/class_1792 net/minecraft/item/Item
METHOD method_16698 isNetworkSynced ()Z METHOD method_16698 isNetworkSynced ()Z
COMMENT {@return whether the item needs to sync additional data to clients} COMMENT {@return whether the item needs to sync additional data to clients}
COMMENT COMMENT
COMMENT <p>Items should ideally store all necessary information on the stack's NBT. COMMENT <p>Items should ideally store all necessary information in the stack's components.
COMMENT However, this is not always possible for things like maps. In those cases, COMMENT However, this is not always possible for things like maps. In those cases,
COMMENT items can send a packet to the player holding it that syncs additional data. COMMENT items can send a packet to the player holding it that syncs additional data.
COMMENT Such items must subclass {@link NetworkSyncedItem}. COMMENT Such items must subclass {@link NetworkSyncedItem}.
@ -247,8 +247,8 @@ CLASS net/minecraft/class_1792 net/minecraft/item/Item
METHOD method_7854 getDefaultStack ()Lnet/minecraft/class_1799; METHOD method_7854 getDefaultStack ()Lnet/minecraft/class_1799;
COMMENT {@return the default stack for this item} COMMENT {@return the default stack for this item}
COMMENT COMMENT
COMMENT <p>Items that expect certain NBT data in the item stack should override COMMENT <p>Items that expect certain components in the item stack should override
COMMENT this method to return the stack with the NBT data. COMMENT this method to return the stack with the component data.
METHOD method_7856 isSuitableFor (Lnet/minecraft/class_2680;)Z METHOD method_7856 isSuitableFor (Lnet/minecraft/class_2680;)Z
COMMENT Determines whether this item can be used as a suitable tool for mining the specified block. COMMENT Determines whether this item can be used as a suitable tool for mining the specified block.
COMMENT Depending on block implementation, when combined together, the correct item and block may achieve a better mining speed and yield COMMENT Depending on block implementation, when combined together, the correct item and block may achieve a better mining speed and yield

View File

@ -8,8 +8,8 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
COMMENT method. This also means they cannot be used as a map key. To check if an item stack COMMENT method. This also means they cannot be used as a map key. To check if an item stack
COMMENT is of a certain item, use {@link #isOf(Item)}. To compare two item stacks, use {@link COMMENT is of a certain item, use {@link #isOf(Item)}. To compare two item stacks, use {@link
COMMENT #areItemsEqual} to check the item only, or {@link #areEqual} to also check the item COMMENT #areItemsEqual} to check the item only, or {@link #areEqual} to also check the item
COMMENT count and the NBT. Use {@link #isEmpty} to check if an item stack is empty instead of COMMENT count and the components. Use {@link #isEmpty} to check if an item stack is empty instead
COMMENT doing {@code stack == ItemStack.EMPTY}. COMMENT of doing {@code stack == ItemStack.EMPTY}.
COMMENT COMMENT
COMMENT <p>When storing an item stack in an inventory or other places, make sure that an instance COMMENT <p>When storing an item stack in an inventory or other places, make sure that an instance
COMMENT is never stored in multiple places. When two inventories hold the same instance, it COMMENT is never stored in multiple places. When two inventories hold the same instance, it
@ -115,8 +115,8 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
ARG 3 clickType ARG 3 clickType
ARG 4 player ARG 4 player
ARG 5 cursorStackReference ARG 5 cursorStackReference
METHOD method_31577 areItemsAndNbtEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z METHOD method_31577 areItemsAndComponentsEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z
COMMENT {@return whether the given item stacks' items and NBT are equal} COMMENT {@return whether the given item stacks' items and components are equal}
COMMENT COMMENT
COMMENT <p>If this returns {@code true}, the two item stacks can be combined into one, COMMENT <p>If this returns {@code true}, the two item stacks can be combined into one,
COMMENT as long as the resulting item count does not exceed {@linkplain Item#getMaxCount COMMENT as long as the resulting item count does not exceed {@linkplain Item#getMaxCount
@ -154,12 +154,12 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
METHOD method_45435 isItemEnabled (Lnet/minecraft/class_7699;)Z METHOD method_45435 isItemEnabled (Lnet/minecraft/class_7699;)Z
ARG 1 enabledFeatures ARG 1 enabledFeatures
METHOD method_46651 copyWithCount (I)Lnet/minecraft/class_1799; METHOD method_46651 copyWithCount (I)Lnet/minecraft/class_1799;
COMMENT {@return a copy of this item stack, including the NBT, and {@linkplain #getBobbingAnimationTime bobbing animation time}}, COMMENT {@return a copy of this item stack, including the components, and {@linkplain #getBobbingAnimationTime bobbing animation time}},
COMMENT with the item count set to {@code count} COMMENT with the item count set to {@code count}
COMMENT COMMENT
COMMENT @see #copy COMMENT @see #copy
COMMENT @see #copyNbtToNewStack COMMENT @see #copyComponentsToNewStack
COMMENT @see #copyNbtToNewStackIgnoreEmpty COMMENT @see #copyComponentsToNewStackIgnoreEmpty
ARG 1 count ARG 1 count
COMMENT the item count of the resultant stack COMMENT the item count of the resultant stack
METHOD method_51164 copyAndEmpty ()Lnet/minecraft/class_1799; METHOD method_51164 copyAndEmpty ()Lnet/minecraft/class_1799;
@ -171,12 +171,12 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
ARG 0 instance ARG 0 instance
METHOD method_56700 (Lnet/minecraft/class_1799;)Ljava/util/Optional; METHOD method_56700 (Lnet/minecraft/class_1799;)Ljava/util/Optional;
ARG 0 stack ARG 0 stack
METHOD method_56701 copyNbtToNewStack (Lnet/minecraft/class_1935;I)Lnet/minecraft/class_1799; METHOD method_56701 copyComponentsToNewStack (Lnet/minecraft/class_1935;I)Lnet/minecraft/class_1799;
COMMENT {@return a new item stack with the NBT copied from this item stack} COMMENT {@return a new item stack with the components copied from this item stack}
COMMENT COMMENT
COMMENT @see #copy COMMENT @see #copy
COMMENT @see #copyWithCount COMMENT @see #copyWithCount
COMMENT @see #copyNbtToNewStackIgnoreEmpty COMMENT @see #copyComponentsToNewStackIgnoreEmpty
ARG 1 item ARG 1 item
COMMENT the item of the resultant stack COMMENT the item of the resultant stack
ARG 2 count ARG 2 count
@ -185,8 +185,8 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
ARG 0 fieldName ARG 0 fieldName
METHOD method_56703 (Ljava/util/Optional;)Lnet/minecraft/class_1799; METHOD method_56703 (Ljava/util/Optional;)Lnet/minecraft/class_1799;
ARG 0 optional ARG 0 optional
METHOD method_56704 copyNbtToNewStackIgnoreEmpty (Lnet/minecraft/class_1935;I)Lnet/minecraft/class_1799; METHOD method_56704 copyComponentsToNewStackIgnoreEmpty (Lnet/minecraft/class_1935;I)Lnet/minecraft/class_1799;
COMMENT {@return a new item stack with the NBT copied from this item stack, even if this stack is empty} COMMENT {@return a new item stack with the components copied from this item stack, even if this stack is empty}
COMMENT COMMENT
COMMENT @see #copy COMMENT @see #copy
COMMENT @see #copyWithCount COMMENT @see #copyWithCount
@ -462,14 +462,14 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
COMMENT }</pre> COMMENT }</pre>
ARG 1 amount ARG 1 amount
METHOD method_7972 copy ()Lnet/minecraft/class_1799; METHOD method_7972 copy ()Lnet/minecraft/class_1799;
COMMENT {@return a copy of this item stack, including the item count, NBT, and COMMENT {@return a copy of this item stack, including the item count, components, and
COMMENT {@linkplain #getBobbingAnimationTime bobbing animation time}} COMMENT {@linkplain #getBobbingAnimationTime bobbing animation time}}
COMMENT COMMENT
COMMENT @see #copyWithCount COMMENT @see #copyWithCount
COMMENT @see #copyNbtToNewStack COMMENT @see #copyComponentsToNewStack
COMMENT @see #copyNbtToNewStackIgnoreEmpty COMMENT @see #copyComponentsToNewStackIgnoreEmpty
METHOD method_7973 areEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z METHOD method_7973 areEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z
COMMENT {@return whether the given item stacks are equal, including the item count and NBT} COMMENT {@return whether the given item stacks are equal, including the item count and components}
COMMENT COMMENT
COMMENT @see #areItemsEqual COMMENT @see #areItemsEqual
COMMENT @see #areItemsAndNbtEqual COMMENT @see #areItemsAndNbtEqual
@ -506,7 +506,7 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
ARG 2 player ARG 2 player
ARG 3 amount ARG 3 amount
METHOD method_7984 areItemsEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z METHOD method_7984 areItemsEqual (Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z
COMMENT {@return whether the given item stacks contain the same item, regardless of item count or NBT} COMMENT {@return whether the given item stacks contain the same item, regardless of item count or components}
COMMENT COMMENT
COMMENT @see #areEqual COMMENT @see #areEqual
COMMENT @see #areItemsAndNbtEqual COMMENT @see #areItemsAndNbtEqual