Skip to content

Back off briefly when a pipe pull cannot be delivered anywhere #1380

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
RasmusKD wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Back off briefly when a pipe pull cannot be delivered anywhere #1380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 53 additions & 0 deletions src/main/java/com/sk89q/craftbook/mechanics/pipe/Pipes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.sk89q.worldedit.world.block.BlockStateHolder;
import com.sk89q.worldedit.world.block.BlockTypes;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.Tag;
import org.bukkit.block.Block;
Expand All @@ -44,9 +45,11 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

public class Pipes extends AbstractCraftBookMechanic {
Expand Down Expand Up @@ -348,6 +351,29 @@ private void startPipe(Block block, List<ItemStack> items, boolean request) {

if (block.getType() == Material.STICKY_PISTON) {

// A piston whose whole network refused the last pull waits briefly, so a
// blocked pipe stops re-traversing the network and churning the same
// leftovers on every pulse.
if (pipeBackoffMillis > 0) {
Long pausedUntil = pullBackoff.get(block.getLocation());
if (pausedUntil != null) {
if (System.currentTimeMillis() < pausedUntil) {
// Requests carrying items (e.g. another mechanic feeding this
// piston) still buffer into the source container while paused.
if (!items.isEmpty()) {
Block sourceBlock = block.getRelative(((Piston) block.getBlockData()).getFacing());
if (InventoryUtil.doesBlockHaveInventory(sourceBlock)) {
List<ItemStack> rest = InventoryUtil.addItemsToInventory((InventoryHolder) sourceBlock.getState(), items.toArray(new ItemStack[items.size()]));
items.clear();
items.addAll(rest);
}
}
return;
}
pullBackoff.remove(block.getLocation());
}
}

List<ItemStack> leftovers = new ArrayList<>();

Piston p = (Piston) block.getBlockData();
Expand Down Expand Up @@ -378,6 +404,11 @@ private void startPipe(Block block, List<ItemStack> items, boolean request) {
break;
}

int pulledAmount = 0;
for (ItemStack pulled : items)
if (pulled != null)
pulledAmount += pulled.getAmount();

PipeSuckEvent event = new PipeSuckEvent(block, new ArrayList<>(items), fac);
Bukkit.getPluginManager().callEvent(event);
items.clear();
Expand All @@ -387,6 +418,20 @@ private void startPipe(Block block, List<ItemStack> items, boolean request) {
searchNearbyPipes(block, visitedPipes, items);
}

// Nothing the pull carried was accepted anywhere: pause this piston
// instead of repeating the full traversal on the next pulse.
if (pipeBackoffMillis > 0 && pulledAmount > 0) {
int undelivered = 0;
for (ItemStack left : items)
if (left != null)
undelivered += left.getAmount();
if (undelivered >= pulledAmount) {
if (pullBackoff.size() > MAX_PULL_BACKOFFS)
pullBackoff.clear();
pullBackoff.put(block.getLocation(), System.currentTimeMillis() + pipeBackoffMillis);
}
}

if (!items.isEmpty()) {
if (facType == Material.CRAFTER)
leftovers.addAll(InventoryUtil.addItemsToCrafter((Crafter) fac.getState(), items.toArray(new ItemStack[items.size()])));
Expand Down Expand Up @@ -507,10 +552,15 @@ public void onPipeRequest(PipeRequestEvent event) {
}
}

/** Piston -> time a fully refused pull is paused until. */
private final Map<Location, Long> pullBackoff = new HashMap<>();
private static final int MAX_PULL_BACKOFFS = 4096;

private boolean pipesDiagonal;
private BlockStateHolder<?> pipeInsulator;
private boolean pipeStackPerPull;
private boolean pipeRequireSign;
private int pipeBackoffMillis;

@Override
public void loadConfiguration (YAMLProcessor config, String path) {
Expand All @@ -526,5 +576,8 @@ public void loadConfiguration (YAMLProcessor config, String path) {

config.setComment(path + "require-sign", "Requires pipes to have a [Pipe] sign connected to them. This is the only way to require permissions to make pipes.");
pipeRequireSign = config.getBoolean(path + "require-sign", false);

config.setComment(path + "full-pipe-cooldown", "Seconds a sticky piston waits before pulling again after a pulse where nothing could be delivered anywhere (full network). Stops blocked pipes re-walking the whole network every pulse. 0 disables.");
pipeBackoffMillis = config.getInt(path + "full-pipe-cooldown", 2) * 1000;
}
}
Loading