Compare commits

..
3 Commits
Author SHA1 Message Date
Yoshyandgithub-actions[bot] 287e8317c9 Add reject_continue to PlaceResult and make SKIP short-circuit in ofChain (#63)
ofChain survival placement had a bug where SKIP (returned when a block
already exists) would not stop the chain, causing fallback alternatives
to replace already valid blocks , for example:
<img width="436" height="477" alt="image"
src="https://github.com/user-attachments/assets/7ff3d6fa-de98-4716-823f-3ad2abab7394"
/>

SKIP now short-circuits the chain, remaining alternatives are skipped
because the position is already valid.
To keep correct behavior for elements without autobuild (which
previously returned SKIP as a "no implementation" signal), a new
REJECT_CONTINUE value is added, which: continues silently like SKIP (no
error, not counted) in the walker and in the chain tries the next
alternative like REJECT
Default survivalPlaceBlock and IStructureElementCheckOnly now return
REJECT_CONTINUE instead of SKIP for unhandled paths.

Tested this with the example above, and fixed the issue:
<img width="435" height="498" alt="image"
src="https://github.com/user-attachments/assets/d92bce4d-b5ad-4051-af79-ffd8c819f9f7"
/>
survival placement also still works:
<img width="1234" height="916" alt="image"
src="https://github.com/user-attachments/assets/632d5556-524d-4dc5-a7f5-75c859cb6b70"
/>

this should ideally merged before
https://github.com/GTNewHorizons/GT5-Unofficial/pull/6922 , to fix this
underlying bug, but if possible not be tagged without the other PR,
which would cause all NEI previews of multis with water to not show any
water anymore

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-06 18:10:11 +02:00
Luca 95d1533342 Add Context Parameter to get Description (#60)
Yes this is breaking, but only to the changes that where merged not even
24 hours ago.
2026-05-24 13:35:25 +08:00
Luca 19179ec894 improve description fallback (#59) 2026-05-23 19:42:15 +02:00
6 changed files with 85 additions and 52 deletions

No files matched your search

@@ -57,11 +57,13 @@ public interface IStructureElement<T> {
* {@code StatCollector.translateToLocal()}. If a key has no matching translation, {@code translateToLocal} returns * {@code StatCollector.translateToLocal()}. If a key has no matching translation, {@code translateToLocal} returns
* the input string unchanged, so pre-translated fallback strings also work. * the input string unchanged, so pre-translated fallback strings also work.
* *
* @param context the context object (e.g. the multiblock controller), used to determine state-dependent
* descriptions
* @return a list of accepted block descriptions as lang keys (or display names as fallback), or null if no * @return a list of accepted block descriptions as lang keys (or display names as fallback), or null if no
* description is available * description is available
*/ */
@Nullable @Nullable
default List<String> getDescription() { default List<String> getDescription(T context) {
return null; return null;
} }
@@ -94,7 +96,7 @@ public interface IStructureElement<T> {
"Default implementation of survivalPlaceBlock hit! Things aren't going to work well! IStructureElement class: {}", "Default implementation of survivalPlaceBlock hit! Things aren't going to work well! IStructureElement class: {}",
getClass().getName()); getClass().getName());
if (!StructureLibAPI.isBlockTriviallyReplaceable(world, x, y, z, actor)) return PlaceResult.REJECT; if (!StructureLibAPI.isBlockTriviallyReplaceable(world, x, y, z, actor)) return PlaceResult.REJECT;
return PlaceResult.SKIP; return PlaceResult.REJECT_CONTINUE;
} }
/** /**
@@ -204,7 +206,7 @@ public interface IStructureElement<T> {
if (StructureLibAPI.isDebugEnabled()) LOGGER.info( if (StructureLibAPI.isDebugEnabled()) LOGGER.info(
"Fallback shim code of survivalPlaceBlock hit! Things aren't going to work well! IStructureElement class: {}", "Fallback shim code of survivalPlaceBlock hit! Things aren't going to work well! IStructureElement class: {}",
getClass().getName()); getClass().getName());
return PlaceResult.SKIP; return PlaceResult.REJECT_CONTINUE;
} }
/** /**
@@ -230,8 +232,8 @@ public interface IStructureElement<T> {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return IStructureElement.this.getDescription(); return IStructureElement.this.getDescription(context);
} }
}; };
} }
@@ -266,16 +268,21 @@ public interface IStructureElement<T> {
enum PlaceResult { enum PlaceResult {
/** /**
* This element either exists already, or does not yet have an implementation for survivalPlaceBlock, or some * The element's check passed, the position is already valid. No placement is needed. In the walker: continue
* other unforeseen situations. TODO this definition doesn't seem right. Should we separate SKIP from EXISTS, or * iteration (no error, not counted as placed). In ofChain: short-circuits, remaining alternatives are skipped.
* SKIP from ERROR?
*/ */
SKIP, SKIP,
/** /**
* This element's space is occupied by other stuff and require player attention, or player missing required * The element cannot handle this position (occupied, missing resources, etc.). In the walker: stop iteration
* resource, or the block cannot be placed due to obscure mechanisms, or some other unforeseen situations. * with error particles. In ofChain: try next alternative.
*/ */
REJECT, REJECT,
/**
* This element has no survivalPlaceBlock implementation (default fallback), or otherwise cannot place but is
* not an error condition. In the walker: continue iteration silently (like SKIP). In ofChain: try next
* alternative (like REJECT), so a better-suited element can handle it.
*/
REJECT_CONTINUE,
/** /**
* Autoplace cannot proceed within this tick. To proceed further would require stopping the placement and wait * Autoplace cannot proceed within this tick. To proceed further would require stopping the placement and wait
* for next round. * for next round.
@@ -65,10 +65,10 @@ public interface IStructureElementChain<T> extends IStructureElement<T> {
@Nullable @Nullable
@Override @Override
default List<String> getDescription() { default List<String> getDescription(T context) {
Set<String> descriptions = new LinkedHashSet<>(); Set<String> descriptions = new LinkedHashSet<>();
for (IStructureElement<T> fallback : fallbacks()) { for (IStructureElement<T> fallback : fallbacks()) {
List<String> desc = fallback.getDescription(); List<String> desc = fallback.getDescription(context);
if (desc != null) { if (desc != null) {
descriptions.addAll(desc); descriptions.addAll(desc);
} }
@@ -97,47 +97,51 @@ public interface IStructureElementChain<T> extends IStructureElement<T> {
@Override @Override
default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, IItemSource s, default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, IItemSource s,
EntityPlayerMP actor, Consumer<IChatComponent> chatter) { EntityPlayerMP actor, Consumer<IChatComponent> chatter) {
boolean haveSkip = false; boolean allContinue = true;
List<IChatComponent> bufferedNoise = new ArrayList<>(); List<IChatComponent> bufferedNoise = new ArrayList<>();
for (IStructureElement<T> fallback : fallbacks()) { for (IStructureElement<T> fallback : fallbacks()) {
PlaceResult result = fallback.survivalPlaceBlock(t, world, x, y, z, trigger, s, actor, bufferedNoise::add); PlaceResult result = fallback.survivalPlaceBlock(t, world, x, y, z, trigger, s, actor, bufferedNoise::add);
switch (result) { switch (result) {
case REJECT_CONTINUE:
break;
case REJECT: case REJECT:
allContinue = false;
break; break;
case SKIP: case SKIP:
haveSkip = true; bufferedNoise.forEach(chatter);
break; return PlaceResult.SKIP;
default: default:
return result; return result;
} }
} }
// dump all that noise back into upstream // dump all that noise back into upstream
bufferedNoise.forEach(chatter); bufferedNoise.forEach(chatter);
// TODO need reconsider to ensure this is the right course of action return allContinue ? PlaceResult.REJECT_CONTINUE : PlaceResult.REJECT;
return haveSkip ? PlaceResult.SKIP : PlaceResult.REJECT;
} }
@Override @Override
default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
AutoPlaceEnvironment env) { AutoPlaceEnvironment env) {
boolean haveSkip = false; boolean allContinue = true;
List<IChatComponent> bufferedNoise = new ArrayList<>(); List<IChatComponent> bufferedNoise = new ArrayList<>();
for (IStructureElement<T> fallback : fallbacks()) { for (IStructureElement<T> fallback : fallbacks()) {
PlaceResult result = fallback PlaceResult result = fallback
.survivalPlaceBlock(t, world, x, y, z, trigger, env.withChatter(bufferedNoise::add)); .survivalPlaceBlock(t, world, x, y, z, trigger, env.withChatter(bufferedNoise::add));
switch (result) { switch (result) {
case REJECT_CONTINUE:
break;
case REJECT: case REJECT:
allContinue = false;
break; break;
case SKIP: case SKIP:
haveSkip = true; bufferedNoise.forEach(env.getChatter());
break; return PlaceResult.SKIP;
default: default:
return result; return result;
} }
} }
// dump all that noise back into upstream // dump all that noise back into upstream
bufferedNoise.forEach(env.getChatter()); bufferedNoise.forEach(env.getChatter());
// TODO need reconsider to ensure this is the right course of action return allContinue ? PlaceResult.REJECT_CONTINUE : PlaceResult.REJECT;
return haveSkip ? PlaceResult.SKIP : PlaceResult.REJECT;
} }
} }
@@ -27,12 +27,12 @@ public interface IStructureElementCheckOnly<T> extends IStructureElement<T> {
@Override @Override
default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, IItemSource s, default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, IItemSource s,
EntityPlayerMP actor, Consumer<IChatComponent> chatter) { EntityPlayerMP actor, Consumer<IChatComponent> chatter) {
return PlaceResult.SKIP; return PlaceResult.REJECT_CONTINUE;
} }
@Override @Override
default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
AutoPlaceEnvironment env) { AutoPlaceEnvironment env) {
return PlaceResult.SKIP; return PlaceResult.REJECT_CONTINUE;
} }
} }
@@ -69,7 +69,7 @@ class LazyStructureElement<T> implements IStructureElementDeferred<T> {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return elem != null ? elem.getDescription() : null; return elem != null ? elem.getDescription(context) : null;
} }
} }
@@ -707,12 +707,22 @@ public class StructureUtility {
public static <T, TIER> IStructureElement<T> ofBlocksTiered(ITierConverter<TIER> tierExtractor, public static <T, TIER> IStructureElement<T> ofBlocksTiered(ITierConverter<TIER> tierExtractor,
@Nullable List<Pair<Block, Integer>> allKnownTiers, @Nullable TIER notSet, BiConsumer<T, TIER> setter, @Nullable List<Pair<Block, Integer>> allKnownTiers, @Nullable TIER notSet, BiConsumer<T, TIER> setter,
Function<T, TIER> getter) { Function<T, TIER> getter) {
return ofBlocksTiered(tierExtractor, allKnownTiers, notSet, setter, getter, null); List<String> descriptions = null;
if (allKnownTiers != null) {
descriptions = new java.util.ArrayList<>();
for (Pair<Block, Integer> tier : allKnownTiers) {
Item item = Item.getItemFromBlock(tier.getLeft());
if (item != null) {
descriptions.add(new ItemStack(item, 1, tier.getRight()).getUnlocalizedName() + ".name");
}
}
}
return ofBlocksTiered(tierExtractor, allKnownTiers, notSet, setter, getter, descriptions);
} }
/** /**
* Like {@link #ofBlocksTiered(ITierConverter, List, Object, BiConsumer, Function)}, but with an explicit * Like {@link #ofBlocksTiered(ITierConverter, List, Object, BiConsumer, Function)}, but with an explicit
* description that will be returned by {@link IStructureElement#getDescription()}. * description that will be returned by {@link IStructureElement#getDescription(Object)}.
* *
* @param description the description lang keys to attach to this element, or null for no description * @param description the description lang keys to attach to this element, or null for no description
* @see #ofBlocksTiered(ITierConverter, List, Object, BiConsumer, Function) * @see #ofBlocksTiered(ITierConverter, List, Object, BiConsumer, Function)
@@ -781,7 +791,7 @@ public class StructureUtility {
public PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger, public PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
AutoPlaceEnvironment env) { AutoPlaceEnvironment env) {
Pair<Block, Integer> hint = getHint(trigger); Pair<Block, Integer> hint = getHint(trigger);
if (hint == null) return PlaceResult.REJECT; // TODO or SKIP? if (hint == null) return PlaceResult.REJECT;
Block block = world.getBlock(x, y, z); Block block = world.getBlock(x, y, z);
int meta = world.getBlockMetadata(x, y, z); int meta = world.getBlockMetadata(x, y, z);
TIER tier = tierExtractor.convert(block, meta); TIER tier = tierExtractor.convert(block, meta);
@@ -801,7 +811,18 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
TIER currentTier = getter.apply(context);
if (Objects.equals(currentTier, notSet)) return description;
for (Pair<Block, Integer> pair : hints) {
TIER pairTier = tierExtractor.convert(pair.getKey(), pair.getValue());
if (!Objects.equals(pairTier, currentTier)) continue;
Item item = Item.getItemFromBlock(pair.getKey());
if (item == null) continue;
return Collections
.singletonList(new ItemStack(item, 1, pair.getValue()).getUnlocalizedName() + ".name");
}
return description; return description;
} }
@@ -1431,7 +1452,7 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
Item item = Item.getItemFromBlock(block); Item item = Item.getItemFromBlock(block);
if (item == null) return null; if (item == null) return null;
return Collections.singletonList(new ItemStack(item, 1, meta).getUnlocalizedName() + ".name"); return Collections.singletonList(new ItemStack(item, 1, meta).getUnlocalizedName() + ".name");
@@ -1518,7 +1539,7 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
Item item = Item.getItemFromBlock(block); Item item = Item.getItemFromBlock(block);
if (item == null) return null; if (item == null) return null;
return Collections.singletonList(new ItemStack(item, 1, meta).getUnlocalizedName() + ".name"); return Collections.singletonList(new ItemStack(item, 1, meta).getUnlocalizedName() + ".name");
@@ -1568,7 +1589,7 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
Item item = Item.getItemFromBlock(block); Item item = Item.getItemFromBlock(block);
if (item == null) return null; if (item == null) return null;
return Collections.singletonList(new ItemStack(item, 1, 0).getUnlocalizedName() + ".name"); return Collections.singletonList(new ItemStack(item, 1, 0).getUnlocalizedName() + ".name");
@@ -1608,7 +1629,7 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
Item item = Item.getItemFromBlock(block); Item item = Item.getItemFromBlock(block);
if (item == null) return null; if (item == null) return null;
return Collections.singletonList(new ItemStack(item, 1, 0).getUnlocalizedName() + ".name"); return Collections.singletonList(new ItemStack(item, 1, 0).getUnlocalizedName() + ".name");
@@ -1879,8 +1900,8 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return element.getDescription(); return element.getDescription(context);
} }
}; };
} }
@@ -1938,7 +1959,7 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return description; return description;
} }
}; };
@@ -2000,8 +2021,8 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return element.getDescription(); return element.getDescription(context);
} }
}; };
} }
@@ -2011,11 +2032,11 @@ public class StructureUtility {
/** /**
* Enable this structure element only if given predicate returns true. * Enable this structure element only if given predicate returns true.
* <p> * <p>
* Return SKIP when survival auto place if given predicate returns false. * Return REJECT_CONTINUE when survival auto place if given predicate returns false.
*/ */
public static <T> IStructureElement<T> onlyIf(Predicate<? super T> predicate, public static <T> IStructureElement<T> onlyIf(Predicate<? super T> predicate,
IStructureElement<? super T> downstream) { IStructureElement<? super T> downstream) {
return onlyIf(predicate, downstream, PlaceResult.SKIP); return onlyIf(predicate, downstream, PlaceResult.REJECT_CONTINUE);
} }
/** /**
@@ -2075,8 +2096,8 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return downstream.getDescription(); return downstream.getDescription(context);
} }
}; };
} }
@@ -2090,10 +2111,10 @@ public class StructureUtility {
* using {@link #isAir()}. It will not attempt to capture any errors though, so next one will not be tried if * using {@link #isAir()}. It will not attempt to capture any errors though, so next one will not be tried if
* previous one would crash. * previous one would crash.
* <p> * <p>
* (*): For survival auto place, it will * REJECT, if all structure element REJECT * SKIP, if 1 or more structure * (*): For survival auto place, it will: REJECT, if any structure element returns REJECT (and none returned ACCEPT,
* element SKIP and the rest structure element (0 or more) REJECT * any other result, **immediately** upon any * STOP, ACCEPT_STOP, or SKIP); REJECT_CONTINUE, if all structure elements return REJECT_CONTINUE (none returned
* structure element returns these other results. This behavior is not 100% fixed and might change later on, but we * REJECT); SKIP, as soon as any structure element returns SKIP; any other result, immediately upon any structure
* will send the notice on a best effort basis. * element returning those.
* <p> * <p>
* Take care while chaining, as it will try to call every structure element until it returns true. If none does it * Take care while chaining, as it will try to call every structure element until it returns true. If none does it
* will finally return false. * will finally return false.
@@ -2178,8 +2199,8 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return elem.getDescription(); return elem.getDescription(context.getCurrentContext());
} }
}; };
} }
@@ -3021,8 +3042,8 @@ public class StructureUtility {
@Nullable @Nullable
@Override @Override
public List<String> getDescription() { public List<String> getDescription(T context) {
return backing.getDescription(); return backing.getDescription(context);
} }
}; };
} }
@@ -43,9 +43,10 @@ class SurvivalBuildStructureWalker<T> implements IStructureWalker<T> {
env.offsetABC[2] = c; env.offsetABC[2] = c;
env.setSource(params.getSource()); env.setSource(params.getSource());
PlaceResult placeResult = element.survivalPlaceBlock(object, world, x, y, z, trigger, env); PlaceResult placeResult = element.survivalPlaceBlock(object, world, x, y, z, trigger, env);
if (placeResult != PlaceResult.SKIP && built == -1) built = 0; if (placeResult != PlaceResult.SKIP && placeResult != PlaceResult.REJECT_CONTINUE && built == -1) built = 0;
switch (placeResult) { switch (placeResult) {
case SKIP: case SKIP:
case REJECT_CONTINUE:
return true; return true;
case ACCEPT: case ACCEPT:
if (check) element.check(object, world, x, y, z); if (check) element.check(object, world, x, y, z);