Differences

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

--- tutorial:enchantments [2020/07/03 19:02] – draylar
+++ tutorial: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:
@@ Line 13: / Line 48: @@
 <code java [enable_line_numbers="true"]>
 public class FrostEnchantment extends Enchantment {
     public FrostEnchantment() {
         super(Enchantment.Rarity.UNCOMMON, EnchantmentTarget.WEAPON, new EquipmentSlot[] {EquipmentSlot.MAINHAND});
@@ Line 42: / Line 76: @@
 @Override
 public void onTargetDamaged(LivingEntity user, Entity target, int level) {
-    if(target instanceof LivingEntity) {
+    if(target instanceof LivingEntity livingEntity) {
-        ((LivingEntity) target).addStatusEffect(new StatusEffectInstance(StatusEffects.SLOWNESS, 20 * 2 * level, level - 1));
+        livingEntity.addStatusEffect(new StatusEffectInstance(StatusEffects.SLOWNESS, 20 * 2 * level, level - 1));
     }
@@ Line 50: / Line 84: @@
 </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.
+The final enchantment file should look like this.
+<code java [enable_line_numbers="true"]>
+public class FrostEnchantment extends Enchantment {
+    public FrostEnchantment() {
+        super(Enchantment.Rarity.UNCOMMON, EnchantmentTarget.WEAPON, new EquipmentSlot[] {EquipmentSlot.MAINHAND});
+    }
+    @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>
 ==== Registering Enchantment ====
 Registering enchantments follows the same process as usual:
 <code java [enable_line_numbers="false"]>
-public class EnchantingExample implements ModInitializer {
+public class ExampleMod implements ModInitializer {
+    public static Enchantment FROST = new FrostEnchantment();
-    private static Enchantment FROST = Registry.register(
-            Registry.ENCHANTMENT,
-            new Identifier("tutorial", "frost"),
-            new FrostEnchantment()
-    );
     @Override
     public void onInitialize() {
+        Registry.register(Registries.ENCHANTMENT, new Identifier("tutorial", "frost"), FROST);
     }
 }
 </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:frost''. All non-treasure enchantments are available in an enchanting table, including the ones you register.
-==== Adding Translations & Testing ====
+===== Adding Translations =====
+=) This part works both versions since 1.21 and before 1.21.
 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.frost": "Frost"