Enchantment - CraftTweaker Documentation

Version:

Language:

Home Getting Started With Scripts Commands Examples

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
 Copy
import crafttweaker.api.item.enchantment.Enchantment;

Methods

canEnchant

Name: canEnchant

Return Type: boolean

ZenScript
 Copy
Enchantment.canEnchant(stack as ItemStack) as boolean

Parameter	Type	Description
Parameter stack	Type ItemStack	Description No Description Provided

doPostAttack

Name: doPostAttack

Return Type: void

ZenScript
 Copy
Enchantment.doPostAttack(source as LivingEntity, target as Entity, level as int) as void

Parameter	Type	Description
Parameter source	Type LivingEntity	Description No Description Provided
Parameter target	Type Entity	Description No Description Provided
Parameter level	Type int	Description No Description Provided

doPostHurt

Name: doPostHurt

Return Type: void

ZenScript
 Copy
Enchantment.doPostHurt(source as LivingEntity, target as Entity, level as int) as void

Parameter	Type	Description
Parameter source	Type LivingEntity	Description No Description Provided
Parameter target	Type Entity	Description No Description Provided
Parameter level	Type int	Description No Description Provided

getDamageBonus

Name: getDamageBonus

Return Type: float

ZenScript
 Copy
Enchantment.getDamageBonus(level as int, mobType as MobType) as float

Parameter	Type	Description
Parameter level	Type int	Description No Description Provided
Parameter mobType	Type MobType	Description No Description Provided

getDamageProtection

Name: getDamageProtection

Return Type: int

ZenScript
 Copy
Enchantment.getDamageProtection(level as int, source as DamageSource) as int

Parameter	Type	Description
Parameter level	Type int	Description No Description Provided
Parameter source	Type DamageSource	Description No Description Provided

getDescriptionId

Name: getDescriptionId

Return Type: string

ZenScript
 Copy
// Enchantment.getDescriptionId() as string

myEnchantment.getDescriptionId();

getFullname

Name: getFullname

Return Type: Component

ZenScript
 Copy
Enchantment.getFullname(level as int) as Component

Parameter	Type	Description
Parameter level	Type int	Description No Description Provided

getMaxCost

Name: getMaxCost

Return Type: int

ZenScript
 Copy
Enchantment.getMaxCost(level as int) as int

Parameter	Type	Description
Parameter level	Type int	Description No Description Provided

getMaxLevel

Name: getMaxLevel

Return Type: int

ZenScript
 Copy
// Enchantment.getMaxLevel() as int

myEnchantment.getMaxLevel();

getMinCost

Name: getMinCost

Return Type: int

ZenScript
 Copy
Enchantment.getMinCost(level as int) as int

Parameter	Type	Description
Parameter level	Type int	Description No Description Provided

getMinLevel

Name: getMinLevel

Return Type: int

ZenScript
 Copy
// Enchantment.getMinLevel() as int

myEnchantment.getMinLevel();

getRarity

Name: getRarity

Return Type: Rarity

ZenScript
 Copy
// Enchantment.getRarity() as Rarity

myEnchantment.getRarity();

getSlotItems

Name: getSlotItems

Return Type: ItemStack[EquipmentSlot]

ZenScript
 Copy
Enchantment.getSlotItems(entity as LivingEntity) as ItemStack[EquipmentSlot]

Parameter	Type	Description
Parameter entity	Type LivingEntity	Description No Description Provided

isCompatibleWith

Name: isCompatibleWith

Return Type: boolean

ZenScript
 Copy
Enchantment.isCompatibleWith(other as Enchantment) as boolean

Parameter	Type	Description
Parameter other	Type Enchantment	Description No Description Provided

isCurse

Name: isCurse

Return Type: boolean

ZenScript
 Copy
// Enchantment.isCurse() as boolean

myEnchantment.isCurse();

isDiscoverable

Name: isDiscoverable

Return Type: boolean

ZenScript
 Copy
// Enchantment.isDiscoverable() as boolean

myEnchantment.isDiscoverable();

isTradeable

Name: isTradeable

Return Type: boolean

ZenScript
 Copy
// Enchantment.isTradeable() as boolean

myEnchantment.isTradeable();

isTreasureOnly

Name: isTreasureOnly

Return Type: boolean

ZenScript
 Copy
// Enchantment.isTreasureOnly() as boolean

myEnchantment.isTreasureOnly();

Properties

Name	Type	Has Getter	Has Setter	Description
Name commandString	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name descriptionId	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name isCurse	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isDiscoverable	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isTradeable	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isTreasureOnly	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name maxLevel	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name minLevel	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name rarity	Type Rarity	Has Getter true	Has Setter false	Description No Description Provided