Fabric 教程
安装
- 启用 log4j 调试信息(英文)
基础
- 约定和术语
- 注册
- 开发工具
物品
方块和方块实体
数据生成
世界生成
命令
事件
实体
流体
Mixin 和 ASM
杂项
Yarn
贡献 Fabric
- FabLabs - 在提交 PR 之前起草新功能的试验场
阅读本教程之前,请确保已经做好了方块实体。
将物品存储在 BlockEntity(方块实体)中的标准方法是使其成为Inventory
。这使得漏斗(或其他模组)无需任何额外的工作即可从您的 BlockEntity 放入和提取物品。
Inventory
只是一个接口,这意味着实际的 ItemStack
状态将需要存储在您的BlockEntity
上。可以使用DefaultedList <ItemStack>
作为存储这些ItemStacks
的简便方法,且可以将其默认设置为ItemStack.Empty
,用来表示物品堆没有任何物品。实现 Inventory
非常简单,但乏味且容易出错,因此,我们将使用其默认实现,该实现只需要给它一个DefaultList <ItemStack>
(将其复制为新文件):
/** * 一个简单的 {@code Inventory} 实现,仅有默认的方法和物品列表获取器。 * * Originally by Juuz */ public interface ImplementedInventory extends Inventory { /** * 从此物品栏中检索物品。 * 每次被调用时必须返回相同实例。 */ DefaultedList<ItemStack> getItems(); /** * 从物品列表创建物品栏。 */ static ImplementedInventory of(DefaultedList<ItemStack> items) { return () -> items; } /** * 根据指定的尺寸创建新的物品栏。 */ static ImplementedInventory ofSize(int size) { return of(DefaultedList.ofSize(size, ItemStack.EMPTY)); } /** * 返回物品栏的大小。 */ @Override default int size() { return getItems().size(); } /** * 检查物品栏是否为空。 * @return true,如果物品栏仅有一个空堆,否则为true。 */ @Override default boolean isEmpty() { for (int i = 0; i < size(); i++) { ItemStack stack = getStack(i); if (!stack.isEmpty()) { return false; } } return true; } /** * 检索槽位中的物品。 */ @Override default ItemStack getStack(int slot) { return getItems().get(slot); } /** * 从物品栏槽位移除物品。 * @param slot 从该槽位移除。 * @param count 需要移除的物品个数。如果槽位中的物品少于需要的,则将其全部取出。 */ @Override default ItemStack removeStack(int slot, int count) { ItemStack result = Inventories.splitStack(getItems(), slot, count); if (!result.isEmpty()) { markDirty(); } return result; } /** * 从物品栏槽位移除所有物品。 * @param slot 从该槽位移除。 */ @Override default ItemStack removeStack(int slot) { return Inventories.removeStack(getItems(), slot); } /** * 将物品栏槽位中的当前物品堆替换为提供的物品堆。 * @param slot 替换该槽位的物品堆。 * @param stack 替换后新的物品堆。如果堆对于此物品栏过大({@link Inventory#getMaxCountPerStack()}),则压缩为物品栏的最大数量。 */ @Override default void setStack(int slot, ItemStack stack) { getItems().set(slot, stack); if (stack.getCount() > getMaxCountPerStack()) { stack.setCount(getMaxCountPerStack()); } } /** * 清除物品栏。 */ @Override default void clear() { getItems().clear(); } /** * 将方块状态标记为脏。 * 更改物品栏之后必须调用,所以游戏正确地储存物品栏内容并提取邻近方块物品栏改变。 */ @Override default void markDirty() { // 需要行为时,覆盖此方法。 } /** * @return true 如果玩家可以使用物品栏,否则为 false。i */ @Override default boolean canPlayerUse(PlayerEntity player) { return true; } }
现在在您的 BlockEntity
中实现ImplementedInventory
,并为其提供存储该物品的 DefaultedList <ItemStack> items
实例。对于此例,我们将在物品栏中最多存储2件物品:
public class DemoBlockEntity extends BlockEntity implements ImplementedInventory { private final DefaultedList<ItemStack> items = DefaultedList.ofSize(2, ItemStack.EMPTY); @Override public DefaultedList<ItemStack> getItems() { return items; } [...] }
我们还需要将物品栏保存到标签并从那里加载。Inventories
具有帮助方法,可以使得这个非常轻松:
public class DemoBlockEntity extends BlockEntity implements ImplementedInventory { [...] @Override public void readNbt(NbtCompound nbt) { super.readNbt(nbt); Inventories.readNbt(nbt, items); } @Override public NbtCompound writeNbt(NbtCompound nbt) { Inventories.writeNbt(nbt, items); return super.writeNbt(nbt); } }
我们覆盖方块类中的 `onUse` 行为以从我们的物品栏中加入和提取物品。注意这也可以对任何 Inventory
实例完成,不仅是我们自己的(例如,也因此可以对箱子方块做同样的事)。首先我们处理第一个槽位,如果是空的。玩家如果拿着物品,则会将拿着的物品放入。物品进入第一个槽位,如果是空的,或者进入第二个槽位,如果第一个是空的,或者如果第二个是空的,我们则会输出与物品栏有关的信息。注意我们将 ItemStack
插入物品栏时调用 copy()
,这样不会随着玩家的 ItemStack
而被破坏。
public class ExampleBlock extends Block implements BlockEntityProvider { [...] @Override public boolean activate(BlockState blockState, World world, BlockPos blockPos, PlayerEntity player, Hand hand, BlockHitResult blockHitResult) { if (world.isClient) return true; Inventory blockEntity = (Inventory) world.getBlockEntity(blockPos); if (!player.getStackInHand(hand).isEmpty()) { // 检查第一个打开的槽位是什么,并从玩家手中放入物品 if (blockEntity.getInvStack(0).isEmpty()) { // 将玩家手中的物品堆放入物品栏中 blockEntity.setInvStack(0, player.getStackInHand(hand).copy()); // 从玩家手中移除物品堆 player.getStackInHand(hand).setCount(0); } else if (blockEntity.getInvStack(1).isEmpty()) { blockEntity.setInvStack(1, player.getStackInHand(hand).copy()); player.getStackInHand(hand).setCount(0); } else { // 如果物品栏是满的,我们输出其内容 System.out.println("The first slot holds " + blockEntity.getInvStack(0) + " and the second slot holds " + blockEntity.getInvStack(1)); } } return true; } }
当玩家不持有物品时,我们将采取相反的行为。我们将从第二个槽位中取出项目,然后第二个中的第一个为空。如果第一个也是空的,我们将不做任何事情。
public class ExampleBlock extends Block implements BlockEntityProvider { [...] @Override public boolean activate(BlockState blockState, World world, BlockPos blockPos, PlayerEntity player, Hand hand, BlockHitResult blockHitResult) { ... if (!player.getStackInHand(hand).isEmpty()) { ... } else { // 如果玩家没有持有任何东西,我们依次将方块实体中的物品给予玩家 // 查找第一个有物品的槽位,并给予玩家 if (!blockEntity.getInvStack(1).isEmpty()) { // 给予玩家物品栏中的物品堆 player.inventory.offerOrDrop(world, blockEntity.getInvStack(1)); // Remove the stack from the inventory blockEntity.removeInvStack(1); } else if (!blockEntity.getInvStack(0).isEmpty()) { player.inventory.offerOrDrop(world, blockEntity.getInvStack(0)); blockEntity.removeInvStack(0); } } return true; } }
如果你希望有基于与方块不同的面(漏斗或者其他模组)进行交互的不同逻辑,你可以实现 SidedInventory 接口。如果说你想使得方块不能从上侧插入,可以这样做:
public class DemoBlockEntity extends BlockEntity implements ImplementedInventory, SidedInventory { [...] @Override public int[] getInvAvailableSlots(Direction var1) { // Just return an array of all slots int[] result = new int[getItems().size()]; for (int i = 0; i < result.length; i++) { result[i] = i; } return result; } @Override public boolean canInsert(int slot, ItemStack stack, Direction direction) { return direction != Direction.UP; } @Override public boolean canExtract(int slot, ItemStack stack, Direction direction) { return true; } }