ItemBuilderTool
Link to itembuildertool
A special builder that allows you to create items that can be used as tools. You should have set the item's max damage before changing to this builder.
Has special methods that allow you to set the mining level for several tool types as well as the attack damage.
This class was added by a mod with mod-id contenttweaker. So you need to have this mod installed if you want to use this feature.
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport mods.contenttweaker.item.tool.ItemBuilderTool;
Extending ItemTypeBuilder
Link to extending-itemtypebuilder
ItemBuilderTool extends ItemTypeBuilder. That means all methods available in ItemTypeBuilder are also available in ItemBuilderTool
Methods
Link to methods
Name: build
Instructs CoT to actually build whatever this builder is supposed to be building.
Return Type: void
ZenScript Copy// ItemBuilderTool.build(resourceLocation as string) as void
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().build("my_awesome_block");
| Parameter | Type | Description |
|---|---|---|
Parameter resourceLocation | Type string | Description The resource path to give this block |
Name: withAttackDamage
Allows you to set the attack damage bonus that you get when holding this item
Returns: This builder, used for method chaining
Return Type: ItemBuilderTool
ZenScript Copy// ItemBuilderTool.withAttackDamage(attackDamage as float) as ItemBuilderTool
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().withAttackDamage(2.0f);
| Parameter | Type | Description |
|---|---|---|
Parameter attackDamage | Type float | Description The additional attack damage |
Name: withAttackSpeed
Allows you to set the attack speed bonus that you get when holding this item.
Returns: This builder, used for method chaining.
Return Type: ItemBuilderTool
ZenScript Copy// ItemBuilderTool.withAttackSpeed(attackSpeed as double) as ItemBuilderTool
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().withAttackSpeed(2.0d);
| Parameter | Type | Description |
|---|---|---|
Parameter attackSpeed | Type double | Description The attack speed |
Name: withDurabilityCostAttack
Allows you to set the amount of damage that this item will receive when hitting enemies.
By default this is 0
Returns: This builder, used for method chaining
Return Type: ItemBuilderTool
ZenScript Copy// ItemBuilderTool.withDurabilityCostAttack(durabilityCostAttack as int) as ItemBuilderTool
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().withDurabilityCostAttack(5);
| Parameter | Type | Description |
|---|---|---|
Parameter durabilityCostAttack | Type int | Description The damage points this item will receive |
Name: withDurabilityCostMining
Allows you to set the amount of damage that this item will receive when mining blocks.
By default this is 0
Returns: This builder, used for method chaining
Return Type: ItemBuilderTool
ZenScript Copy// ItemBuilderTool.withDurabilityCostMining(durabilityCostMining as int) as ItemBuilderTool
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().withDurabilityCostMining(1);
| Parameter | Type | Description |
|---|---|---|
Parameter durabilityCostMining | Type int | Description The damage points this item will receive |
Name: withToolType
Allows you to add a tool type to this tool. You can specify the type, the mining level and optionally the mining speed when this type is hit as well.
Returns: This builder, used for method chaining
Return Type: ItemBuilderTool
ZenScript Copy// ItemBuilderTool.withToolType(toolType as ToolType, miningLevel as int, miningSpeed as float) as ItemBuilderTool
new ItemBuilder().withMaxDamage(150).withType<ItemBuilderTool>().withToolType(<tooltype:shovel>, 3, 2.0f);
| Parameter | Type | Description | Optional | DefaultValue |
|---|---|---|---|---|
Parameter toolType | Type ToolType | Description The type of the tool | Optional false | DefaultValue |
Parameter miningLevel | Type int | Description The mining level for this tool type | Optional false | DefaultValue |
Parameter miningSpeed | Type float | Description How fast this tool can mine blocks of the given type | Optional true | DefaultValue 1.0 |