Блоки-контейнери

Це гарна практика під час створення блоків, які можуть зберігати предмети, як-от скрині та печі, реалізувати Контейнер. Це дає можливість, наприклад, взаємодіяти з блоком за допомогою лійок.

У цьому посібнику ми створимо блок, який використовує свій контейнер для дублювання будь-яких розміщених у ньому предметів.

Створення блока

Це повинно бути знайоме читачеві, якщо він дотримувався посібників створення вашого першого блока і блока-сутності. Ми створимо DuplicatorBlock, який розширює BaseEntityBlock і реалізує EntityBlock.

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

	// ...
}

Потім нам потрібно створити DuplicatorBlockEntity, який має реалізувати інтерфейс Container. Оскільки зазвичай очікується, що більшість контейнерів працюватимуть однаково, ви можете скопіювати та вставити помічник під назвою ImplementedContainer, який виконує більшу частину роботи, залишаючи нам лише кілька методів для реалізації.

Показати 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 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 < getContainerSize(); i++) {
			ItemStack stack = getItem(i);

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

		return true;
	}

	/**
	 * Retrieves the item in the slot.
	 */
	@Override
	default ItemStack getItem(int slot) {
		return 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(getItems(), slot, count);

		if (!result.isEmpty()) {
			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(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) {
		getItems().set(slot, stack);

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

	/**
	 * Clears the container.
	 */
	@Override
	default void clearContent() {
		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 items;
	}
}

У списку items зберігається вміст контейнера. Для цього блока ми встановили розмір 1 слота для входу.

Не забудьте зареєструвати блок і сутність блока у відповідних класах!

Збереження і завантаження

Якщо ми хочемо, щоб вміст зберігався між перезавантаженнями гри, як стандартний BlockEntity, нам потрібно зберегти його як NBT. На щастя, Mojang надає допоміжний клас під назвою ContainerHelper з усією необхідною логікою.

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

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

Взаємодія з контейнером

Технічно контейнер вже справний. Однак для вставлення предметів нам наразі потрібні лійки. Зробімо так, щоб ми могли вставляти предмети, натиснувши ПКМ по блоку.

Для цього нам потрібно перевизначити метод useItemOn у DuplicatorBlock:

@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;
}

Тут, якщо гравець тримає предмет і є порожній слот, ми переміщуємо предмет з руки гравця в контейнер блока та повертаємо InteractionResult.SUCCESS.

Тепер, коли ви натискаєте ПКМ по блоку предметом, його більше не буде! Якщо ви запустите /data get block для блока, ви побачите предмет у полі Items у NBT.

Дублювання предметів

Зробімо тепер так, щоб блок дублював стіс, який ви в нього кинули, але лише два предмети одночасно. І нехай кожен раз чекає секунду, щоб не спамити гравця предметами!

Для цього ми додамо функцію tick до DuplicatorBlockEntity і поле для збереження того, скільки ми чекали:

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);
}

DuplicatorBlock тепер має мати метод getTicker, який повертає посилання на DuplicatorBlockEntity::tick.

Світові контейнери

Усталено ви можете вставляти та витягувати предмети з контейнера з будь-якого боку. Однак інколи це може бути не бажаною поведінкою: наприклад, піч приймає паливо лише збоку, а предмети — зверху.

Щоб створити таку поведінку, нам потрібно реалізувати інтерфейс WorldlyContainer в BlockEntity. Цей інтерфейс має три методи:

• getSlotsForFace(Direction) дозволяє контролювати, з якими слотами можна взаємодіяти з певного боку.
• canPlaceItemThroughFace(int, ItemStack, Direction) дозволяє контролювати, чи можна вставляти предмет у слот з певного боку.
• canTakeItemThroughFace(int, ItemStack, Direction) дозволяє контролювати, чи можна витягти предмет зі слота з певного боку.

Змінімо DuplicatorBlockEntity, щоб приймати лише елементи згори:

@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;
}

getSlotsForFace повертає масив індексів слотів, з якими можна взаємодіяти з даної сторони. У цьому випадку ми маємо лише один слот (0), тому ми повертаємо масив лише з цим індексом.

Крім того, ми повинні змінити метод useItemOn DuplicatorBlock, щоб фактично дотримуватися нової поведінки:

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

Тепер, якщо ми спробуємо вставити предмети збоку, а не зверху, це не спрацює!

Меню

Щоб отримати доступ до нового блока-контейнера через меню, подібно до скрині, зверніться до посібника меню контейнерів.