Interface EnchantmentDefinition.Builder

Enclosing interface:

EnchantmentDefinition

@NonExtendable
public static interface EnchantmentDefinition.Builder

Builds an EnchantmentDefinition.

The supported items are mandatory. Other values default to: the translatable description enchantment.<namespace>.<value>, a maximum level of 1, a weight of 1, an anvil cost of 1, a minimum cost of 1 + 10 per level, a maximum cost of 21 + 10 per level and the EquipmentSlotGroup.ANY slot group.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
EnchantmentDefinition.Builder	anvilCost(int anvilCost)
EnchantmentDefinition.Builder	behaviour(EnchantmentBehaviour behaviour)
EnchantmentDefinition	build()	Returns the built definition.
EnchantmentDefinition.Builder	description(Component description)
EnchantmentDefinition.Builder	effectsJson(@Nullable String json)	Sets the effect components of the enchantment, in the format of the effects object of a data pack enchantment, for instance {"minecraft:damage": [{"effect": {"type": "minecraft:add", "value": 2}}]}.
EnchantmentDefinition.Builder	exclusiveSetTag(TagKey<EnchantmentDefinition> tag)	Makes the enchantment incompatible with every enchantment of a tag, such as minecraft:exclusive_set/damage.
EnchantmentDefinition.Builder	exclusiveWith(Collection<TypedKey<EnchantmentDefinition>> enchantments)	Makes the enchantment incompatible with the given enchantments.
EnchantmentDefinition.Builder	maxCost(int base, int perLevelAboveFirst)
EnchantmentDefinition.Builder	maxLevel(int maxLevel)
EnchantmentDefinition.Builder	minCost(int base, int perLevelAboveFirst)
EnchantmentDefinition.Builder	primaryItems(Collection<TypedKey<Item>> items)
EnchantmentDefinition.Builder	primaryItemTag(TagKey<Item> tag)
default EnchantmentDefinition.Builder	slots(EquipmentSlotGroup... slots)
EnchantmentDefinition.Builder	slots(Collection<EquipmentSlotGroup> slots)
EnchantmentDefinition.Builder	supportedItems(Collection<TypedKey<Item>> items)
EnchantmentDefinition.Builder	supportedItemTag(TagKey<Item> tag)
EnchantmentDefinition.Builder	weight(int weight)

Method Details

description

EnchantmentDefinition.Builder description(Component description)

Parameters:

description - the name of the enchantment, without its level

Returns:

this builder

Since:

0.1.0

supportedItemTag

EnchantmentDefinition.Builder supportedItemTag(TagKey<Item> tag)

Parameters:

tag - the item tag the enchantment can be applied to, such as minecraft:enchantable/weapon

Returns:

this builder

Since:

0.1.0

supportedItems

EnchantmentDefinition.Builder supportedItems(Collection<TypedKey<Item>> items)

Parameters:

items - the items the enchantment can be applied to

Returns:

this builder

Throws:

IllegalArgumentException - if items is empty

Since:

0.1.0

primaryItemTag

EnchantmentDefinition.Builder primaryItemTag(TagKey<Item> tag)

Parameters:

tag - the item tag the enchanting table offers the enchantment for

Returns:

this builder

Since:

0.1.0

primaryItems

EnchantmentDefinition.Builder primaryItems(Collection<TypedKey<Item>> items)

Parameters:

items - the items the enchanting table offers the enchantment for

Returns:

this builder

Since:

0.1.0

exclusiveSetTag

EnchantmentDefinition.Builder exclusiveSetTag(TagKey<EnchantmentDefinition> tag)

Makes the enchantment incompatible with every enchantment of a tag, such as minecraft:exclusive_set/damage. The tag is created if it does not exist.

Parameters:

tag - the enchantment tag

Returns:

this builder

Since:

0.1.0

exclusiveWith

EnchantmentDefinition.Builder exclusiveWith(Collection<TypedKey<EnchantmentDefinition>> enchantments)

Makes the enchantment incompatible with the given enchantments.

Parameters:

enchantments - the incompatible enchantments

Returns:

this builder

Since:

0.1.0

maxLevel

EnchantmentDefinition.Builder maxLevel(int maxLevel)

Parameters:

maxLevel - the maximum level, between 1 and 255

Returns:

this builder

Throws:

IllegalArgumentException - if the level is out of range

Since:

0.1.0

weight

EnchantmentDefinition.Builder weight(int weight)

Parameters:

weight - the weight in random selections, between 1 and 1024

Returns:

this builder

Throws:

IllegalArgumentException - if the weight is out of range

Since:

0.1.0

anvilCost

EnchantmentDefinition.Builder anvilCost(int anvilCost)

Parameters:

anvilCost - the base anvil cost per level

Returns:

this builder

Throws:

IllegalArgumentException - if the cost is negative

Since:

0.1.0

minCost

EnchantmentDefinition.Builder minCost(int base,
 int perLevelAboveFirst)

Parameters:

base - the minimum cost at level 1

perLevelAboveFirst - the cost added by each level above the first

Returns:

this builder

Since:

0.1.0

maxCost

EnchantmentDefinition.Builder maxCost(int base,
 int perLevelAboveFirst)

Parameters:

base - the maximum cost at level 1

perLevelAboveFirst - the cost added by each level above the first

Returns:

this builder

Since:

0.1.0

slots

EnchantmentDefinition.Builder slots(Collection<EquipmentSlotGroup> slots)

Parameters:

slots - the equipment slots in which the enchantment is active

Returns:

this builder

Throws:

IllegalArgumentException - if slots is empty

Since:

0.1.0

slots

default EnchantmentDefinition.Builder slots(EquipmentSlotGroup... slots)

Parameters:

slots - the equipment slots in which the enchantment is active

Returns:

this builder

Throws:

IllegalArgumentException - if no slot is given

Since:

0.1.0

effectsJson

EnchantmentDefinition.Builder effectsJson(@Nullable String json)

Sets the effect components of the enchantment, in the format of the effects object of a data pack enchantment, for instance {"minecraft:damage": [{"effect": {"type": "minecraft:add", "value": 2}}]}.

Every component is sent to clients; the server runs the supported ones.

Parameters:

json - the effects JSON object, or null to remove every effect component

Returns:

this builder

Throws:

IllegalArgumentException - if the JSON is malformed or contains an unknown component

Since:

0.1.0

behaviour

EnchantmentDefinition.Builder behaviour(EnchantmentBehaviour behaviour)

Parameters:

behaviour - the server-side behaviour of the enchantment

Returns:

this builder

Since:

0.1.0

build

EnchantmentDefinition build()

Returns the built definition.

Returns:

the built definition

Throws:

IllegalStateException - if no supported item was set

Since:

0.1.0