EnchantmentPredicate
Link to enchantmentpredicate
Represents the predicate for an MCEnchantment.
The predicate can be used to check various properties of a specific enchantment, such as its level.
This predicate must specify an enchantment to apply to. By default, the enchantment check will pass irregardless of the enchantment's level.
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 crafttweaker.api.predicate.EnchantmentPredicate;
Extending AnyDefaultingVanillaWrappingPredicate
Link to extending-anydefaultingvanillawrappingpredicate
EnchantmentPredicate extends AnyDefaultingVanillaWrappingPredicate. That means all methods available in AnyDefaultingVanillaWrappingPredicate are also available in EnchantmentPredicate
Methods
Link to methods
Name: withEnchantment
Sets the enchantment that needs to be present, and whose data needs to be checked.
This parameter is required.
Returns: This predicate for chaining.
Return Type: EnchantmentPredicate
ZenScript CopyEnchantmentPredicate.withEnchantment(enchantment as MCEnchantment) as EnchantmentPredicate
| Parameter | Type | Description |
|---|---|---|
Parameter enchantment | Type MCEnchantment | Description The enchantment that needs to be present. |
Name: withExactLevel
Sets the level to exactly match the given value.
If the level had already some bounds specified, then they will be overwritten with the new value.
Returns: This predicate for chaining.
Return Type: EnchantmentPredicate
ZenScript CopyEnchantmentPredicate.withExactLevel(value as int) as EnchantmentPredicate
| Parameter | Type | Description |
|---|---|---|
Parameter value | Type int | Description The exact value the level should be. |
Name: withMaximumLevel
Sets the maximum value the level should be to max.
If the level had already some bounds specified, then the maximum value of the bound will be overwritten with the
value specified in max. On the other hand, if the level didn't have any bounds set, the maximum is
set, leaving the lower end unbounded.
The maximum value is inclusive, meaning that a value that is equal to max will pass the check.
Returns: This predicate for chaining.
Return Type: EnchantmentPredicate
ZenScript CopyEnchantmentPredicate.withMaximumLevel(max as int) as EnchantmentPredicate
| Parameter | Type | Description |
|---|---|---|
Parameter max | Type int | Description The maximum value the level should be. |
Name: withMinimumLevel
Sets the minimum value the level should be to min.
If the level had already some bounds specified, then the minimum value of the bound will be overwritten with the
value specified in min. On the other hand, if the level didn't have any bounds set, the minimum is
set, leaving the upper end unbounded.
The minimum value is inclusive, meaning that a value that is equal to min will pass the check.
Returns: This predicate for chaining.
Return Type: EnchantmentPredicate
ZenScript CopyEnchantmentPredicate.withMinimumLevel(min as int) as EnchantmentPredicate
| Parameter | Type | Description |
|---|---|---|
Parameter min | Type int | Description The minimum value the level should be. |
Name: withRangedLevel
Sets both the minimum and maximum value the level should be to min and max
respectively.
If the level had already some bounds specified, then they will be overwritten with the new values.
Both minimum and maximum values are inclusive, meaning that a value that is equal to either min or
max will pass the check.
Returns: This predicate for chaining.
Return Type: EnchantmentPredicate
ZenScript CopyEnchantmentPredicate.withRangedLevel(min as int, max as int) as EnchantmentPredicate
| Parameter | Type | Description |
|---|---|---|
Parameter min | Type int | Description The minimum value the level should be. |
Parameter max | Type int | Description The maximum value the level should be. |