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 [2023/01/04 13:52] – [Registering Enchantment] In Sample Code: pass FROST variable to the 3rd param of Registry#register(). datsunstutorial: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 41: Line 76:
 @Override @Override
 public void onTargetDamaged(LivingEntity user, Entity target, int level) { 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 80: 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"]>
-public class EnchantingExample implements ModInitializer {+public class ExampleMod implements ModInitializer {
     public static Enchantment FROST = new FrostEnchantment();     public static Enchantment FROST = new FrostEnchantment();
  
Line 89: Line 124:
 } }
 </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:frost''. All non-treasure enchantments are available in an enchanting table, including the ones you register. 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: 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"     "enchantment.tutorial.frost": "Frost"
tutorial/enchantments.1672840378.txt.gz · Last modified: 2023/01/04 13:52 by datsuns