Benutzerdefinierte Verzauberungen

Ab der Version 1.21 verwenden benutzerdefinierte Verzauberungen in Minecraft einen "datengesteuerten" Ansatz. Das macht es einfacher, einfache Verzauberungen hinzuzufügen, wie z. B. die Erhöhung des Angriffsschadens, aber schwieriger, komplexe Verzauberungen zu erstellen. Dabei werden die Verzauberungen in Effektkomponenten zerlegt.

Eine Effektkomponente enthält den Code, der die speziellen Effekte einer Verzauberung definiert. Minecraft unterstützt verschiedene Standardeffekte, wie z. B. Schaden, Rückschlag und Erfahrung.

TIP

Überprüfe, ob die Standard-Minecraft-Effekte deinen Bedürfnissen entsprechen, indem du die Seite der Verzauberungseffekt-Komponenten im Minecraft-Wiki besuchst. Dieser Leitfaden setzt voraus, dass du weißt, wie man "einfache" datengesteuerte Verzauberungen konfiguriert und konzentriert sich auf die Erstellung von benutzerdefinierten Verzauberungseffekten, die nicht standardmäßig unterstützt werden.

Benutzerdefinierte Verzauberungseffekte

Starte mit der Erstellung eines Ordners enchantment und erstelle innerhalb dieses Ordners einen Ordner effect. Darin erstellen wir den Record LightningEnchantmentEffect.

Als nächstes können wir einen Konstruktor erstellen und die Methoden des Interfaces EnchantmentEntityEffect überschreiben. Wir werden auch eine CODEC-Variable erstellen, um unseren Effekt zu kodieren und zu dekodieren; Du kannst hier mehr über Codecs lesen.

Der Großteil unseres Codes wird in das Ereignis apply() einfließen, das aufgerufen wird, wenn die Kriterien für die Wirkung der Verzauberung erfüllt sind. Wir werden diesen Effect später so konfigurieren, dass er aufgerufen wird, wenn eine Entität getroffen wird, aber für den Moment wollen wir einfachen Code schreiben, um das Ziel mit einem Blitz zu treffen.

public record LightningEnchantmentEffect(EnchantmentLevelBasedValue amount) implements EnchantmentEntityEffect {
	public static final MapCodec<LightningEnchantmentEffect> CODEC = RecordCodecBuilder.mapCodec(instance ->
			instance.group(
					EnchantmentLevelBasedValue.CODEC.fieldOf("amount").forGetter(LightningEnchantmentEffect::amount)
			).apply(instance, LightningEnchantmentEffect::new)
	);

	@Override
	public void apply(ServerWorld world, int level, EnchantmentEffectContext context, Entity target, Vec3d pos) {
		if (target instanceof LivingEntity victim) {
			if (context.owner() != null && context.owner() instanceof PlayerEntity player) {
				float numStrikes = this.amount.getValue(level);

				for (float i = 0; i < numStrikes; i++) {
					BlockPos position = victim.getBlockPos();
					EntityType.LIGHTNING_BOLT.spawn(world, position, SpawnReason.TRIGGERED);
				}
			}
		}
	}

	@Override
	public MapCodec<? extends EnchantmentEntityEffect> getCodec() {
		return CODEC;
	}
}

Hier gibt die Variable amount einen Wert an, der auf die Stufe der Verzauberung abgestimmt ist. Auf diese Weise können wir die Wirksamkeit der Verzauberung je nach Stufe verändern. Im obigen Code verwenden wir die Stufe der Verzauberung, um zu bestimmen, wie viele Blitze erzeugt werden.

Den Verzauberungseffekt registrieren

Wie jede andere Komponente deines Mods müssen wir auch diesen EnchantmentEffect zur Minecraft-Registry hinzufügen. Füge hierzu eine Klasse ModEnchantmentEffects (oder wie immer du sie nennen willst) und eine Hilfsmethode zur Registrierung der Verzauberung hinzu. Stelle sicher, dass die Methode registerModEnchantmentEffects() in deiner Hauptklasse aufrufen wird, die die Methode onInitialize() enthält.

public class ModEnchantmentEffects {
	public static final RegistryKey<Enchantment> THUNDERING = of("thundering");
	public static MapCodec<LightningEnchantmentEffect> LIGHTNING_EFFECT = register("lightning_effect", LightningEnchantmentEffect.CODEC);

	private static RegistryKey<Enchantment> of(String path) {
		Identifier id = Identifier.of(FabricDocsReference.MOD_ID, path);
		return RegistryKey.of(RegistryKeys.ENCHANTMENT, id);
	}

	private static <T extends EnchantmentEntityEffect> MapCodec<T> register(String id, MapCodec<T> codec) {
		return Registry.register(Registries.ENCHANTMENT_ENTITY_EFFECT_TYPE, Identifier.of(FabricDocsReference.MOD_ID, id), codec);
	}

	public static void registerModEnchantmentEffects() {
		FabricDocsReference.LOGGER.info("Registering EnchantmentEffects for" + FabricDocsReference.MOD_ID);
	}
}

Die Verzauberung erstellen

Jetzt haben wir einen Verzauberungseffekt! Der letzte Schritt besteht darin, eine Verzauberung zu erstellen, die unseren benutzerdefinierten Effekt anwendet. Dies kann zwar durch die Erstellung einer JSON-Datei ähnlich der in Datenpaketen erfolgen, aber diese Anleitung zeigt dir, wie du das JSON dynamisch mit den Datengenerierungswerkzeugen von Fabric erzeugen kannst. Um zu beginnen, erstelle eine Klasse EnchantmentGenerator.

In dieser Klasse werden wir zunächst eine neue Verzauberung registrieren und dann die Methode configure() verwenden, um unser JSON programmatisch zu erstellen.

public class EnchantmentGenerator extends FabricDynamicRegistryProvider {
	public EnchantmentGenerator(FabricDataOutput output, CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture) {
		super(output, registriesFuture);
		System.out.println("REGISTERING ENCHANTS");
	}

	@Override
	protected void configure(RegistryWrapper.WrapperLookup registries, Entries entries) {
		// Our new enchantment, "Thundering."
		register(entries, ModEnchantmentEffects.THUNDERING, Enchantment.builder(
				Enchantment.definition(
					registries.getOrThrow(RegistryKeys.ITEM).getOrThrow(ItemTags.WEAPON_ENCHANTABLE),
					// this is the "weight" or probability of our enchantment showing up in the table
					10,
					// the maximum level of the enchantment
					3,
					// base cost for level 1 of the enchantment, and min levels required for something higher
					Enchantment.leveledCost(1, 10),
					// same fields as above but for max cost
					Enchantment.leveledCost(1, 15),
					// anvil cost
					5,
					// valid slots
					AttributeModifierSlot.HAND
				)
			)
					.addEffect(
						// enchantment occurs POST_ATTACK
						EnchantmentEffectComponentTypes.POST_ATTACK,
						EnchantmentEffectTarget.ATTACKER,
						EnchantmentEffectTarget.VICTIM,
						new LightningEnchantmentEffect(EnchantmentLevelBasedValue.linear(0.4f, 0.2f)) // scale the enchantment linearly.
					)
		);
	}

	private void register(Entries entries, RegistryKey<Enchantment> key, Enchantment.Builder builder, ResourceCondition... resourceConditions) {
		entries.add(key, builder.build(key.getValue()), resourceConditions);
	}

	@Override
	public String getName() {
		return "ReferenceDocEnchantmentGenerator";
	}
}

Bevor du fortfährst, solltest du sicherstellen, dass dein Projekt für die Datengenerierung konfiguriert ist; wenn du dir unsicher bist, sieh dir die entsprechende Dokumentations-Seite an.

Zum Schluss müssen wir unserem Mod sagen, dass er unseren EnchantmentGenerator zur Liste der Datenerzeugungsaufgaben hinzufügen soll. Um dies zu tun, füge einfach den EnchantmentGenerator innerhalb der Methode onInitializeDataGenerator zu dieser hinzu.

Wenn du nun die Datengenerierungsaufgabe deines Mods ausführst, werden die Verzauberungs-JSONs im Ordner generated generiert. Ein Beispiel ist unten zu sehen:

{
  "anvil_cost": 5,
  "description": {
    "translate": "enchantment.fabric-docs-reference.thundering"
  },
  "effects": {
    "minecraft:post_attack": [
      {
        "affected": "victim",
        "effect": {
          "type": "fabric-docs-reference:lightning_effect",
          "amount": {
            "type": "minecraft:linear",
            "base": 0.4,
            "per_level_above_first": 0.2
          }
        },
        "enchanted": "attacker"
      }
    ]
  },
  "max_cost": {
    "base": 1,
    "per_level_above_first": 15
  },
  "max_level": 3,
  "min_cost": {
    "base": 1,
    "per_level_above_first": 10
  },
  "slots": [
    "hand"
  ],
  "supported_items": "#minecraft:enchantable/weapon",
  "weight": 10
}

Du solltest auch Übersetzungen zu deiner en_us.json Datei hinzufügen, um deiner Verzauberung einen lesbaren Namen zu geben:

"enchantment.FabricDocsReference.thundering": "Thundering",

Du solltest jetzt einen funktionierenden, benutzerdefinierten Verzauberungseffekt haben! Teste es, indem du eine Waffe mit der Verzauberung verzauberst und einen Mob triffst. Ein Beispiel wird im folgenden Video gezeigt: