Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:items_docs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:items_docs [2020/04/01 19:45] – finish Item.Settings method docs draylartutorial:items_docs [2023/06/12 16:25] (current) – mineblock11
Line 1: Line 1:
 +:!: //This page is archived.//
 +
 ====== Items ====== ====== Items ======
-Items are the pieces of content that appear in your inventory. They can perform actions when you click, act as food, or spawn entities. The following documentation will give you a rundown of the entire ''Item'' class and everything related to it. For a tutorial you can follow along, visit [[tutorial:items|Practical Example: Adding an Item]].+ 
 +Items are the pieces of content that appear in your inventory. They can perform actions when you click, act as food, or spawn entities. The following documentation will give you a rundown of the entire ''Item'' class and everything related to it.
  
 ===== Item Settings ===== ===== Item Settings =====
Line 7: Line 10:
  
 ^ Method      ^ Args       ^ Description          ^ ^ Method      ^ Args       ^ Description          ^
-| food    | FoodComponent | Changes the Item to be edible based on the given ''FoodComponent''. | +| food | ''FoodComponent'' | Changes the Item to be edible based on the given ''FoodComponent''. | 
-| maxCount    | int | Sets the Item's max stack count. Can't be used in combination with damage. | +| maxCount    | ''int'' | Sets the Item's max stack count. Can't be used in combination with damage. | 
-| maxDamageIfAbsent | int | Sets the Item's maximum damage count if it hasn't already been set. | +| maxDamageIfAbsent | ''int'' | Sets the Item's maximum damage count if it hasn't already been set. | 
-| maxDamage |int | Sets the Item's max stack durability. | +| maxDamage | ''int'' | Sets the Item's max stack durability. | 
-| recipeRemainder | Item | Sets the Item's recipe remainder, which is given back to the player after the Item is used in a recipe. | +| recipeRemainder | ''Item'' | Sets the Item's recipe remainder, which is given back to the player after the Item is used in a recipe. | 
-| group | ItemGroup | Sets the ItemGroup of the Item, which is used for creative tabs. | +| rarity | ''Rarity'' | Sets the rarity of the Item, which changes its name color. | 
-| rarity | Rarity | Sets the rarity of the Item, which changes its name color. |+| fireproof | None | Marks the item as being fireproof. Prevents the item from being destroyed by lava and fire. | 
 + 
 +===== Fabric Item Settings ===== 
 +The Fabric Item API provides extra methods to set even more attributes. To use it, just replace ''new Item.Settings()'' with ''new FabricItemSettings()''. 
 +Heres the list of additional functionalities ''FabricItemSettings'' provides: 
 + 
 +^ Method      ^ Args       ^ Description          ^ 
 +| equipmentSlot | ''EquipmentSlotProvider'' | Sets the equipment slot provider of the item. | 
 +| customDamage | ''CustomDamageHandler'' | Sets the custom damage handler of the item. |
  
 ---- ----
Line 21: Line 32:
 public Item.Settings food(FoodComponent foodComponent) public Item.Settings food(FoodComponent foodComponent)
 </code> </code>
-''foodComponent'' - instance of'FoodComponent. When set, the Item will be edible based on the settings provided by the FoodComponent builder. For an in-depth explanation of the available options, view the FoodComponent Overview page.+''foodComponent'' - instance of ''FoodComponent''. When set, the Item will be edible based on the settings provided by the FoodComponent builder. For an in-depth explanation of the available options, view the FoodComponent Overview page.
  
 ---- ----
Line 58: Line 69:
  
 When a recipe remainder is set on an Item, any recipe using that Item will return the remainder on craft. This is used for buckets (Water, Lava, Milk) and bottles (Dragon Breath, Honey) returning their respective empty items when used in recipes. When a recipe remainder is set on an Item, any recipe using that Item will return the remainder on craft. This is used for buckets (Water, Lava, Milk) and bottles (Dragon Breath, Honey) returning their respective empty items when used in recipes.
- 
----- 
- 
-==== Group ==== 
-<code java> 
-public Item.Settings group(ItemGroup group) 
-</code> 
-''group'' - ItemGroup to add Item in. 
- 
-Each ItemGroup appears as a tab in the creative inventory. Adding an Item to this group will add it to the tab. The order of the group is based on registry order. For more information on creating a group, see the [[tutorial:itemgroup|ItemGroups page]]. 
  
 ---- ----
Line 83: Line 84:
 | Rare | Aqua | | Rare | Aqua |
 | Epic | Light Purple | | Epic | Light Purple |
 +
 +----
 +
 +==== Fireproof ====
 +<code java>
 +public Item.Settings fireproof()
 +</code>
 +
 +Marks the item as being fireproof, and protects the item entity that contains the item from fire and lava.
tutorial/items_docs.1585770334.txt.gz · Last modified: 2020/04/01 19:45 by draylar