Skip to content

[ref:vaan/task/vacuum-hopper-enhancement] Vacuum hopper enhancement #493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Intybyte wants to merge 15 commits into
base: master
Choose a base branch
from
Open

[ref:vaan/task/vacuum-hopper-enhancement] Vacuum hopper enhancement #493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0ab2dc0
Convert to VirtualInventory
Intybyte Dec 18, 2025
8062f4d
Use PylonNoVanillaContainerBlock
Intybyte Dec 18, 2025
05538ae
Allow blacklist and whitelist
Intybyte Dec 18, 2025
99ed7d2
Simulate hopper
Intybyte Dec 18, 2025
b2b03bd
Allow blacklist whitelist toggling
Intybyte Dec 18, 2025
8609c92
Translatable components
Intybyte Dec 18, 2025
1cd1d37
Simulate hopper
Intybyte Dec 18, 2025
dfd1207
Rename interface method
Intybyte Dec 21, 2025
0bc8111
Merge branch 'master' into vaan/task/vacuum-hopper-enhancement
Intybyte Jan 2, 2026
ea92290
Extend PylonGuiBlock
Intybyte Jan 2, 2026
bbef34b
Use PylonGuiBlock properly
Intybyte Jan 4, 2026
99cf2a1
Replace reasons with MachineUpdateReason
Intybyte Jan 4, 2026
9958b1f
Remove unnecessary stuff... hoppering doesn't work now tho
Intybyte Jan 4, 2026
29ba2ea
WHYYYYYYYYYYYYYY
Intybyte Jan 4, 2026
c66564c
marinate hopper boi
Intybyte Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 212 additions & 20 deletions src/main/java/io/github/pylonmc/pylon/base/content/machines/simple/VacuumHopper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,56 @@

import com.destroystokyo.paper.ParticleBuilder;
import io.github.pylonmc.pylon.core.block.PylonBlock;
import io.github.pylonmc.pylon.core.block.base.PylonBreakHandler;
import io.github.pylonmc.pylon.core.block.base.PylonTickingBlock;
import io.github.pylonmc.pylon.core.block.base.*;
import io.github.pylonmc.pylon.core.block.context.BlockBreakContext;
import io.github.pylonmc.pylon.core.block.context.BlockCreateContext;
import io.github.pylonmc.pylon.core.config.adapter.ConfigAdapter;
import io.github.pylonmc.pylon.core.datatypes.PylonSerializers;
import io.github.pylonmc.pylon.core.i18n.PylonArgument;
import io.github.pylonmc.pylon.core.item.PylonItem;
import io.github.pylonmc.pylon.core.util.MachineUpdateReason;
import io.github.pylonmc.pylon.core.util.gui.GuiItems;
import io.github.pylonmc.pylon.core.util.gui.unit.UnitFormat;
import io.papermc.paper.datacomponent.DataComponentTypes;
import lombok.Getter;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.TranslatableComponent;
import org.bukkit.Material;
import org.bukkit.NamespacedKey;
import org.bukkit.Particle;
import org.bukkit.block.Block;
import org.bukkit.block.Hopper;
import org.bukkit.block.BlockFace;
import org.bukkit.block.BlockState;
import org.bukkit.block.data.type.Hopper;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.event.inventory.ClickType;
import org.bukkit.event.inventory.InventoryClickEvent;
import org.bukkit.event.inventory.InventoryMoveItemEvent;
import org.bukkit.event.inventory.InventoryPickupItemEvent;
import org.bukkit.inventory.BlockInventoryHolder;
import org.bukkit.inventory.ItemStack;
import org.bukkit.persistence.PersistentDataContainer;
import org.jetbrains.annotations.NotNull;
import xyz.xenondevs.inventoryaccess.component.AdventureComponentWrapper;
import xyz.xenondevs.invui.gui.Gui;
import xyz.xenondevs.invui.inventory.Inventory;
import xyz.xenondevs.invui.inventory.ReferencingInventory;
import xyz.xenondevs.invui.inventory.VirtualInventory;
import xyz.xenondevs.invui.inventory.event.ItemPreUpdateEvent;
import xyz.xenondevs.invui.inventory.event.UpdateReason;
import xyz.xenondevs.invui.item.ItemProvider;
import xyz.xenondevs.invui.item.impl.SimpleItem;
import xyz.xenondevs.invui.item.impl.controlitem.ControlItem;
import xyz.xenondevs.invui.window.Window;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class VacuumHopper extends PylonBlock implements PylonTickingBlock, PylonBreakHandler {
import static io.github.pylonmc.pylon.base.util.BaseUtils.baseKey;

public class VacuumHopper extends PylonBlock implements PylonTickingBlock, PylonGuiBlock, PylonBreakHandler {
public static class Item extends PylonItem {
public final int radius = getSettings().getOrThrow("radius-blocks", ConfigAdapter.INT);
public final int tickInterval = getSettings().getOrThrow("tick-interval", ConfigAdapter.INT);
Expand All @@ -40,63 +69,226 @@ public Item(@NotNull ItemStack stack) {
}
}

public static final NamespacedKey WHITELIST_KEY = baseKey("whitelist");
// if whitelist is true behaves like a whitelist, otherwise like a blacklist
public boolean whitelist;

@Getter
private final @NotNull Inventory hopperInventory;

@Getter
private final @NotNull Inventory itemsToCheck;

public final int radius = getSettings().getOrThrow("radius-blocks", ConfigAdapter.INT);
public final int tickInterval = getSettings().getOrThrow("tick-interval", ConfigAdapter.INT);

@SuppressWarnings("unused")
public VacuumHopper(@NotNull Block block, @NotNull BlockCreateContext context) {
super(block, context);

this.whitelist = false;
setTickInterval(tickInterval);
}

@SuppressWarnings("unused")
public VacuumHopper(@NotNull Block block, @NotNull PersistentDataContainer pdc) {
super(block, pdc);
this.whitelist = pdc.get(WHITELIST_KEY, PylonSerializers.BOOLEAN);
}

{
var hopper = (org.bukkit.block.Hopper) getBlock().getState();
Copy link
Contributor

@JustAHuman-xD JustAHuman-xD Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be getState(false), you shouldn't be using snapshots

var hopperInventoryBukkit = hopper.getInventory();
this.itemsToCheck = new VirtualInventory(9);
itemsToCheck.setPreUpdateHandler(this::preUpdate);
this.hopperInventory = ReferencingInventory.fromStorageContents(hopperInventoryBukkit);
}

@Override
public void onBreak(@NotNull List<@NotNull ItemStack> drops, @NotNull BlockBreakContext context) {
Hopper hopper = (Hopper) getBlock().getState();
public void write(@NotNull PersistentDataContainer pdc) {
pdc.set(WHITELIST_KEY, PylonSerializers.BOOLEAN, whitelist);
}

private void preUpdate(@NotNull ItemPreUpdateEvent event) {
if (event.getUpdateReason() == UpdateReason.SUPPRESSED) return;
event.setCancelled(true);

ItemStack newItem = event.getNewItem();
int slot = event.getSlot();
if (newItem == null) {
event.getInventory().setItem(UpdateReason.SUPPRESSED, slot, null);
} else {
event.getInventory().setItem(UpdateReason.SUPPRESSED, slot, newItem.asOne());
}
}

for (ItemStack item : hopper.getInventory()) {
@Override
public @NotNull Map<@NotNull String, @NotNull Inventory> createInventoryMapping() {
return Map.of(
"inventory", hopperInventory,
"items_to_check", itemsToCheck
);
}

@Override
public void onBreak(@NotNull List<@NotNull ItemStack> drops, @NotNull BlockBreakContext context) {
for (ItemStack item : hopperInventory.getItems()) {
if (item != null) {
drops.add(item);
}
}
}

@Override
public @NotNull Gui createGui() {
return Gui.normal()
.setStructure(
"# # # # # # # # #",
"# # x x x x x # #",
"# # # # $ # # # #"
)
.addIngredient('#', GuiItems.background())
.addIngredient('x', hopperInventory)
.addIngredient('$', new SimpleItem(lang -> {
ItemStack item = new ItemStack(Material.REDSTONE);
item.setData(DataComponentTypes.ITEM_NAME, translation("settings"));
return item;
}, click -> {
Window.single()
.setGui(createSettingsGui())
.setTitle(new AdventureComponentWrapper(translation("settings")))
.setViewer(click.getPlayer())
.build()
.open();
}))
.build();
}

private @NotNull Gui.Builder.Normal createSettingsGui() {
return Gui.normal()
.setStructure(
"# # # # w # # # #",
"x x x x x x x x x",
"# # # # $ # # # #"
)
.addIngredient('#', GuiItems.background())
.addIngredient('x', itemsToCheck)
.addIngredient('$', new SimpleItem(lang -> {
ItemStack item = new ItemStack(Material.CHEST);
item.setData(DataComponentTypes.ITEM_NAME, translation("inventory"));
return item;
}, click -> Window.single()
.setGui(createGui())
.setTitle(new AdventureComponentWrapper(getNameTranslationKey()))
.setViewer(click.getPlayer())
.build()
.open())
)
.addIngredient('w', new ControlItem<>() {
@Override
public void handleClick(@NotNull ClickType clickType, @NotNull Player player, @NotNull InventoryClickEvent event) {
whitelist = !whitelist;
event.setCurrentItem(getItem());
}

@Override
public ItemProvider getItemProvider(Gui gui) {
return (ignored) -> getItem();
}

private ItemStack getItem() {
ItemStack item = new ItemStack(whitelist ? Material.WHITE_WOOL : Material.BLACK_WOOL);
item.setData(
DataComponentTypes.ITEM_NAME,
whitelist ? translation("whitelist")
: translation("blacklist")
);
return item;
}
});
}

@Override
public void tick() {
Hopper hopper = (Hopper) getBlock().getState();
if (!((org.bukkit.block.data.type.Hopper) getBlock().getBlockData()).isEnabled()) {
Block block = getBlock();
Hopper hopper = (Hopper) block.getBlockData();
if (!hopper.isEnabled()) {
return; // don't vacuum if powered
}

for (Entity entity : getBlock().getLocation().toCenterLocation().getNearbyEntities(radius + 0.5, radius + 0.5, radius + 0.5)) {
// loops item entities to add
for (Entity entity : block.getLocation().toCenterLocation().getNearbyEntities(radius + 0.5, radius + 0.5, radius + 0.5)) {
if (!(entity instanceof org.bukkit.entity.Item item)) {
continue;
}

ItemStack stack = item.getItemStack();
HashMap<Integer, ItemStack> rest = hopper.getInventory().addItem(stack);
if (rest.isEmpty()) {
Outcome outcome = addItem(item.getItemStack());
if (outcome == Outcome.FULLY_ADDED) {
new ParticleBuilder(Particle.WITCH)
.location(item.getLocation())
.spawn();
item.remove();
break;
} else if (outcome == Outcome.PARTIAL_ADDED) {
new ParticleBuilder(Particle.WITCH)
.location(item.getLocation())
.spawn();
}
}

int fail = rest.values().stream().findFirst().get().getAmount();
if (fail == stack.getAmount()) {
continue;
/*
BlockFace facing = hopper.getFacing();
Block other = block.getRelative(facing);
BlockState data = other.getState();

var inventory = getHopperInventory();
if (data instanceof BlockInventoryHolder holder) {
for (int i = 0; i < 5; i++) {
ItemStack item = inventory.getItem(i);
if (item == null) continue;

ItemStack singleItem = item.asOne();
HashMap<Integer, ItemStack> excess = holder.getInventory().addItem(singleItem);
if (excess.isEmpty()) {
inventory.setItem(new MachineUpdateReason() , i, item.subtract());
}
}
}*/
}

public enum Outcome {
INVALID,
FULLY_ADDED,
FAILED_FULL,
PARTIAL_ADDED
}

stack.setAmount(fail);
new ParticleBuilder(Particle.WITCH)
.location(item.getLocation())
.spawn();
public @NotNull Outcome addItem(@NotNull ItemStack item) {
if (!isValid(item)) return Outcome.INVALID;

int surplus = hopperInventory.addItem(new MachineUpdateReason(), item);
if (surplus == 0) {
return Outcome.FULLY_ADDED;
}

if (surplus == item.getAmount()) {
return Outcome.FAILED_FULL;
}

item.setAmount(surplus);
return Outcome.PARTIAL_ADDED;
}

public boolean isValid(@NotNull ItemStack item) {
ItemStack[] checkList = itemsToCheck.getItems();
for (ItemStack checkStack : checkList) {
if (item.isSimilar(checkStack)) return whitelist;
}

return !whitelist;
}

private TranslatableComponent translation(String key) {
return Component.translatable("pylon.pylonbase.gui.vacuum_hopper." + key);
}
}
5 changes: 5 additions & 0 deletions src/main/resources/lang/en.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1635,5 +1635,10 @@ gui:
click_to_cast: "<insn>Click</insn> to cast (%amount%/%needed%)"
progress_bar:
text: "%filled_bars%<dark_gray>%empty_bars% <gray>%progress%"
vacuum_hopper:
blacklist: "<black>Blacklist"
whitelist: "<white>Whitelist"
settings: "<red>Settings"
inventory: "<purple>Inventory"
fluid_amount_bar:
text: "%filled_bars%<dark_gray>%empty_bars% <gray>%amount%/%capacity%"
Loading