Enchantment (Forge 1.11.2 API v13.20.1.2386 mappings snapshot

java.lang.Object
- net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl<Enchantment>
- - net.minecraft.enchantment.Enchantment

All Implemented Interfaces:

IForgeRegistryEntry<Enchantment>

Direct Known Subclasses:

EnchantmentArrowDamage, EnchantmentArrowFire, EnchantmentArrowInfinite, EnchantmentArrowKnockback, EnchantmentBindingCurse, EnchantmentDamage, EnchantmentDigging, EnchantmentDurability, EnchantmentFireAspect, EnchantmentFishingSpeed, EnchantmentFrostWalker, EnchantmentKnockback, EnchantmentLootBonus, EnchantmentMending, EnchantmentOxygen, EnchantmentProtection, EnchantmentSweepingEdge, EnchantmentThorns, EnchantmentUntouching, EnchantmentVanishingCurse, EnchantmentWaterWalker, EnchantmentWaterWorker
```
public abstract class Enchantment
extends IForgeRegistryEntry.Impl<Enchantment>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Enchantment.Rarity
- Nested classes/interfaces inherited from interface net.minecraftforge.fml.common.registry.IForgeRegistryEntry
  IForgeRegistryEntry.Impl<T extends IForgeRegistryEntry<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Enchantment.Rarity`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`name` Used in localisation and stats.
`static RegistryNamespaced<ResourceLocation,Enchantment>`	`REGISTRY`
`EnumEnchantmentType`	`type` The EnumEnchantmentType given to this Enchantment.

Fields inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl
delegate

Constructor Summary

Constructors
Modifier Constructor and Description

protected Enchantment(Enchantment.Rarity rarityIn, EnumEnchantmentType typeIn, EntityEquipmentSlot[] slots)

Constructors
Modifier	Constructor and Description
`protected`	`Enchantment(Enchantment.Rarity rarityIn, EnumEnchantmentType typeIn, EntityEquipmentSlot[] slots)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`protected boolean`	`canApplyTogether(Enchantment ench)` Determines if the enchantment passed can be applyied together with this enchantment.
`boolean`	`func_191560_c(Enchantment p_191560_1_)`
`static Enchantment`	`getEnchantmentByID(int id)` Gets an Enchantment from the registry, based on a numeric ID.
`static Enchantment`	`getEnchantmentByLocation(java.lang.String location)` Retrieves an enchantment by using its location name.
`static int`	`getEnchantmentID(Enchantment enchantmentIn)` Gets the numeric ID for the passed enchantment.
`java.util.List<ItemStack>`	`getEntityEquipment(EntityLivingBase entityIn)` Gets list of all the entity's currently equipped gear that this enchantment can go on
`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.
`Enchantment.Rarity`	`getRarity()` Retrieves the weight value of an Enchantment.
`java.lang.String`	`getTranslatedName(int level)` Returns the correct traslated name of the enchantment and the level in roman numbers.
`boolean`	`isAllowedOnBooks()` Is this enchantment allowed to be enchanted on books via Enchantment Table
`boolean`	`isCurse()`
`boolean`	`isTreasureEnchantment()`
`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.
`static void`	`registerEnchantments()` Registers all of the vanilla enchantments.
`Enchantment`	`setName(java.lang.String enchName)` Sets the enchantment name

Methods inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl
getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

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

- Field Detail
  - REGISTRY
```
public static final RegistryNamespaced<ResourceLocation,Enchantment> REGISTRY
```
  - 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(Enchantment.Rarity rarityIn,
                      EnumEnchantmentType typeIn,
                      EntityEquipmentSlot[] slots)
```
- Method Detail
  - getEnchantmentByID
```
public static Enchantment getEnchantmentByID(int id)
```
    Gets an Enchantment from the registry, based on a numeric ID.
  - getEnchantmentID
```
public static int getEnchantmentID(Enchantment enchantmentIn)
```
    Gets the numeric ID for the passed enchantment.
  - getEnchantmentByLocation
```
public static Enchantment getEnchantmentByLocation(java.lang.String location)
```
    Retrieves an enchantment by using its location name.
  - getEntityEquipment
```
public java.util.List<ItemStack> getEntityEquipment(EntityLivingBase entityIn)
```
    Gets list of all the entity's currently equipped gear that this enchantment can go on
  - getRarity
```
public Enchantment.Rarity getRarity()
```
    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.
  - func_191560_c
```
public final boolean func_191560_c(Enchantment p_191560_1_)
```
  - canApplyTogether
```
protected 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.
  - isTreasureEnchantment
```
public boolean isTreasureEnchantment()
```
  - isCurse
```
public boolean isCurse()
```
  - 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:
  - isAllowedOnBooks
```
public boolean isAllowedOnBooks()
```
    Is this enchantment allowed to be enchanted on books via Enchantment Table
    
    Returns:
    
    false to disable the vanilla feature
  - registerEnchantments
```
public static void registerEnchantments()
```
    Registers all of the vanilla enchantments.

Class Enchantment

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraftforge.fml.common.registry.IForgeRegistryEntry

Field Summary

Fields inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl

Methods inherited from class java.lang.Object

Field Detail

REGISTRY

type

name

Constructor Detail

Enchantment

Method Detail

getEnchantmentByID

getEnchantmentID

getEnchantmentByLocation

getEntityEquipment

getRarity

getMinLevel

getMaxLevel

getMinEnchantability

getMaxEnchantability

calcModifierDamage

calcDamageByCreature

func_191560_c

canApplyTogether

setName

getName

getTranslatedName

canApply

onEntityDamaged

onUserHurt

isTreasureEnchantment

isCurse

canApplyAtEnchantingTable

isAllowedOnBooks

registerEnchantments