NeoForge GUI 开发完全指南

src/main/java/com/example/mymod/
├── menu/
│   ├── ModMenuTypes.java
│   └── CrystalMachineMenu.java
├── client/screen/
│   └── CrystalMachineScreen.java
└── block/
    └── CrystalMachineBlock.java

package com.example.mymod.menu;

import net.minecraft.core.registries.Registries;
import net.minecraft.world.inventory.MenuType;
import net.neoforged.neoforge.common.extensions.IMenuTypeExtension;
import net.neoforged.neoforge.network.IContainerFactory;
import net.neoforged.neoforge.registries.DeferredHolder;
import net.neoforged.neoforge.registries.DeferredRegister;

public final class ModMenuTypes {
    public static final DeferredRegister<MenuType<?>> MENUS =
        DeferredRegister.create(Registries.MENU, "mymod");

    public static final DeferredHolder<MenuType<?>, MenuType<CrystalMachineMenu>> CRYSTAL_MACHINE =
        MENUS.register("crystal_machine", () -> IMenuTypeExtension.create((IContainerFactory<CrystalMachineMenu>) CrystalMachineMenu::new));
}

package com.example.mymod.menu;

import net.minecraft.core.BlockPos;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.inventory.AbstractContainerMenu;
import net.minecraft.world.inventory.ContainerData;
import net.minecraft.world.inventory.DataSlot;
import net.minecraft.world.inventory.MenuType;
import net.minecraft.world.inventory.SimpleContainerData;
import net.minecraft.world.inventory.Slot;
import net.minecraft.world.item.ItemStack;

public class CrystalMachineMenu extends AbstractContainerMenu {
    private static final int MACHINE_SLOT_COUNT = 9;
    private static final int PLAYER_INV_START = 9;
    private static final int PLAYER_INV_END = 36;
    private static final int HOTBAR_START = 36;
    private static final int HOTBAR_END = 45;

    private final Container machineContainer;
    private final ContainerData data;
    private final BlockPos pos;

    public CrystalMachineMenu(int containerId, Inventory playerInv, RegistryFriendlyByteBuf extraData) {
        this(containerId, playerInv, new SimpleContainer(9), new SimpleContainerData(2), extraData.readBlockPos());
    }

    public CrystalMachineMenu(int containerId, Inventory playerInv, Container machineContainer, ContainerData data, BlockPos pos) {
        super((MenuType<?>) ModMenuTypes.CRYSTAL_MACHINE.get(), containerId);
        this.machineContainer = machineContainer;
        this.data = data;
        this.pos = pos;

        checkContainerSize(machineContainer, 9);
        checkContainerDataCount(data, 2);

        // 机器 3x3
        for (int row = 0; row < 3; row++) {
            for (int col = 0; col < 3; col++) {
                this.addSlot(new Slot(machineContainer, col + row * 3, 62 + col * 18, 17 + row * 18));
            }
        }

        // 玩家背包 3x9
        for (int row = 0; row < 3; row++) {
            for (int col = 0; col < 9; col++) {
                this.addSlot(new Slot(playerInv, col + row * 9 + 9, 8 + col * 18, 84 + row * 18));
            }
        }

        // 快捷栏
        for (int col = 0; col < 9; col++) {
            this.addSlot(new Slot(playerInv, col, 8 + col * 18, 142));
        }

        this.addDataSlots(data);
        this.addDataSlot(DataSlot.standalone()); // 示例：本地临时整型槽
    }

    @Override
    public boolean stillValid(Player player) {
        return this.machineContainer.stillValid(player);
    }

    @Override
    public ItemStack quickMoveStack(Player player, int index) {
        ItemStack result = ItemStack.EMPTY;
        Slot slot = this.slots.get(index);
        if (slot != null && slot.hasItem()) {
            ItemStack source = slot.getItem();
            result = source.copy();

            if (index < MACHINE_SLOT_COUNT) {
                if (!this.moveItemStackTo(source, PLAYER_INV_START, HOTBAR_END, true)) {
                    return ItemStack.EMPTY;
                }
            } else if (!this.moveItemStackTo(source, 0, MACHINE_SLOT_COUNT, false)) {
                return ItemStack.EMPTY;
            }

            if (source.isEmpty()) {
                slot.setByPlayer(ItemStack.EMPTY);
            } else {
                slot.setChanged();
            }
        }
        return result;
    }

    public int getProgress() {
        return this.data.get(0);
    }

    public int getMaxProgress() {
        return this.data.get(1);
    }

    public BlockPos getBlockPos() {
        return this.pos;
    }
}

// 伪代码：在方块 use 中（服务端）
player.openMenu(
    new net.minecraft.world.SimpleMenuProvider(
        (containerId, playerInv, p) -> new CrystalMachineMenu(containerId, playerInv, machineContainer, data, pos),
        net.minecraft.network.chat.Component.translatable("menu.mymod.crystal_machine")
    ),
    buf -> buf.writeBlockPos(pos)
);

package com.example.mymod.client;

import com.example.mymod.client.screen.CrystalMachineScreen;
import com.example.mymod.menu.ModMenuTypes;
import net.neoforged.bus.api.SubscribeEvent;
import net.neoforged.fml.common.EventBusSubscriber;
import net.neoforged.neoforge.client.event.RegisterMenuScreensEvent;

@EventBusSubscriber(modid = "mymod", bus = EventBusSubscriber.Bus.MOD)
public final class ClientScreens {
    @SubscribeEvent
    public static void onRegisterScreens(RegisterMenuScreensEvent event) {
        event.register(ModMenuTypes.CRYSTAL_MACHINE.get(), CrystalMachineScreen::new);
    }
}

package com.example.mymod.client.screen;

import com.example.mymod.menu.CrystalMachineMenu;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.player.Inventory;

public class CrystalMachineScreen extends AbstractContainerScreen<CrystalMachineMenu> {
    private static final ResourceLocation TEX = ResourceLocation.fromNamespaceAndPath("mymod", "textures/gui/crystal_machine.png");

    public CrystalMachineScreen(CrystalMachineMenu menu, Inventory playerInv, Component title) {
        super(menu, playerInv, title);
        this.imageWidth = 176;
        this.imageHeight = 166;
    }

    @Override
    protected void renderBg(GuiGraphics gg, float partialTick, int mouseX, int mouseY) {
        int x = this.leftPos;
        int y = this.topPos;
        gg.blit(TEX, x, y, 0, 0, this.imageWidth, this.imageHeight);

        int progress = this.menu.getProgress();
        int max = Math.max(1, this.menu.getMaxProgress());
        int width = (int) (24.0f * progress / max);
        gg.blit(TEX, x + 79, y + 34, 176, 0, width, 16);
    }

    @Override
    public void render(GuiGraphics gg, int mouseX, int mouseY, float partialTick) {
        super.render(gg, mouseX, mouseY, partialTick);
        this.renderTooltip(gg, mouseX, mouseY);
    }
}

public class CrystalCoreMenu extends AbstractContainerMenu {
    private final ContainerData data; // 0=mode,1=energy,2=maxEnergy

    public CrystalCoreMenu(int id, Inventory inv, ContainerData data) {
        super((MenuType<?>) ModMenuTypes.CRYSTAL_CORE.get(), id);
        this.data = data;
        checkContainerDataCount(data, 3);

        // 仅 1 个“核心槽位”
        this.addSlot(new Slot(inv, 0, 80, 44));

        // 玩家背包可选，这里省略
        this.addDataSlots(data);
    }

    public int getMode() {
        return this.data.get(0);
    }

    public int getEnergy() {
        return this.data.get(1);
    }

    public int getMaxEnergy() {
        return this.data.get(2);
    }

    @Override
    public boolean clickMenuButton(Player player, int id) {
        if (id == 0) {
            int mode = (data.get(0) + 1) % 3;
            data.set(0, mode);
            this.broadcastChanges();
            return true;
        }
        return false;
    }

    @Override
    public ItemStack quickMoveStack(Player player, int index) {
        return ItemStack.EMPTY;
    }

    @Override
    public boolean stillValid(Player player) {
        return true;
    }
}

public class CrystalCoreScreen extends AbstractContainerScreen<CrystalCoreMenu> {
    public CrystalCoreScreen(CrystalCoreMenu menu, Inventory inv, Component title) {
        super(menu, inv, title);
        this.imageWidth = 220;
        this.imageHeight = 180;
    }

    @Override
    protected void init() {
        super.init();
        this.addRenderableWidget(net.minecraft.client.gui.components.Button
            .builder(Component.literal("切换模式"), b -> {
                if (this.minecraft != null && this.minecraft.gameMode != null) {
                    this.minecraft.gameMode.handleInventoryButtonClick(this.menu.containerId, 0);
                }
            })
            .bounds(this.leftPos + 140, this.topPos + 20, 70, 20)
            .build());
    }

    @Override
    protected void renderBg(GuiGraphics gg, float partialTick, int mouseX, int mouseY) {
        int x = this.leftPos;
        int y = this.topPos;

        // 1) 先画底板
        gg.fill(x, y, x + this.imageWidth, y + this.imageHeight, 0xFF1F1F1F);

        // 2) 画能量条（自定义图形）
        int energy = this.menu.getEnergy();
        int max = Math.max(1, this.menu.getMaxEnergy());
        int h = (int) (80.0f * energy / max);
        gg.fill(x + 20, y + 120 - h, x + 32, y + 120, 0xFF00E5FF);

        // 3) 画边框
        gg.fill(x + 19, y + 39, x + 33, y + 121, 0x55FFFFFF);
    }
}

boolean flag = packet.getStateId() != this.player.containerMenu.getStateId();

public class LockedOutputSlot extends Slot {
    private final java.util.function.BooleanSupplier activeSupplier;

    public LockedOutputSlot(Container c, int idx, int x, int y, java.util.function.BooleanSupplier activeSupplier) {
        super(c, idx, x, y);
        this.activeSupplier = activeSupplier;
    }

    @Override
    public boolean mayPlace(ItemStack stack) {
        return false;
    }

    @Override
    public boolean mayPickup(Player player) {
        return player.hasInfiniteMaterials(); // 示例：只有创造可拿
    }

    @Override
    public int getMaxStackSize(ItemStack stack) {
        return 1;
    }

    @Override
    public boolean isActive() {
        return this.activeSupplier.getAsBoolean();
    }
}

public class GhostSlot extends Slot {
    public GhostSlot(Container c, int idx, int x, int y) {
        super(c, idx, x, y);
    }

    @Override
    public boolean mayPlace(ItemStack stack) {
        return false;
    }

    @Override
    public boolean mayPickup(Player player) {
        return false;
    }

    @Override
    public boolean isFake() {
        return true;
    }
}

public final class MachineData implements net.minecraft.world.inventory.ContainerData {
    private final MyMachineBlockEntity be;

    public MachineData(MyMachineBlockEntity be) {
        this.be = be;
    }

    @Override
    public int get(int index) {
        return switch (index) {
            case 0 -> be.getProgress();
            case 1 -> be.getMaxProgress();
            case 2 -> be.getMode();
            case 3 -> (int) (be.getEnergy() & 0xFFFF);
            case 4 -> (int) ((be.getEnergy() >>> 16) & 0xFFFF);
            default -> 0;
        };
    }

    @Override
    public void set(int index, int value) {
        // 一般客户端不应直接 set；如需允许，请显式处理
    }

    @Override
    public int getCount() {
        return 5;
    }
}

// 客户端构造：只能从 extraData 找 BE
public MyMenu(int id, Inventory inv, RegistryFriendlyByteBuf buf) {
    this(id, inv, resolveClientContainer(inv, buf.readBlockPos()), resolveClientData(inv, buf.readBlockPos()));
}

// 服务端构造：直接拿服务端容器与数据
public MyMenu(int id, Inventory inv, Container container, ContainerData data) {
    super((MenuType<?>) ModMenuTypes.MY_MENU.get(), id);
    checkContainerSize(container, 9);
    checkContainerDataCount(data, 5);
    this.addDataSlots(data);
}

@Override
public boolean clickMenuButton(Player player, int id) {
    // 0/1/2 代表模式按钮
    if (id >= 0 && id <= 2) {
        this.data.set(0, id);
        this.broadcastChanges();
        return true;
    }

    // 10 代表“清空日志”操作（示例）
    if (id == 10) {
        // 调服务端真实逻辑
        this.broadcastChanges();
        return true;
    }
    return false;
}

public class ModeButton extends net.minecraft.client.gui.components.Button {
    private final int modeId;
    private final java.util.function.IntSupplier currentMode;

    public ModeButton(int x, int y, int modeId, java.util.function.IntSupplier currentMode, OnPress onPress) {
        super(x, y, 20, 20, net.minecraft.network.chat.Component.literal("M" + modeId), onPress, DEFAULT_NARRATION);
        this.modeId = modeId;
        this.currentMode = currentMode;
    }

    @Override
    protected void renderWidget(net.minecraft.client.gui.GuiGraphics gg, int mouseX, int mouseY, float partialTick) {
        int color = (currentMode.getAsInt() == modeId) ? 0xFF00C853 : 0xFF424242;
        gg.fill(getX(), getY(), getX() + width, getY() + height, color);
        gg.drawCenteredString(net.minecraft.client.Minecraft.getInstance().font, getMessage(), getX() + width / 2, getY() + 6, 0xFFFFFFFF);
    }
}

// Screen 字段
private float smoothEnergy;

@Override
public void containerTick() {
    super.containerTick();
    float target = this.menu.getEnergy();
    this.smoothEnergy += (target - this.smoothEnergy) * 0.25f;
}

MyMachineMenu Data 协议表
index 0: progress       [0..maxProgress]
index 1: maxProgress    [>=1]
index 2: mode           [0..2]
index 3: energyLow16
index 4: energyHigh16

// A1. MenuType 注册
public static final DeferredHolder<MenuType<?>, MenuType<MachineMenu>> MACHINE =
    MENUS.register("machine", () -> IMenuTypeExtension.create((IContainerFactory<MachineMenu>) MachineMenu::new));

// A2. Block use 打开
if (!level.isClientSide) {
    player.openMenu(new SimpleMenuProvider(
        (id, inv, p) -> new MachineMenu(id, inv, beContainer, beData, pos),
        Component.translatable("menu.mymod.machine")
    ), buf -> buf.writeBlockPos(pos));
}

// A3. Client 注册 Screen
@SubscribeEvent
public static void register(RegisterMenuScreensEvent e) {
    e.register(ModMenuTypes.MACHINE.get(), MachineScreen::new);
}

// B1. Menu 内部
@Override
public boolean clickMenuButton(Player player, int id) {
    return switch (id) {
        case 0 -> { this.data.set(0, 0); this.broadcastChanges(); yield true; }
        case 1 -> { this.data.set(0, 1); this.broadcastChanges(); yield true; }
        case 2 -> { this.data.set(0, 2); this.broadcastChanges(); yield true; }
        default -> false;
    };
}

// B2. Screen 按钮
this.addRenderableWidget(Button.builder(Component.literal("模式0"), b -> {
    this.minecraft.gameMode.handleInventoryButtonClick(this.menu.containerId, 0);
}).bounds(this.leftPos + 130, this.topPos + 20, 50, 20).build());

@SubscribeEvent
public static void onContainerForeground(net.neoforged.neoforge.client.event.ContainerScreenEvent.Render.Foreground e) {
    var screen = e.getContainerScreen();
    var gg = e.getGuiGraphics();
    // 示例：在前景右上角画调试文本
    gg.drawString(net.minecraft.client.Minecraft.getInstance().font, "DBG", screen.getGuiLeft() + 150, screen.getGuiTop() + 6, 0xFFFFAA00);
}