Home Commands Examples Getting Started With Scripts Global Keywords

Enchantment

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.

script.zs
import crafttweaker.api.item.enchantment.Enchantment;

Methods

Return Type: boolean

script.zs
Enchantment.canEnchant(stack as ItemStack) as boolean
ParameterType
Parameter
stack
Type
ItemStack
script.zs
Enchantment.doPostAttack(source as LivingEntity, target as Entity, level as int)
ParameterType
Parameter
source
Type
LivingEntity
Parameter
target
Type
Entity
Parameter
level
Type
int
script.zs
Enchantment.doPostHurt(source as LivingEntity, target as Entity, level as int)
ParameterType
Parameter
source
Type
LivingEntity
Parameter
target
Type
Entity
Parameter
level
Type
int

Return Type: float

script.zs
Enchantment.getDamageBonus(level as int, mobType as MobType) as float
ParameterType
Parameter
level
Type
int
Parameter
mobType
Type
MobType

Return Type: int

script.zs
Enchantment.getDamageProtection(level as int, source as DamageSource) as int
ParameterType
Parameter
level
Type
int
Parameter
source
Type
DamageSource

Return Type: string

script.zs
// Enchantment.getDescriptionId() as string
myEnchantment.getDescriptionId();

Return Type: Component

script.zs
Enchantment.getFullname(level as int) as Component
ParameterType
Parameter
level
Type
int

Return Type: int

script.zs
Enchantment.getMaxCost(level as int) as int
ParameterType
Parameter
level
Type
int

Return Type: int

script.zs
// Enchantment.getMaxLevel() as int
myEnchantment.getMaxLevel();

Return Type: int

script.zs
Enchantment.getMinCost(level as int) as int
ParameterType
Parameter
level
Type
int

Return Type: int

script.zs
// Enchantment.getMinLevel() as int
myEnchantment.getMinLevel();

Return Type: Rarity

script.zs
// Enchantment.getRarity() as Rarity
myEnchantment.getRarity();

Return Type: ResourceLocation

script.zs
// Enchantment.getRegistryName() as ResourceLocation
myEnchantment.getRegistryName();

Return Type: ItemStack[EquipmentSlot]

script.zs
Enchantment.getSlotItems(entity as LivingEntity) as ItemStack[EquipmentSlot]
ParameterType
Parameter
entity
Type
LivingEntity

Return Type: boolean

script.zs
Enchantment.isCompatibleWith(other as Enchantment) as boolean
ParameterType
Parameter
other
Type
Enchantment

Return Type: boolean

script.zs
// Enchantment.isCurse() as boolean
myEnchantment.isCurse();

Return Type: boolean

script.zs
// Enchantment.isDiscoverable() as boolean
myEnchantment.isDiscoverable();

Return Type: boolean

script.zs
// Enchantment.isTradeable() as boolean
myEnchantment.isTradeable();

Return Type: boolean

script.zs
// Enchantment.isTreasureOnly() as boolean
myEnchantment.isTreasureOnly();

Properties

NameTypeHas GetterHas Setter
Name
commandString
Type
string
Has Getter
true
Has Setter
false
Name
descriptionId
Type
string
Has Getter
true
Has Setter
false
Name
isCurse
Type
boolean
Has Getter
true
Has Setter
false
Name
isDiscoverable
Type
boolean
Has Getter
true
Has Setter
false
Name
isTradeable
Type
boolean
Has Getter
true
Has Setter
false
Name
isTreasureOnly
Type
boolean
Has Getter
true
Has Setter
false
Name
maxLevel
Type
int
Has Getter
true
Has Setter
false
Name
minLevel
Type
int
Has Getter
true
Has Setter
false
Name
rarity
Type
Rarity
Has Getter
true
Has Setter
false
Name
registryName
Type
ResourceLocation
Has Getter
true
Has Setter
false