Grundlegende Verwendung von Gegenständen

Warnung

These docs were written for SpongeAPI 7 and are likely out of date. If you feel like you can help update them, please submit a PR!

Gegenstände werden durch ein ItemStack repräsentiert. Ein ItemStack ist ein Gegenstand aus dem Inventar mit Informationen über die Anzahl der Gegenstände in dieser Ansammlung, den Art des Gegenstandes und weiteren Daten wie der Haltbarkeit. Ein Item ist die grafische Repräsentation eines ItemStacks als Entität in der Welt. Bitte beachte, dass du immer nur eine Kopie und nicht den richtigen ItemStack bekommst und ihn deshalb zurück ins Inventar geben musst, wenn gewünscht.

Überprüfung des Typs eines Gegenstandes

Checking the type of the item is very simple. You just need to call the ItemStack#getType() method.

import org.spongepowered.api.item.ItemType;
import org.spongepowered.api.item.ItemTypes;
import org.spongepowered.api.item.inventory.ItemStack;

public boolean isStick(ItemStack stack) {
    ItemType type = stack.getType();
    return type.equals(ItemTypes.STICK);
}

Siehst du wie einfach das ist? Weil sich Stöcke stapeln lassen, können wir auch herausfinden, wie viele gerade da sind.

Getting the number of items in an ItemStack is relatively easy. The ItemStack#getQuantity() method will handle this for us.

Bearbeiten von Gegenstands-Daten

Das Verändern von Daten wie der Haltbarkeit oder dem Beschreibungstext eines Gegenstandes kann erreicht werden, indem Keys verwendet werden. Du musst nur angeben, welcher Schlüssel geändert werden muss:

import org.spongepowered.api.data.key.Keys;

public void setUnbreakable(ItemStack stack) {
    stack.offer(Keys.UNBREAKABLE, true);
}

In diesem Beispiel haben wir angegeben, dass der Keys#UNBREAKABLE Schlüssel, der Schlüssel ist, den wir ändern möchten. Wir setzen dann den Wert auf true, was ausdrückt, dass der Gegenstand niemals zerbrechen wird. Diese Änderungen werden in der offer() Methode des ItemStack zurück in den ItemStack geschrieben.

Different keys will require different values based on their job. For example, to change the lore of an item, one would need to specify a List of Component rather than a boolean or other value. It is also important to perform checks to see if the key can actually apply to the item. For example, some items might not have durability or may already have lore applied to the item.

import net.kyori.adventure.text.Component;

import java.util.List;

public void setLore(ItemStack stack, List<Component> itemLore) {
    if (stack.get(Keys.ITEM_LORE).isPresent()) {
        stack.offer(Keys.ITEM_LORE, itemLore);
    }
}

Bemerkung

Almost all API methods that return an ItemStack only return a copy of it, so modifying it does not have any impact on the real stack (e.g. in an inventory). You have to explicitly set it for your changes to persist.

Eigenschaften von Gegenständen

Verschiedene Gegenstände können spezielle Eigenschaften haben. Zum Beispiel können bestimmte Gegenstände dazu verwendet werden, bestimmte Blöcke abzubauen, wie es bei der Diamant-Spitzhacke und Obsidian der Fall ist. Diese Eigenschaften können dazu verwendet werden herauszufinden, wo ein Gegenstand für eine Aktion verwendet werden kann ohne tatsächlichen Typ des Gegenstandes zu überprüfen. Wir können prüfen, ob ein Werkzeug einen Block Obsidian abbauen kann, wenn wir die HarvestingProperty des Gegenstandes überprüfen.

import org.spongepowered.api.block.BlockTypes;
import org.spongepowered.api.data.property.item.HarvestingProperty;

import java.util.Optional;

public boolean canMineObsidian(ItemStack stack) {
    Optional<HarvestingProperty> optional =
        stack.getProperty(HarvestingProperty.class);

    if (optional.isPresent()) {
        HarvestingProperty property = optional.get();
        return property.getValue().contains(BlockTypes.OBSIDIAN);
    }
    return false;
}

Dieser Code überprüft, ob der Gegenstand eine HarvestingProperty hat, wie beispielsweise die Spitzhacke. Wenn diese vorhanden ist, kann man damit überprüft werden, ob dieser Gegenstand dazu verwendet werden kann, Obsidian zu ernten, ohne dafür den Typ des Gegenstandes zu überprüfen. Dies ist praktisch für den Fall, dass ein Mod oder ein Minecraft Update ein neues Werkzeug hinzufügt, welches die Fähigkeit besitzt Obsidian abzubauen.

Vergleichen von Gegenständen

Die ItemStack Klasse hat eine praktische Methode zum Vergleichen von zwei ItemStacks. Durch die Verwendung der ItemStack#equalTo(ItemStack) Methode auf einem bereits existierendem ItemStack können wir überprüfen, ob beide ItemStacks ‚gleich‘ sind. Dies ist dann der Fall, wenn die Anzahl, der ItemType und die Daten identisch sind. Das folgende Beispiel zeigt dies:

public boolean isEqual(ItemStack stack1, ItemStack stack2) {
    return stack1.equalTo(stack2);
}