Skip to content

Commit

Permalink
Adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eclipseisoffline committed Jul 21, 2024
1 parent e5f037e commit 9bdf05a
Showing 1 changed file with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public interface CustomItemData {
/**
* Gets the stack size of the item.
*
* Returns 0 if not set. When not set (or 0), takes the Java item stack count when based of a vanilla item, or uses 64 when porting a modded item.
* Returns 0 if not set. When not set (or 0), it defaults to the stack count of the Java item when based of a vanilla item, or 64 when registering a non-vanilla item.
*
* @return the stack size of the item
*/
Expand All @@ -128,7 +128,7 @@ public interface CustomItemData {
/**
* Gets the max damage of the item.
*
* Returns -1 if not set. When not set (or below 0), takes the Java item max damage when based of a vanilla item, or uses 0 when porting a modded item.
* Returns -1 if not set. When not set (or below 0), it defaults to the maximum damage of the Java item when based of a vanilla item, or uses 0 when registering a non-vanilla item.
*
* @return the max damage of the item
*/
Expand All @@ -147,13 +147,18 @@ public interface CustomItemData {
/**
* Gets the armor type of the item.
*
* This can be "boots", "leggings", "chestplate", or "helmet", and makes the item able to be equipped into its respective equipment slot.
* This should only be set if the Java vanilla/non-vanilla item is able to fit into the specified equipment slot.
*
* @return the armor type of the item
*/
@Nullable String armorType();

/**
* Gets the armor protection value of the item.
*
* Only has a function when {@link CustomItemData#armorType)} is set.
*
* @return the armor protection value of the item
*/
int protectionValue();
Expand Down

0 comments on commit 9bdf05a

Please sign in to comment.