Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:enchantments

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:enchantments [2019/07/02 20:23] – finish up end of tut draylartutorial:enchantments [2024/08/23 13:52] (current) – [Adding Translations] solidblock
Line 1: Line 1:
-===== Adding Enchantments =====+====== Adding Enchantments ====== 
 + 
 +===== Adding enchantments since 1.21 ===== 
 +Since 1.21, enchantments has been data-driven, which means you should define them in data-packs, instead of in the codes. Please see [[https://minecraft.wiki/w/Enchantment_definition|Enchantment definition Minecraft page]] for details. 
 + 
 +To use the enchantments in code, you should just store ''RegistryKey'' objects of the enchantment. 
 +<code java TutorialEnchantments> 
 +public final class TutorialEnchantments { 
 +  public static final RegistryKey<Enchantment> FROST = of("frost"); 
 + 
 +  private static RegistryKey<Enchantment> of(String name) { 
 +    return RegistryKey.of(RegistryKeys.ENCHANTMENT, Identifier.of("tutorial", name)); 
 +  } 
 + 
 +  public static void initialize() { 
 +  } 
 +} 
 +</code> 
 + 
 +Remember to refer to the ''initialize'' method in your ''ModInitializer'': 
 +<code java ExampleMod> 
 +public class ExampleMod implements ModInitializer { 
 +  // [...] 
 + 
 +  @Override 
 +  public void onInitialize() { 
 +    // [...] 
 +    TutorialEnchantments.initialize(); 
 +  } 
 +} 
 +</code> 
 + 
 +To add a translated name for your enchantment, see the bottom of the tutorial. 
 + 
 +===== Adding enchantments before 1.21 ===== 
 +:!: This part of the tutorial only applies to older Minecraft versions.
  
 To add enchantments to your mod, you'll need to: To add enchantments to your mod, you'll need to:
Line 7: Line 42:
   * add translations for your enchantment ((When you register enchantments, books are automatically added to the game for each level. The translated name of the enchantment (''enchantment.modid.enchantname'') is what appears as the book name.))   * add translations for your enchantment ((When you register enchantments, books are automatically added to the game for each level. The translated name of the enchantment (''enchantment.modid.enchantname'') is what appears as the book name.))
  
-Enchantments can either have custom functionality implemented separately (such as smelting ores mined) or can use already existing mechanics (such as ''DamageEnchantment''), which are applied when appropriate.+Enchantments can either have custom functionality implemented separately (such as smelting ores mined) or can use already existing mechanics (such as ''DamageEnchantment''), which are applied when appropriate. The base ''Enchantment'' class also has several methods to create functionality, such as an "on enemy hit" method.
  
 ==== Creating Enchantment Class ==== ==== Creating Enchantment Class ====
-We'll be creating an enchantment called //Wrath//, which adds an extra 1.5 points of damage, per level, to a melee weapon. The easiest way to do this is by creating a class that extends ''DamageEnchantment'':+Our new enchantment is called //Frost// and slows mobs on hit. The slowness effect, durability, and potency will grow relative to the level of the enchantment. In our enchantment class, we pass up ''UNCOMMON'' as the enchantment rarity, ''WEAPON'' as the enchantment target, and ''MAINHAND'' as the only valid tool type for our enchantment.
 <code java [enable_line_numbers="true"]> <code java [enable_line_numbers="true"]>
-public class WrathEnchantment extends DamageEnchantment  +public class FrostEnchantment extends Enchantment { 
-{ +    public FrostEnchantment() { 
-    public WrathEnchantment(Weight weight, int typeIndex, EquipmentSlot... slots) +        super(Enchantment.Rarity.UNCOMMON, EnchantmentTarget.WEAPON, new EquipmentSlot[] {EquipmentSlot.MAINHAND});
-    { +
-        super(weight, typeIndex, slots) +
-    } +
- +
-    @Override +
-    public float getAttackDamage(int level, EntityGroup group) +
-    { +
-        // .... +
-    } +
- +
-    @Override +
-    public int getMinimumPower(int int_1) +
-    { +
-        // .... +
-    } +
- +
-    @Override +
-    public int getMaximumLevel() +
-    { +
-        // .... +
-    } +
- +
-    @Override +
-    public boolean differs(Enchantment enchantment) +
-    { +
-        // ....+
     }     }
 } }
 </code> </code>
  
-''getAttackDamage'', as you would expect, is the additional damage provided by the enchantment. ''level'' is the level of the enchantment:+We will now override a few basic methods for basic functionality: 
 + 
 +''getMinPower'' is related to the minimum level needed to see the enchant in a table, but it is not a 1:1 ratio. Most enchantments return something like ''10 * level'', with different scales depending on the max level and rarity of the enchantment. We will return 1 so it is always available. Note that the max power of an enchantment is set to ''min(level) + 5'' by default, which means this enchantment will only appear at very low levels. You will have to tweak your enchantment properties on your own and look at similar enchantment values to find the sweet number spot.
 <code java [enable_line_numbers="false"]> <code java [enable_line_numbers="false"]>
 @Override @Override
-public float getAttackDamage(int level, EntityGroup group) +public int getMinPower(int level) { 
-{ +    return 1;
-    return level * 1.5f;+
 } }
 </code> </code>
  
-''getMinimumPower'' is the minimum level required to get the enchant in an enchanting table. We'll set it to 1, so you can get it at any level:+''getMaxLevel'' is the number of levels the enchantment has. Sharpness has a max level of 5. ((Enchantments with more than a single level will have roman numerals after the name to show the level. If the enchantment only has a single level, nothing is added.))
 <code java [enable_line_numbers="false"]> <code java [enable_line_numbers="false"]>
 @Override @Override
-public int getMinimumPower(int int_1) +public int getMaxLevel() { 
-{ +    return 3;
-    return 1;;+
 } }
 </code> </code>
  
-''getMaximumLevel'' is the number of tiers the enchantment has. ((Enchantments with more than a single tier will have roman numerals after the name to show the level. If the enchantment only has a single level, nothing is added.))+Finally, we will implement our slowness effect in the ''onTargetDamage'' method, which is called when you whack an enemy with a tool that has your enchantment.
 <code java [enable_line_numbers="false"]> <code java [enable_line_numbers="false"]>
 @Override @Override
-public int getMaximumLevel() +public void onTargetDamaged(LivingEntity user, Entity target, int level) { 
-{ +    if(target instanceof LivingEntity livingEntity) { 
-    return 5;+        livingEntity.addStatusEffect(new StatusEffectInstance(StatusEffects.SLOWNESS, 20 * 2 * level, level - 1)); 
 +    } 
 + 
 +    super.onTargetDamaged(user, target, level);
 } }
 </code> </code>
 +If the entity we are hitting can have status effects (''LivingEntity''s can have status effects, but not ''Entity''), give it the slowness effect. The duration of the effect is 2 seconds per level, and the potency is equivalent to the level.
  
-Finally, ''differs'' is how you isolate enchantments and prevent them from being on the same tool. As an example, sharpness can't be used with smite. We'll prevent our enchant from being combined with sharpness. +The final enchantment file should look like this. 
-<code java [enable_line_numbers="false"]> +<code java [enable_line_numbers="true"]> 
-@Override +public class FrostEnchantment extends Enchantment { 
-public boolean differs(Enchantment enchantment) +    public FrostEnchantment() { 
-{ +        super(Enchantment.Rarity.UNCOMMON, EnchantmentTarget.WEAPON, new EquipmentSlot[] {EquipmentSlot.MAINHAND}); 
-    return super.differs(enchantment) && enchantment != Enchantments.SHARPNESS;+    } 
 +     
 +    @Override 
 +    public int getMinPower(int level) { 
 +        return 1; 
 +    } 
 + 
 +    @Override 
 +    public int getMaxLevel() { 
 +        return 3; 
 +    } 
 + 
 +    public void onTargetDamaged(LivingEntity user, Entity target, int level) { 
 +        if(target instanceof LivingEntity) { 
 +            ((LivingEntity) target).addStatusEffect(new StatusEffectInstance(StatusEffects.SLOWNESS, 20 * 2 * level, level - 1)); 
 +        } 
 + 
 +        super.onTargetDamaged(user, target, level); 
 +    }
 } }
 </code> </code>
Line 84: Line 115:
 Registering enchantments follows the same process as usual: Registering enchantments follows the same process as usual:
 <code java [enable_line_numbers="false"]> <code java [enable_line_numbers="false"]>
-private static Enchantment WRATH;+public class ExampleMod implements ModInitializer { 
 +    public static Enchantment FROST = new FrostEnchantment();
  
-@Override +    @Override 
-public void onInitialize() +    public void onInitialize() { 
-{ +        Registry.register(Registries.ENCHANTMENT, new Identifier("tutorial", "frost"), FROST); 
-    WRATH = Registry.register( +    }
-        Registry.ENCHANTMENT, +
- new Identifier("tutorial", "wrath"), +
- new WrathEnchantment( +
-     Enchantment.Weight.VERY_RARE, +
-     0, +
-     EquipmentSlot.MAINHAND +
- ) +
-    );+
 } }
 </code> </code>
 +> **Note:** In practice, if you have many enchantments, it is better to place them in a separate class. Here we did all things in ''ModInitializer'' for simplicity.
  
-This registers our enchantment under the namespace ''tutorial:wrath'', sets it as a very rare enchantment, and only allows it on main hand tools.+This registers our enchantment under the namespace ''tutorial:frost''. All non-treasure enchantments are available in an enchanting table, including the ones you register. 
 + 
 +===== Adding Translations ===== 
 +=) This part works both versions since 1.21 and before 1.21.
  
-==== Adding Translations & Testing ==== 
 You'll need to add a translation to your enchantment as well. Head over to your [[tutorial:lang|mod lang file]] and add a new entry: You'll need to add a translation to your enchantment as well. Head over to your [[tutorial:lang|mod lang file]] and add a new entry:
  
-<code json [enable_line_numbers="false"]>+<code javascript resources/data/tutorial/lang/en_us.json>
 { {
-    "enchantment.tutorial.wrath": "Wrath"+    "enchantment.tutorial.frost": "Frost"
 } }
 </code> </code>
  
-If you go in-game, you should be able to enchant main hand weapons with your new enchant:+If you go in-game, [[https://i.imgur.com/31nFl2H.png|you should be able to enchant main hand weapons with your new enchant.]] 
 + 
  
-{{:tutorial:enchantment_wrath.png?400|}} 
  
tutorial/enchantments.1562098982.txt.gz · Last modified: 2019/07/02 20:23 by draylar