Enchantment (Forge API 1.8.9-11.15.1.2318)

java.lang.Object
- net.minecraft.enchantment.Enchantment

Direct Known Subclasses:

EnchantmentArrowDamage, EnchantmentArrowFire, EnchantmentArrowInfinite, EnchantmentArrowKnockback, EnchantmentDamage, EnchantmentDigging, EnchantmentDurability, EnchantmentFireAspect, EnchantmentFishingSpeed, EnchantmentKnockback, EnchantmentLootBonus, EnchantmentOxygen, EnchantmentProtection, EnchantmentThorns, EnchantmentUntouching, EnchantmentWaterWalker, EnchantmentWaterWorker
```
public abstract class Enchantment
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static Enchantment`	`aquaAffinity` Increases underwater mining rate
`static Enchantment`	`baneOfArthropods`
`static Enchantment`	`blastProtection` Protection against explosions
`static Enchantment`	`depthStrider`
`int`	`effectId`
`static Enchantment`	`efficiency` Faster resource gathering while in use
`static Enchantment[]`	`enchantmentsBookList`
`static Enchantment`	`featherFalling`
`static Enchantment`	`fireAspect` Lights mobs on fire
`static Enchantment`	`fireProtection` Protection against fire
`static Enchantment`	`flame` Flame enchantment for bows.
`static Enchantment`	`fortune` Can multiply the drop rate of items from blocks
`static Enchantment`	`infinity` Infinity enchantment for bows.
`static Enchantment`	`knockback`
`static Enchantment`	`looting` Mobs have a chance to drop more loot
`static Enchantment`	`luckOfTheSea`
`static Enchantment`	`lure`
`protected java.lang.String`	`name` Used in localisation and stats.
`static Enchantment`	`power` Power enchantment for bows, add's extra damage to arrows.
`static Enchantment`	`projectileProtection`
`static Enchantment`	`protection`
`static Enchantment`	`punch` Knockback enchantments for bows, the arrows will knockback the target when hit.
`static Enchantment`	`respiration`
`static Enchantment`	`sharpness`
`static Enchantment`	`silkTouch` Blocks mined will drop themselves, even if it should drop something else (e.g. stone will drop stone, not cobblestone)
`static Enchantment`	`smite`
`static Enchantment`	`thorns`
`EnumEnchantmentType`	`type` The EnumEnchantmentType given to this Enchantment.
`static Enchantment`	`unbreaking` Sometimes, the tool's durability will not be spent when the tool is used

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Enchantment(int enchID, ResourceLocation enchName, int enchWeight, EnumEnchantmentType enchType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addToBookList(Enchantment enchantment)` Add to the list of enchantments applicable by the anvil from a book
`float`	`calcDamageByCreature(int level, EnumCreatureAttribute creatureType)` Calculates the additional damage that will be dealt by an item with this enchantment.
`int`	`calcModifierDamage(int level, DamageSource source)` Calculates the damage protection of the enchantment based on level and damage source passed.
`boolean`	`canApply(ItemStack stack)` Determines if this enchantment can be applied to a specific ItemStack.
`boolean`	`canApplyAtEnchantingTable(ItemStack stack)` This applies specifically to applying at the enchanting table.
`boolean`	`canApplyTogether(Enchantment ench)` Determines if the enchantment passed can be applyied together with this enchantment.
`static java.util.Set<ResourceLocation>`	`func_181077_c()`
`static Enchantment`	`getEnchantmentById(int enchID)` Retrieves an Enchantment from the enchantmentsList
`static Enchantment`	`getEnchantmentByLocation(java.lang.String location)` Retrieves an enchantment by using its location name.
`int`	`getMaxEnchantability(int enchantmentLevel)` Returns the maximum value of enchantability nedded on the enchantment level passed.
`int`	`getMaxLevel()` Returns the maximum level that the enchantment can have.
`int`	`getMinEnchantability(int enchantmentLevel)` Returns the minimal value of enchantability needed on the enchantment level passed.
`int`	`getMinLevel()` Returns the minimum level that the enchantment can have.
`java.lang.String`	`getName()` Return the name of key in translation table of this enchantment.
`java.lang.String`	`getTranslatedName(int level)` Returns the correct traslated name of the enchantment and the level in roman numbers.
`int`	`getWeight()` Retrieves the weight value of an Enchantment.
`boolean`	`isAllowedOnBooks()` Is this enchantment allowed to be enchanted on books via Enchantment Table
`void`	`onEntityDamaged(EntityLivingBase user, Entity target, int level)` Called whenever a mob is damaged with an item that has this enchantment on it.
`void`	`onUserHurt(EntityLivingBase user, Entity attacker, int level)` Whenever an entity that has this enchantment on one of its associated items is damaged this method will be called.
`Enchantment`	`setName(java.lang.String enchName)` Sets the enchantment name

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - enchantmentsBookList
```
public static final Enchantment[] enchantmentsBookList
```
  - protection
```
public static final Enchantment protection
```
  - fireProtection
```
public static final Enchantment fireProtection
```
    Protection against fire
  - featherFalling
```
public static final Enchantment featherFalling
```
  - blastProtection
```
public static final Enchantment blastProtection
```
    Protection against explosions
  - projectileProtection
```
public static final Enchantment projectileProtection
```
  - respiration
```
public static final Enchantment respiration
```
  - aquaAffinity
```
public static final Enchantment aquaAffinity
```
    Increases underwater mining rate
  - thorns
```
public static final Enchantment thorns
```
  - depthStrider
```
public static final Enchantment depthStrider
```
  - sharpness
```
public static final Enchantment sharpness
```
  - smite
```
public static final Enchantment smite
```
  - baneOfArthropods
```
public static final Enchantment baneOfArthropods
```
  - knockback
```
public static final Enchantment knockback
```
  - fireAspect
```
public static final Enchantment fireAspect
```
    Lights mobs on fire
  - looting
```
public static final Enchantment looting
```
    Mobs have a chance to drop more loot
  - efficiency
```
public static final Enchantment efficiency
```
    Faster resource gathering while in use
  - silkTouch
```
public static final Enchantment silkTouch
```
    Blocks mined will drop themselves, even if it should drop something else (e.g. stone will drop stone, not cobblestone)
  - unbreaking
```
public static final Enchantment unbreaking
```
    Sometimes, the tool's durability will not be spent when the tool is used
  - fortune
```
public static final Enchantment fortune
```
    Can multiply the drop rate of items from blocks
  - power
```
public static final Enchantment power
```
    Power enchantment for bows, add's extra damage to arrows.
  - punch
```
public static final Enchantment punch
```
    Knockback enchantments for bows, the arrows will knockback the target when hit.
  - flame
```
public static final Enchantment flame
```
    Flame enchantment for bows. Arrows fired by the bow will be on fire. Any target hit will also set on fire.
  - infinity
```
public static final Enchantment infinity
```
    Infinity enchantment for bows. The bow will not consume arrows anymore, but will still required at least one arrow on inventory use the bow.
  - luckOfTheSea
```
public static final Enchantment luckOfTheSea
```
  - lure
```
public static final Enchantment lure
```
  - effectId
```
public final int effectId
```
  - type
```
public EnumEnchantmentType type
```
    The EnumEnchantmentType given to this Enchantment.
  - name
```
protected java.lang.String name
```
    Used in localisation and stats.
- Constructor Detail
  - Enchantment
```
protected Enchantment(int enchID,
                      ResourceLocation enchName,
                      int enchWeight,
                      EnumEnchantmentType enchType)
```
- Method Detail
  - getEnchantmentById
```
public static Enchantment getEnchantmentById(int enchID)
```
    Retrieves an Enchantment from the enchantmentsList
  - getEnchantmentByLocation
```
public static Enchantment getEnchantmentByLocation(java.lang.String location)
```
    Retrieves an enchantment by using its location name.
  - func_181077_c
```
public static java.util.Set<ResourceLocation> func_181077_c()
```
  - getWeight
```
public int getWeight()
```
    Retrieves the weight value of an Enchantment. This weight value is used within vanilla to determine how rare an enchantment is.
  - getMinLevel
```
public int getMinLevel()
```
    Returns the minimum level that the enchantment can have.
  - getMaxLevel
```
public int getMaxLevel()
```
    Returns the maximum level that the enchantment can have.
  - getMinEnchantability
```
public int getMinEnchantability(int enchantmentLevel)
```
    Returns the minimal value of enchantability needed on the enchantment level passed.
  - getMaxEnchantability
```
public int getMaxEnchantability(int enchantmentLevel)
```
    Returns the maximum value of enchantability nedded on the enchantment level passed.
  - calcModifierDamage
```
public int calcModifierDamage(int level,
                              DamageSource source)
```
    Calculates the damage protection of the enchantment based on level and damage source passed.
  - calcDamageByCreature
```
public float calcDamageByCreature(int level,
                                  EnumCreatureAttribute creatureType)
```
    Calculates the additional damage that will be dealt by an item with this enchantment. This alternative to calcModifierDamage is sensitive to the targets EnumCreatureAttribute.
  - canApplyTogether
```
public boolean canApplyTogether(Enchantment ench)
```
    Determines if the enchantment passed can be applyied together with this enchantment.
  - setName
```
public Enchantment setName(java.lang.String enchName)
```
    Sets the enchantment name
  - getName
```
public java.lang.String getName()
```
    Return the name of key in translation table of this enchantment.
  - getTranslatedName
```
public java.lang.String getTranslatedName(int level)
```
    Returns the correct traslated name of the enchantment and the level in roman numbers.
  - canApply
```
public boolean canApply(ItemStack stack)
```
    Determines if this enchantment can be applied to a specific ItemStack.
  - onEntityDamaged
```
public void onEntityDamaged(EntityLivingBase user,
                            Entity target,
                            int level)
```
    Called whenever a mob is damaged with an item that has this enchantment on it.
  - onUserHurt
```
public void onUserHurt(EntityLivingBase user,
                       Entity attacker,
                       int level)
```
    Whenever an entity that has this enchantment on one of its associated items is damaged this method will be called.
  - canApplyAtEnchantingTable
```
public boolean canApplyAtEnchantingTable(ItemStack stack)
```
    This applies specifically to applying at the enchanting table. The other method canApply(ItemStack) applies for all possible enchantments.
    
    Parameters:
    
    stack -
    
    Returns:
  - addToBookList
```
public static void addToBookList(Enchantment enchantment)
```
    Add to the list of enchantments applicable by the anvil from a book
    
    Parameters:
    
    enchantment -
  - isAllowedOnBooks
```
public boolean isAllowedOnBooks()
```
    Is this enchantment allowed to be enchanted on books via Enchantment Table
    
    Returns:
    
    false to disable the vanilla feature

Class Enchantment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

enchantmentsBookList

protection

fireProtection

featherFalling

blastProtection

projectileProtection

respiration

aquaAffinity

thorns

depthStrider

sharpness

smite

baneOfArthropods

knockback

fireAspect

looting

efficiency

silkTouch

unbreaking

fortune

power

punch

flame

infinity

luckOfTheSea

lure

effectId

type

name

Constructor Detail

Enchantment

Method Detail

getEnchantmentById

getEnchantmentByLocation

func_181077_c

getWeight

getMinLevel

getMaxLevel

getMinEnchantability

getMaxEnchantability

calcModifierDamage

calcDamageByCreature

canApplyTogether

setName

getName

getTranslatedName

canApply

onEntityDamaged

onUserHurt

canApplyAtEnchantingTable

addToBookList

isAllowedOnBooks