Blockcontainer 26.1.2

Lerne, wie du Container zu deinen Blockentitäten hinzufügst.

Es empfiehlt sich, bei der Erstellung von Blöcken, die Items speichern können, wie Truhen und Öfen, Container zu implementieren. Dadurch ist es beispielsweise möglich, mit dem Block mithilfe von Trichtern zu interagieren.

In diesem Tutorial erstellen wir einen Block, der seinen Container verwendet, um alle darin platzierten Items zu duplizieren.

Erstellen des Blocks

Dies sollte dem Leser bekannt sein, wenn er die Leitfäden Erstellen deines ersten Blocks und Block-Entitäten befolgt hat. Wir werden einen DuplicatorBlock erstellen, der von BaseEntityBlock erbt und EntityBlock implementiert.

public class DuplicatorBlock extends BaseEntityBlock {
	@Nullable
	@Override
	public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
		return new DuplicatorBlockEntity(pos, state);
	}

	// ...
}

Dann müssen wir eine DuplicatorBlockEntity erstellen, welche das Interface Container implementieren muss. Da die meisten Container in der Regel auf die gleiche Weise funktionieren, kannst du einen Helfer namens ImplementedContainer kopieren und einfügen, der den Großteil der Arbeit übernimmt, sodass wir nur noch wenige Methoden implementieren müssen.

Zeige ImplementedContainer

package com.example.docs.container;

import net.minecraft.core.NonNullList;
import net.minecraft.world.Container;
import net.minecraft.world.ContainerHelper;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;

/**
 * A simple {@link Container} implementation with only default methods + an item list getter.
 *
 * @author Juuz
 */
public interface ImplementedContainer extends Container {
	/**
	 * Retrieves the item list of this container.
	 * Must return the same instance every time it's called.
	 */
	NonNullList<ItemStack> getItems();

	/**
	 * Creates a container from the item list.
	 */
	static ImplementedContainer of(NonNullList<ItemStack> items) {
		return () -> items;
	}

	/**
	 * Creates a new container with the specified size.
	 */
	static ImplementedContainer ofSize(int size) {
		return of(NonNullList.withSize(size, ItemStack.EMPTY));
	}

	/**
	 * Returns the container size.
	 */
	@Override
	default int getContainerSize() {
		return this.getItems().size();
	}

	/**
	 * Checks if the container is empty.
	 * @return true if this container has only empty stacks, false otherwise.
	 */
	@Override
	default boolean isEmpty() {
		for (int i = 0; i < this.getContainerSize(); i++) {
			ItemStack stack = this.getItem(i);

			if (!stack.isEmpty()) {
				return false;
			}
		}

		return true;
	}

	/**
	 * Retrieves the item in the slot.
	 */
	@Override
	default ItemStack getItem(int slot) {
		return this.getItems().get(slot);
	}

	/**
	 * Removes items from a container slot.
	 * @param slot  The slot to remove from.
	 * @param count How many items to remove. If there are fewer items in the slot than what are requested,
	 *              takes all items in that slot.
	 */
	@Override
	default ItemStack removeItem(int slot, int count) {
		ItemStack result = ContainerHelper.removeItem(this.getItems(), slot, count);

		if (!result.isEmpty()) {
			this.setChanged();
		}

		return result;
	}

	/**
	 * Removes all items from a container slot.
	 * @param slot The slot to remove from.
	 */
	@Override
	default ItemStack removeItemNoUpdate(int slot) {
		return ContainerHelper.takeItem(this.getItems(), slot);
	}

	/**
	 * Replaces the current stack in an container slot with the provided stack.
	 * @param slot  The container slot of which to replace the item stack.
	 * @param stack The replacing item stack. If the stack is too big for
	 *              this container ({@link Container#getMaxStackSize()}),
	 *              it gets resized to this container's maximum amount.
	 */
	@Override
	default void setItem(int slot, ItemStack stack) {
		this.getItems().set(slot, stack);

		if (stack.getCount() > stack.getMaxStackSize()) {
			stack.setCount(stack.getMaxStackSize());
		}
	}

	/**
	 * Clears the container.
	 */
	@Override
	default void clearContent() {
		this.getItems().clear();
	}

	/**
	 * Marks that the state has changed.
	 * Must be called after changes in the container, so that the game can properly save
	 * the container contents and notify neighboring blocks of container changes.
	 */
	@Override
	default void setChanged() {
		// Override if you want behavior.
	}

	/**
	 * @return true if the player can use the container, false otherwise.
	 */
	@Override
	default boolean stillValid(Player player) {
		return true;
	}
}

public class DuplicatorBlockEntity extends BlockEntity implements ImplementedContainer {
	private final NonNullList<ItemStack> items = NonNullList.withSize(1, ItemStack.EMPTY);

	public DuplicatorBlockEntity(BlockPos pos, BlockState state) {
		super(ModBlockEntities.DUPLICATOR_BLOCK_ENTITY, pos, state);
	}

	@Override
	public NonNullList<ItemStack> getItems() {
		return this.items;
	}
}

In der Liste items wird der Inhalt des Containers gespeichert. Für diesen Block haben wir eine Größe von 1 Slot für die Eingabe festgelegt.

Vergiss nicht den Block und die Blockentität in deren jeweiligen Klasse zu registrieren!

Speichern & Laden

Wenn wir möchten, dass die Inhalte zwischen den Spielneustarts wie bei einer Vanilla BlockEntity erhalten bleiben, müssen wir sie als NBT speichern. Dankenswerterweise stellt Mojang eine Hilfsklasse namens ContainerHelper mit der gesamten erforderlichen Logik zur Verfügung.

@Override
protected void loadAdditional(ValueInput input) {
	super.loadAdditional(input);
	ContainerHelper.loadAllItems(input, this.items);
}

@Override
protected void saveAdditional(ValueOutput output) {
	ContainerHelper.saveAllItems(output, this.items);
	super.saveAdditional(output);
}

Mit dem Container interagieren

Technisch gesehen, funktioniert der Container bereits. Um jedoch Items einzufügen, müssen wir derzeit Trichter verwenden. Lasst uns es so einrichten, dass wir Items durch einen Rechtsklick auf den Block einfügen können.

Um dies zu tun, müssen wir die Methode useItemOn in DuplicatorBlock überschreiben:

@Override
protected InteractionResult useItemOn(ItemStack stack, BlockState state, Level world, BlockPos pos, Player player, InteractionHand hand, BlockHitResult hit) {
	if (!(world.getBlockEntity(pos) instanceof DuplicatorBlockEntity duplicatorBlockEntity)) {
		return InteractionResult.PASS;
	}

	if (!player.getItemInHand(hand).isEmpty() && duplicatorBlockEntity.isEmpty()) {
		duplicatorBlockEntity.setItem(0, player.getItemInHand(hand).copy());
		player.getItemInHand(hand).setCount(0);
	}

	return InteractionResult.SUCCESS;
}

Wenn der Spieler ein Item hält und ein Platz frei ist, verschieben wir das Item aus der Hand des Spielers in den Container des Blocks und geben InteractionResult.SUCCESS zurück.

Wenn du jetzt mit der rechten Maustaste auf den Block mit einem Item klickst, wirst du es nicht mehr haben! Wenn du /data get block auf dem Block ausführst, wirst du das Item in dem Feld items des NBT sehen.

Items duplizieren

Lasst uns jetzt dafür sorgen, dass der Block den Stack, den du hineingeworfen hast, dupliziert, jedoch nur jeweils zwei Items auf einmal. Und lassen wir es jedes Mal eine Sekunde warten, um den Spieler nicht mit Items zuzuspammen!

Dazu fügen wir eine Funktion tick zur DuplicatorBlockEntity hinzu und ein Feld, um zu speichern, wie lange wir gewartet haben:

private int timeSinceDropped = 0;

public static void tick(Level world, BlockPos blockPos, BlockState blockState, DuplicatorBlockEntity duplicatorBlockEntity) {
	if (duplicatorBlockEntity.isEmpty()) return;
	duplicatorBlockEntity.timeSinceDropped++;

	if (duplicatorBlockEntity.timeSinceDropped < 10) return;
	duplicatorBlockEntity.timeSinceDropped = 0;

	ItemStack duplicate = duplicatorBlockEntity.getItem(0).split(1);

	Block.popResourceFromFace(world, blockPos, Direction.UP, duplicate);
	Block.popResourceFromFace(world, blockPos, Direction.UP, duplicate);
}

Der DuplicatorBlock sollte nun über eine Methode getTicker verfügen, die eine Referenz auf DuplicatorBlockEntity::tick zurückgibt.

Weltbasierte Container

Standardmäßig kannst du Items von jeder Seite aus in den Container einfügen und aus ihm entnehmen. Dies ist jedoch unter Umständen nicht immer erwünscht: Beispielsweise nimmt ein Ofen Brennstoff nur von der Seite und Items nur von oben auf.

Um dieses Verhalten zu erzeugen, müssen wir das Interface WorldlyContainer in BlockEntity implementieren. Das Interface hat drei Methoden:

• getSlotsForFace(Direction) lässt dir steuern, mit welchen Slots von einer bestimmten Seite aus interagiert werden kann.
• canPlaceItemThroughFace(int, ItemStack, Direction) lässt dir steuern, ob ein Item von einer gegebenen Seite in einen Slot eingefügt werden kann.
• canTakeItemThroughFace(int, ItemStack, Direction) lässt dir steuern, ob ein Item von einer gegebenen Seite entnommen werden kann.

Lasst uns die DuplicatorBlockEntity bearbeiten, um nur Items von der Oberseite zu akzeptieren:

@Override
public int[] getSlotsForFace(Direction side) {
	return new int[]{ 0 };
}

@Override
public boolean canPlaceItemThroughFace(int slot, ItemStack stack, @Nullable Direction dir) {
	return dir == Direction.UP;
}

@Override
public boolean canTakeItemThroughFace(int slot, ItemStack stack, Direction dir) {
	return true;
}

Die Methode getSlotsForFace gibt ein Array der Slot Indizes zurück, mit denen von der angegebenen Seite aus interagiert werden kann. In diesem Fall haben wir nur einen einzigen Slot (0), daher geben wir ein Array mit genau diesem Index zurück.

Außerdem sollten wir die Methode useItemOn von DuplicatorBlock ändern, um das neue Verhalten tatsächlich zu berücksichtigen:

if (!duplicatorBlockEntity.canPlaceItemThroughFace(0, stack, hit.getDirection())) {
	return InteractionResult.PASS;
}

Wenn wir nun versuchen, Items von der Seite statt von oben einzufügen, funktioniert das nicht!

Menüs

Um über ein Menü auf den neuen Containerblock zuzugreifen, so wie du es bei einer Truhe tust, lies bitte den Leitfaden Containermenüs.