Making Tools - Revision history

Jonathing: /* TierSortingRegistry */

2022-08-01T14:16:11Z

TierSortingRegistry

ChampionAsh5357: Update to 1.19

2022-06-12T18:52:37Z

Update to 1.19

ChampionAsh5357: Update tools to 1.17 with the new 37.0.31 system

2021-08-19T16:52:10Z

Update tools to 1.17 with the new 37.0.31 system

ChampionAsh5357: Update to 1.17

2021-07-30T22:57:41Z

Update to 1.17

ShrimpBot: Categorize with Category:Items by SizableShrimp#0755

2021-05-19T00:59:20Z

Categorize with Category:Items by SizableShrimp#0755

SciWhiz12: Use tip template instead of colored box

2021-02-15T09:42:58Z

Use tip template instead of colored box

SciWhiz12: Text replacement - "{{Colored box|title=Important|content=" to "{{Tip/Important|"

2020-12-20T22:04:04Z

Text replacement - "{{Colored box|title=Important|content=" to "{{Tip/Important|"

SciWhiz12: monospaced font for certain header texts

2020-11-29T06:34:14Z

monospaced font for certain header texts

Unbekannt: Initial Import dokuwiki

2020-10-24T17:11:23Z

Initial Import dokuwiki

New page

Tools are simply an extension of the <code>Item</code> class. All of the logic is handled directly through one class with the others just being helpers to specify an exact tool type. Their implementations rely mainly on extending a specific class, it's properties, and the use of a tier system.

== <code>IItemTier</code> ==

To create any tool that does not derive from vanilla tiers, you will need your own implementation of <code>IItemTier</code>. This is the basis of which all tool levels are created. If you would like to use a vanilla tier, then you should specify one of the enums within <code>ItemTier</code>.

Here are what each methods defines:
{| class="wikitable sortable" border=1
!Method !!Return Type !!Description
|-
| <code>getMaxUses</code> || <code>Integer</code> || The durability of all items in this tier.
|-
| <code>getEfficiency</code> || <code>Float</code> || The efficiency multiplier of all items in this tier.
|-
| <code>getAttackDamage</code> || <code>Float</code> || The base attack damage of all items in this tier.
|-
| <code>getHarvestLevel</code> || <code>Integer</code> || The harvest level of this tier. Vanilla uses values 0-4.
|-
| <code>getEnchantability</code> || <code>Integer</code> || How enchantable an item of this tier is.
|-
| <code>getRepairMaterial</code> || <code>Ingredient</code> || What ingredient can be used to repair this item.
|-
|}

{{Colored box|title=Important|content=An ingredient should be wrapped in a supplier to avoid calling the object directly. Tiers are loaded before registries are populated, so the call to the item needs to be deferred.}}

== <code>ToolItem</code> ==

<code>ToolItem</code> is the base of which all tool items extend. You do not necessarily have to use this or any of its supertypes/subtypes. However, it is convenient if you are looking for standard behavior. The subtypes normally referenced are <code>AxeItem</code>, <code>HoeItem</code>, <code>PickaxeItem</code>, <code>ShovelItem</code>.

Each tool has four parameters: tier, attack damage, attack speed, and properties. Tiers and properties have already been explained in this and within the [[Making Items|item]] docs. Attack damage specifies how much damage to do above the current base set for that specific tier. Attack speed specifies the speed modifier to apply to your current attack speed (defaults to <code>4.0D</code>).

{{Colored box|title=Tip|content=If you decide to extend <code>ToolItem</code>, there will be a fifth parameter which defines which blocks this tool is effective on. This parameter can just be an empty set as that is now specified on each block itself.}}

== Registering ==

A tool must be [[Registration|registered]] the same as an item. If using one of the subtypes of <code>ToolItem</code>, that is all that is required. If not, you will need to chain <code>addToolType</code> onto your properties. This will take in a <code>ToolType</code> and a harvest level. The type is held within <code>ToolType</code> itself. The harvest level will be the value from your tier using <code>IItemTier#getHarvestLevel</code>.

{{Colored box|title=Tip|content=If you would like to use a custom tool type, you can call <code>ToolType::get</code>. All strings passed in should have their modid appended to them to remove any conflict issues (e.g. <code>examplemod::custom_tool_type</code>). If a standard implementation across mods is used for compatibility, no namespace is needed.}}

@@ Line 48: / Line 48: @@
 |}
-{{Tip|If your tier is equivalent to another tier, then <code>Tier#getTag</code> should return an empty tag reference defined by <code>BlockTags#createOptional</code> and have the equivalent tier be placed in the <code>after</code> list when registering. If the tier is a vanilla tier, you should also specify the next tier above in the <code>before</code> list.}}
+{{Tip|If your tier is equivalent to another tier, then <code>Tier#getTag</code> should return an empty tag reference defined by <code>BlockTags#create</code> and have the equivalent tier be placed in the <code>after</code> list when registering. If the tier is a vanilla tier, you should also specify the next tier above in the <code>before</code> list.}}
 == <tt>DiggerItem</tt> ==

@@ Line 22: / Line 22: @@
 |   <code>getRepairIngredient</code>   ||   <code>Ingredient</code>   ||  What ingredient can be used to repair this item.
 |-
-|   <code>getTag</code>   ||   <code>Tag<Block></code>   ||  What blocks this tier can mine. This should only encompass those blocks which are specific for this tier. Any blocks below this tier will be declared while registering. The naming convention of this tag is <code><modid>:needs_<tier_name>_tool</code>.
+|   <code>getTag</code>   ||   <code>TagKey<Block></code>   ||  What blocks this tier can mine. This should only encompass those blocks which are specific for this tier. Any blocks below this tier will be declared while registering. The naming convention of this tag is <code><modid>:needs_<tier_name>_tool</code>.
 |-
 |}

@@ Line 1: / Line 1: @@
-Tools are simply an extension of the <code>Item</code> class. All of the logic is handled directly through one class with the others just being helpers to specify an exact tool type. Their implementations rely mainly on extending a specific class, it's properties, and the use of a tier system.
+Tools are simply an extension of the <code>Item</code> class. Their implementations mainly rely on extending a specific class, the <code>TierSortingRegistry</code>, and tags.
 == <tt>Tier</tt> ==
@@ Line 16: / Line 16: @@
 |   <code>getAttackDamageBonus</code>   ||   <code>Float</code>   ||  The base attack damage of all items in this tier.
 |-
-|   <code>getLevel</code>   ||   <code>Integer</code>   ||  The harvest level of this tier. Vanilla uses values 0-4.
+|   <code>getLevel</code>   ||   <code>Integer</code>   ||  The harvest level of this tier. Vanilla uses values 0-4. As of 37.0.31, Forge deprecates this value in favor of the sorting registry system discussed below. This value will be used if the tier is not registered however.
 |-
 |   <code>getEnchantmentValue</code>   ||   <code>Integer</code>   ||  How enchantable an item of this tier is.
 |-
 |   <code>getRepairIngredient</code>   ||   <code>Ingredient</code>   ||  What ingredient can be used to repair this item.
 |-
 |}
 {{Tip/Important|An ingredient should be wrapped in a supplier to avoid calling the object directly. Tiers are loaded before registries are populated, so the call to the item needs to be deferred.}}
 == <tt>DiggerItem</tt> ==
@@ Line 32: / Line 56: @@
 Each tool has four parameters: tier, attack damage, attack speed, and properties. Tiers and properties have already been explained in this and within the [[Making Items|item]] docs. Attack damage specifies how much damage to do above the current base set for that specific tier. Attack speed specifies the speed modifier to apply to your current attack speed (the base attack speed for a player is <code>4.0D</code>).
-{{Tip|content=If you decide to extend <code>DiggerItem</code>, there will be a fifth parameter which defines a tag of which blocks this item is effective on.}}
+{{Tip|content=If you decide to extend <code>DiggerItem</code>, there will be a fifth parameter which defines a tag of which blocks this item is effective on. The naming convention of these tags is <code><modid>:mineable/<tool_name></code>. If this tag should be shared among other mods, the <code>forge</code> namespace should be used instead. }}
 == Registering ==
-A tool must be [[Registration|registered]] the same as an item. If using one of the subtypes of <code>DiggerItem</code>, that is all that is required. If not, you will need to chain <code>addToolType</code> onto your properties. This will take in a <code>ToolType</code> and a harvest level. The type is held within <code>ToolType</code> itself. The harvest level will be the value from your tier using <code>Tier#getLevel</code>.
+A tool must be [[Registration|registered]] the same as an item. Defining the tool type and tier level is done via the mineable tag implemented on your tool and the tier tag on your <code>Tier</code>.
 [[Category:Items]]

@@ Line 2: / Line 2: @@
 Tools are simply an extension of the <code>Item</code> class. All of the logic is handled directly through one class with the others just being helpers to specify an exact tool type. Their implementations rely mainly on extending a specific class, it's properties, and the use of a tier system.
-== <tt>IItemTier</tt> ==
+== <tt>Tier</tt> ==
-To create any tool that does not derive from vanilla tiers, you will need your own implementation of <code>IItemTier</code>. This is the basis of which all tool levels are created. If you would like to use a vanilla tier, then you should specify one of the enums within <code>ItemTier</code>.
+To create any tool that does not derive from vanilla tiers, you will need your own implementation of <code>Tier</code>. This is the basis of which all tool levels are created. If you would like to use a vanilla tier, then you should specify one of the enums within <code>Tiers</code>.
 Here are what each methods defines:
@@ Line 10: / Line 10: @@
 !Method !!Return Type !!Description
 |-
-|   <code>getMaxUses</code>   ||   <code>Integer</code>   ||  The durability of all items in this tier.
+|   <code>getUses</code>   ||   <code>Integer</code>   ||  The durability of all items in this tier.
 |-
-|   <code>getEfficiency</code>   ||   <code>Float</code>   ||  The efficiency multiplier of all items in this tier.
+|   <code>getSpeed</code>   ||   <code>Float</code>   ||  The efficiency multiplier of all items in this tier.
 |-
-|   <code>getAttackDamage</code>   ||   <code>Float</code>   ||  The base attack damage of all items in this tier.
+|   <code>getAttackDamageBonus</code>   ||   <code>Float</code>   ||  The base attack damage of all items in this tier.
 |-
-|   <code>getHarvestLevel</code>   ||   <code>Integer</code>   ||  The harvest level of this tier. Vanilla uses values 0-4.
+|   <code>getLevel</code>   ||   <code>Integer</code>   ||  The harvest level of this tier. Vanilla uses values 0-4.
 |-
-|   <code>getEnchantability</code>   ||   <code>Integer</code>   ||  How enchantable an item of this tier is.
+|   <code>getEnchantmentValue</code>   ||   <code>Integer</code>   ||  How enchantable an item of this tier is.
 |-
-|   <code>getRepairMaterial</code>   ||   <code>Ingredient</code>   ||  What ingredient can be used to repair this item.
+|   <code>getRepairIngredient</code>   ||   <code>Ingredient</code>   ||  What ingredient can be used to repair this item.
 |-
 |}
@@ Line 26: / Line 26: @@
 {{Tip/Important|An ingredient should be wrapped in a supplier to avoid calling the object directly. Tiers are loaded before registries are populated, so the call to the item needs to be deferred.}}
-== <tt>ToolItem</tt> ==
+== <tt>DiggerItem</tt> ==
-<code>ToolItem</code> is the base of which all tool items extend. You do not necessarily have to use this or any of its supertypes/subtypes. However, it is convenient if you are looking for standard behavior. The subtypes normally referenced are <code>AxeItem</code>, <code>HoeItem</code>, <code>PickaxeItem</code>, <code>ShovelItem</code>.
+<code>DiggerItem</code> is the base of which all tool items extend. You do not necessarily have to use this or any of its supertypes/subtypes. However, it is convenient if you are looking for standard behavior. The subtypes normally referenced are <code>AxeItem</code>, <code>HoeItem</code>, <code>PickaxeItem</code>, <code>ShovelItem</code>.
-Each tool has four parameters: tier, attack damage, attack speed, and properties. Tiers and properties have already been explained in this and within the [[Making Items|item]] docs. Attack damage specifies how much damage to do above the current base set for that specific tier. Attack speed specifies the speed modifier to apply to your current attack speed (defaults to <code>4.0D</code>).
+Each tool has four parameters: tier, attack damage, attack speed, and properties. Tiers and properties have already been explained in this and within the [[Making Items|item]] docs. Attack damage specifies how much damage to do above the current base set for that specific tier. Attack speed specifies the speed modifier to apply to your current attack speed (the base attack speed for a player is <code>4.0D</code>).
-{{Tip|content=If you decide to extend <code>ToolItem</code>, there will be a fifth parameter which defines which blocks this tool is effective on. This parameter can just be an empty set as that is now specified on each block itself.}}
+{{Tip|content=If you decide to extend <code>DiggerItem</code>, there will be a fifth parameter which defines a tag of which blocks this item is effective on.}}
 == Registering ==
-A tool must be [[Registration|registered]] the same as an item. If using one of the subtypes of <code>ToolItem</code>, that is all that is required. If not, you will need to chain <code>addToolType</code> onto your properties. This will take in a <code>ToolType</code> and a harvest level. The type is held within <code>ToolType</code> itself. The harvest level will be the value from your tier using <code>IItemTier#getHarvestLevel</code>.
+A tool must be [[Registration|registered]] the same as an item. If using one of the subtypes of <code>DiggerItem</code>, that is all that is required. If not, you will need to chain <code>addToolType</code> onto your properties. This will take in a <code>ToolType</code> and a harvest level. The type is held within <code>ToolType</code> itself. The harvest level will be the value from your tier using <code>Tier#getLevel</code>.
-{{Tip|content=If you would like to use a custom tool type, you can call <code>ToolType::get</code>. All strings passed in should have their modid appended to them to remove any conflict issues (e.g. <code>examplemod::custom_tool_type</code>). If a standard implementation across mods is used for compatibility, no namespace is needed.}}
+{{Tip|content=If you would like to use a custom tool type, you can call <code>ToolType::get</code>. All strings passed in should have their modid appended to them to remove any conflict issues (e.g. <code>examplemod_custom_tool_type</code>). If a standard implementation across mods is used for compatibility, no namespace is needed.}}
 [[Category:Items]]

← Older revision		Revision as of 00:59, 19 May 2021
Line 39:		Line 39:

	{{Tip\|content=If you would like to use a custom tool type, you can call <code>ToolType::get</code>. All strings passed in should have their modid appended to them to remove any conflict issues (e.g. <code>examplemod::custom_tool_type</code>). If a standard implementation across mods is used for compatibility, no namespace is needed.}}		{{Tip\|content=If you would like to use a custom tool type, you can call <code>ToolType::get</code>. All strings passed in should have their modid appended to them to remove any conflict issues (e.g. <code>examplemod::custom_tool_type</code>). If a standard implementation across mods is used for compatibility, no namespace is needed.}}
		+
		+
		+	[[Category:Items]]

← Older revision		Revision as of 22:04, 20 December 2020
Line 24:		Line 24:
	\|}		\|}

−	{{~~Colored box\|title=~~Important\|~~content=~~An ingredient should be wrapped in a supplier to avoid calling the object directly. Tiers are loaded before registries are populated, so the call to the item needs to be deferred.}}	+	{{Tip/Important\|An ingredient should be wrapped in a supplier to avoid calling the object directly. Tiers are loaded before registries are populated, so the call to the item needs to be deferred.}}