Extensible handlers for entities #734

uecasm · 2025-04-19T11:57:57Z

Closes discord request
Closes discord request

Changes proposed in this pull request

Moves the "Remove Filtered" button below the resource list to hopefully reduce misclicks.
Fixes some off-by-one errors when converting bounding boxes to AABBs (particularly for entity searches).
Adds "entity handlers", which similar to placement handlers are extensible by addon mods to hook into UI and placement behaviour, instead of relying on hard-coded checks.
- As before, only certain entities will place in survival mode (assuming Minecolonies or another survival handler is installed).
- Entities without any handler are not placeable in survival (but can still be placed in creative). When a handler is defined then the entity becomes placeable by default, unless the handler says otherwise.
- Glow item frames now require themselves as resources, instead of being a free upgrade from normal item frames.
The scan tool entity list now shows some extra icons:
- Up to four item icons showing the resource types that will be required in survival mode.
- A red/green indicator showing whether this entity can be placed in survival mode. (This is somewhat irrelevant to Structurize alone but useful if there's any survival mod on top.)

Testing

Yes I tested this before submitting it.
I also did a multiplayer test.

Review please (should port)

Nightenom

will do full review later, just some quick things to consider

src/main/java/com/ldtteam/structurize/placement/handlers/entity/IEntityHandler.java

Nightenom · 2025-04-19T12:05:05Z

src/main/java/com/ldtteam/structurize/placement/handlers/entity/IEntityHandler.java

+        final List<? extends Entity> list = entity.level().getEntitiesOfClass(entity.getClass(), AABB.unitCubeFromLowerCorner(posInWorld));
+        for (Entity worldEntity : list)
+        {
+            if (worldEntity.position().equals(posInWorld))


This seems sus, are we considering same class same pos as same entities? what about their content/wouldn't it be better to use uuid to prevent dupes? (along with consideration of vanilla in world uuid deduplication)

This is essentially what it did before, except it used an even larger range of blocks to search within (possibly to allow for mob wandering slightly?).

It can't use UUID because it's guaranteed that the entity in-world will have a different UUID from the entity in-blueprint.

note for myself to revisit this in testing

src/main/java/com/ldtteam/structurize/placement/handlers/entity/IEntityHandler.java

Nightenom

I hope you tested thoroughly, I personally use following (4 years old :D) entity blueprint along with one for paintings, both in also mirror settings. I want to do in-game testing myself, but not sure when will get to it

it's txt because github uploading.. before using rename to .blueprint
debug_entities.txt

src/main/java/com/ldtteam/structurize/client/gui/WindowScan.java

Nightenom · 2025-04-29T17:11:51Z

src/main/java/com/ldtteam/structurize/placement/handlers/entity/EntityHandlers.java

+        @Override
+        public boolean canHandle(final Entity entity)
+        {
+            return entity instanceof Mob;


don't have ide open, what is lower livingEntity or mob in entity class hierarchy? iirc mob implements livingentity, if so why not instanceof livingEntity?
(i see it was in old code, just asking)

Mob is derived from LivingEntity. There's probably no particular reason this couldn't be LivingEntity, but I was trying to keep previous behaviour, and that's what it did before.

SpawnEggItem(EntityType<? extends Mob> p_43207_, ...

Actually this is probably why. It's technically only legal to create spawn eggs for Mobs.

Makes sense, wondering if we want to resolve the rest of the set - ie. complement to Mob in LivingEntity set

Any entity not handled by any entity handler will still get default behaviour: placeable in creative mode only, no resources listed, best guess at icon.

The only thing the Mob handler really does differently from default is to give it a resource list, which is kinda redundant since it can't be placed in survival anyway.

Nightenom · 2025-04-29T17:14:01Z

src/main/java/com/ldtteam/structurize/placement/handlers/entity/EntityHandlers.java

+        @Override
+        public boolean canPlace(final Entity entity, final boolean isCreative, final boolean isFancy)
+        {
+            return isCreative && !isFancy;


wonder that all Display types should be placed if isCreative, if mcol wants !isFancy then it should be there

This also matches previous behaviour. But even for pure structurize it makes sense to me to keep them around only for "schematic paste" and not "constructed", because the purpose of these was to show notes in the preview that don't survive when built.

I see that, for now fine, but later for in-blueprint notes we should rather create our extension of Diplay.Text that is backed using tags.
Remaining question: the other Display types? (btw I get you tried to keep up with old code, but since we're unifying logic here we could make it more proper right away)

Yeah, we could extend support for those too.

src/main/java/com/ldtteam/structurize/placement/handlers/entity/EntityHandlers.java

Nightenom · 2025-04-29T17:19:42Z

src/main/java/com/ldtteam/structurize/placement/handlers/entity/IEntityHandler.java

+        final List<? extends Entity> list = entity.level().getEntitiesOfClass(entity.getClass(), AABB.unitCubeFromLowerCorner(posInWorld));
+        for (Entity worldEntity : list)
+        {
+            if (worldEntity.position().equals(posInWorld))


note for myself to revisit this in testing

uecasm · 2025-04-30T08:42:34Z

testing

You can see most of the test blueprints I was using in the description screenshot. Mostly paintings and item frames, but I tried several other things too. Pictured here is your blueprint rotated twice, placed, and scan-boxed again, it looks ok AFAICT.

Raycoms

This looks good. I think as a next step we should maybe look at better entity matching.
(I.e. not only same pos and type, but also same inventory) and then do a "replace" (break and pick up).

Nightenom · 2025-05-28T16:12:31Z

I've DMed you @uecasm, I'm generally fine with changes but I would like to test it myself on 1.21, so either you or I need to port this branch first, tell me whatever works best for you

Extensible handlers for entities

31897bb

Nightenom requested changes Apr 19, 2025

View reviewed changes

uecasm mentioned this pull request Apr 19, 2025

Evaluate resources in non-creative mode ldtteam/minecolonies#10814

Merged

2 tasks

uecasm added 2 commits April 20, 2025 01:24

Clarify position

128d9fa

Use EntityHitResult

54986d2

uecasm marked this pull request as ready for review April 29, 2025 08:59

Nightenom requested changes Apr 29, 2025

View reviewed changes

uecasm added 2 commits April 30, 2025 20:53

Fix loop style

7b68bbd

Merge branch 'version/main' into feature/entity-handlers

504fe05

uecasm requested a review from Nightenom May 28, 2025 09:33

Glow item frames now require themselves

bddb781

Raycoms approved these changes May 28, 2025

View reviewed changes

Uh oh!

Extensible handlers for entities #734

Are you sure you want to change the base?

Extensible handlers for entities #734

Uh oh!

Conversation

uecasm commented Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request

Testing

Uh oh!

Nightenom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

uecasm Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Nightenom left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nightenom Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

uecasm commented Apr 30, 2025

Uh oh!

Raycoms left a comment

Choose a reason for hiding this comment

Uh oh!

Nightenom commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

uecasm commented Apr 19, 2025 •

edited

Loading

uecasm Apr 19, 2025 •

edited

Loading

Nightenom left a comment •

edited

Loading

Nightenom Apr 30, 2025 •

edited

Loading

Nightenom commented May 28, 2025 •

edited

Loading