Entitätsattribute 26.1.2

Erfahre, wie du Entitäten benutzerdefinierte Attribute hinzufügen kannst.

Attribute bestimmen die Eigenschaften, die deine modifizierte Entität besitzen kann. Mit Fabric kannst du eigene benutzerdefinierte Attribute erstellen, die die Spielmechanik verbessern, und auch die Vanillaattribute anwenden.

Ein Benutzerdefiniertes Attribut erstellen

Lasst uns ein benutzerdefiniertes Attribut mit dem Namen AGGRO_RANGE erstellen. Dieses Attribut wird die Entfernung steuern, aus der eine Entität potenzielle Bedrohungen erkennen und darauf reagieren kann.

Die Attributklasse definieren

Beginne damit, eine Java-Klasse zu erstellen, um die Definition und Registrierung deines Attributs unter der Codestruktur deines Mods zu verwalten. Dieses Beispiel erstellt die folgenden Funktionen in einer Klasse namens ModAttributes.

Beginne zunächst mit einer einfachen Hilfsmethode, um die Attribute deines Mods zu registrieren. Diese Methode akzeptiert die folgenden Parameter und registriert ein Attribut.

• Ein String, der den Namen deines Attributs darstellt
• Ein double, der den Standardwert deines Attributs darstellt
• Ein double, welcher der niedrigste Wert sein wird, den dein Attribut erreichen wird
• Ein double, welcher der höchste Wert sein wird, den dein Attribut erreichen wird
• Ein boolean, der angibt, ob das Attribut mit Clients synchronisiert wird

private static Holder<Attribute> register(
		String name, double defaultValue, double minValue, double maxValue, boolean syncedWithClient
) {
	Identifier identifier = Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, name);
	Attribute entityAttribute = new RangedAttribute(
			identifier.toLanguageKey(),
			defaultValue,
			minValue,
			maxValue
	).setSyncable(syncedWithClient);

	return Registry.registerForHolder(BuiltInRegistries.ATTRIBUTE, identifier, entityAttribute);
}

Anschließend registrieren wir ein Attribut namens AGGRO_RANGE mit dem Namen aggro_range, einem Standardwert von 8.0, einem minimalen Wert von 0 und einem maximalen Wert, der so hoch wie möglich eingestellt ist. Dieses Attribut wird nicht mit den Spielern synchronisiert.

public static final Holder<Attribute> AGGRO_RANGE = register(
		"aggro_range",
		8.0,
		0.0,
		Double.MAX_VALUE,
		false
);

Benutzerdefinierte Attribute übersetzen

Um den Attributnamen in einem für Menschen lesbaren Format anzuzeigen, musst du die Datei assets/example-mod/lang/en_us.json wie folgt ändern:

{
  "attribute.name.example-mod.aggro_range": "Aggro Range"
}

Initialisierung

Um sicherzustellen, dass das Attribut ordnungsgemäß registriert wird, musst du sicherstellen, dass es beim Start des Mods initialisiert wird. Dies kann erreicht werden, indem du zu deiner Klasse eine öffentliche statische Initialisierungsmethode hinzufügst und diese aus deiner Mod-Initialisierungsklasse aufrufst. Derzeit benötigt diese Methode keine Inhalte.

public static void initialize() {
}

public class ExampleModAttributes implements ModInitializer {
	@Override
	public void onInitialize() {
		ModAttributes.initialize();
	}
}

Der Aufruf einer Methode einer Klasse initialisiert diese statisch, wenn sie nicht vorher geladen wurde - das bedeutet, dass alle static Felder ausgewertet werden. Dafür ist diese Dummy-Methode initialize gedacht.

Attribute anwenden

Attribute müssen an eine Entität angehängt werden, um wirksam zu werden. Dies geschieht in der Regel in der Methode, in der die Attribute einer Entität erstellt oder geändert werden.

Vanilla bietet ebenfalls Attribute, darunter maximale Gesundheit, Bewegungsgeschwindigkeit und Angriffsschaden. Für eine vollständige Liste, siehe die Vanilla-Klasse Attributes und im Minecraft Wiki.

Dies ist ein Beispiel dafür, wie man Vanilla-Attribute und das zuvor erstellte Attribut AGGRO_RANGE zur Mini-Golem-Entität aus dem Leitfaden Erstellen deiner ersten Entität hinzufügt.

public static AttributeSupplier.Builder createCubeAttributes() {
	return PathfinderMob.createMobAttributes()
			.add(ModAttributes.AGGRO_RANGE, 8.0)
			.add(Attributes.MAX_HEALTH, 5)
			.add(Attributes.TEMPT_RANGE, 10)
			.add(Attributes.MOVEMENT_SPEED, 0.3);
}

Lesen und modifizieren von Attributen

Ein Attribut an sich ist lediglich eine an eine Entität angehängte Information. Damit es nützlich ist, müssen wir in der Lage sein, daraus zu lesen und darin zu schreiben. Dazu gibt es zwei Möglichkeiten: Entweder du rufst die AttributeInstance der Entität ab oder du rufst den Wert direkt ab.

AttributeInstance attribute = entity.getAttribute(ModAttributes.AGGRO_RANGE); // returns an `AttributeInstance`
double value = attribute.getValue(); // returns a double with the current value
double baseValue = attribute.getBaseValue(); // returns a double with the base value

Eine AttributeInstance ermöglicht mehr Flexibilität, beispielsweise das Festlegen eines AttributeModifier für das Attribut unter Verwendung einer der drei Standardoperationen für Attributmodifikatoren. Modifikatoren können permanent (in NBT gespeichert) oder transitiv (nicht in NBT gespeichert) sein und werden mit addPermanentModifier bzw. addTransitiveModifier hinzugefügt.

attribute.addPermanentModifier(
		new AttributeModifier(
				Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "increased_range"), // the ID of your modifier, should be static so it can be removed
				8, // how much to modify it
				AttributeModifier.Operation.ADD_VALUE // what operator to use, see the wiki page linked above
		)
);

Sobald du Zugriff auf den Attributwert hast, kannst du ihn in der KI deiner Entität verwenden.