Colony expedition system #10286

Thodor12 · 2024-09-29T10:24:48Z

Changes proposed in this pull request:

Expeditions are virtualized events that can be started from a new visitor that will appear at the townhall. You may talk to them and begin preparing for an expedition.
You will have to give them a given amount of goods and assign one or more guards to travel alongside them.
Current and past expeditions can be viewed from the townhall, you will be able to see what you provided them, which guards were sent along, who died (if any), and everything they managed to find.
The system is highly modifiable through the means of datapacks, from the expedition types to the loot tables.

The process and some screenshots.

You start of by getting visitors spawn in your town hall, there is no research or any kind of requirement for this to start happening. These can be identified by the map icon above their heads.

Talking to them will result in them asking if you want to go on an expedition, you can accept or deny.

You will then receive the expedition guide scroll, from here you can manage the inventory for the expedition as well as which guards are assigned.

After providing them with all the stuff, you return to the expeditionary, and attempt to start the expedition, if any requirement isn't met they will tell you, otherwise they will prompt to start the expedition.

Initially the expeditionary will stick around for a bit whilst they start packing up (in future release this will involve walking to the gate). If you attempt to talk to them at this time you'll receive the following prompt (does nothing).

When they return you can claim the loot from the expedition, and you can then see the past 5 expeditions in the townhall expeditions overview.

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

Review please

# Conflicts: # src/api/java/com/minecolonies/api/colony/IVisitorData.java # src/main/java/com/minecolonies/apiimp/initializer/EntityInitializer.java # src/main/java/com/minecolonies/core/MineColonies.java # src/main/java/com/minecolonies/core/colony/interactionhandling/RecruitmentInteraction.java # src/main/java/com/minecolonies/core/colony/managers/CitizenManager.java # src/main/java/com/minecolonies/core/colony/managers/VisitorManager.java # src/main/java/com/minecolonies/core/datalistener/CustomVisitorListener.java # src/main/java/com/minecolonies/core/entity/ai/visitor/EntityAIVisitor.java # src/main/java/com/minecolonies/core/entity/citizen/VisitorCitizen.java

# Conflicts: # src/main/java/com/minecolonies/api/IMinecoloniesAPI.java # src/main/java/com/minecolonies/api/MinecoloniesAPIProxy.java # src/main/java/com/minecolonies/apiimp/CommonMinecoloniesAPIImpl.java # src/main/java/com/minecolonies/apiimp/initializer/EntityInitializer.java # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java

# Conflicts: # src/main/java/com/minecolonies/api/colony/managers/interfaces/IExpeditionManager.java # src/main/java/com/minecolonies/core/colony/managers/VisitorManager.java

# Conflicts: # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java

# Conflicts: # gradle.properties

# Conflicts: # gradle.properties # src/main/java/com/minecolonies/core/colony/Colony.java # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java # src/main/java/com/minecolonies/core/event/DataPackSyncEventHandler.java # src/main/java/com/minecolonies/core/event/EventHandler.java # src/main/java/com/minecolonies/core/event/FMLEventHandler.java # src/main/java/com/minecolonies/core/network/NetworkChannel.java # src/main/resources/assets/minecolonies/lang/manual_en_us.json

src/main/java/com/minecolonies/api/colony/jobs/IJob.java

src/main/java/com/minecolonies/api/colony/managers/interfaces/expeditions/ColonyExpedition.java

# Conflicts: # src/main/java/com/minecolonies/api/colony/ICitizenDataView.java # src/main/java/com/minecolonies/api/entity/ModEntities.java # src/main/java/com/minecolonies/apiimp/initializer/EntityInitializer.java # src/main/java/com/minecolonies/core/entity/ai/visitor/EntityAIVisitor.java # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java # src/main/resources/assets/minecolonies/lang/manual_en_us.json

# Conflicts: # src/main/java/com/minecolonies/api/loot/ModLootConditions.java

# Conflicts: # src/main/java/com/minecolonies/core/colony/ColonyView.java # src/main/resources/assets/minecolonies/lang/manual_en_us.json

# Conflicts: # gradle.properties

Raycoms

Okay, so I'm half way through. I hopefully will do some more tomorrow.
I left a bunch of comments on the way.
Generally, the PR description needs a lot more info:
a) UIs
b) Description of expected input cost of expeditions
c) Expected outcome (death/successrate/rewards)
d) Generic description how an expedition works and how the player workflow looks like.

src/main/java/com/minecolonies/api/colony/jobs/IJob.java

src/main/java/com/minecolonies/api/colony/jobs/IJobView.java

src/main/java/com/minecolonies/api/entity/ModEntities.java

...a/com/minecolonies/api/entity/ai/statemachine/tickratestatemachine/TickRateStateMachine.java

src/main/java/com/minecolonies/api/equipment/ModEquipmentTypes.java

Raycoms · 2025-05-10T18:46:17Z

src/main/java/com/minecolonies/core/client/gui/townhall/WindowTownHallExpeditions.java

+/**
+ * Gui for viewing past expeditions.
+ */
+public class WindowTownHallExpeditions extends AbstractWindowSkeleton implements ButtonHandler


For a good review I think we need these UIs with example screenshots in the PR description.
The UI code is very simple, but I think it's important to see how it all looks like to give proper feedback.

src/main/java/com/minecolonies/core/colony/events/ColonyExpeditionEvent.java

Raycoms · 2025-05-10T18:51:54Z

src/main/java/com/minecolonies/core/colony/events/ColonyExpeditionEvent.java

+     * @param damage  the amount of damage dealt.
+     * @param onBreak function called when an armor slot breaks.
+     */
+    private void damageArmor(final @NotNull ArmorList list, final float damage, final Consumer<EquipmentSlot> onBreak)


Generic Comment: Have you tested complete client quit and restart mid expedition?

Yes, it's able to properly continue mid way as all necessary pieces of information are stored in NBT of the event.

Raycoms · 2025-05-10T18:53:58Z

...lonies/core/colony/expeditions/colony/requirements/ColonyExpeditionEquipmentRequirement.java

+        }
+
+        @Override
+        public ItemStack getDefaultItemStack()


This seems very bad performance wise. What is this for?

This is only utilized upon transferring the items into the expedition sheet when in creative. It'll apply a default item stack to insert given the user will have nothing in their inventory at the time.
(This is also mentioned in the interface javadoc what it does)

src/main/java/com/minecolonies/core/colony/expeditions/encounters/ExpeditionEncounter.java

Raycoms

Okay second and final review (got fully through now).
Second part looks pretty okay as well, mostly a lot of streams we should avoid with small number of values and where things can break.

A thing that I think is missing is that we have to avoid citizens from being fired from their job while on an expedition (like you can't fire a guard when on expedition).

src/main/java/com/minecolonies/core/colony/managers/TravelingManager.java

src/main/java/com/minecolonies/core/entity/ai/visitor/EntityAIExpeditionary.java

src/main/java/com/minecolonies/core/entity/visitor/ExpeditionaryVisitorType.java

...colonies/core/network/messages/server/colony/visitor/expeditionary/TransferItemsMessage.java

# Conflicts: # gradle.properties # src/main/java/com/minecolonies/api/colony/ICitizenDataView.java # src/main/java/com/minecolonies/apiimp/initializer/ModItemsInitializer.java # src/main/java/com/minecolonies/core/colony/CitizenData.java # src/main/java/com/minecolonies/core/colony/ColonyView.java # src/main/java/com/minecolonies/core/colony/buildings/modules/BuildingResourcesModule.java # src/main/java/com/minecolonies/core/colony/buildings/modules/TavernBuildingModule.java # src/main/java/com/minecolonies/core/event/EventHandler.java # src/main/java/com/minecolonies/core/event/FMLEventHandler.java # src/main/resources/assets/minecolonies/gui/layouthuts/layoutbuilderres.xml # src/main/resources/assets/minecolonies/gui/layouthuts/layoutwarehouseoptions.xml # src/main/resources/assets/minecolonies/gui/townhall/layoutactions.xml # src/main/resources/assets/minecolonies/lang/manual_en_us.json

Raycoms

some more comments

Raycoms · 2025-07-10T13:29:51Z

src/main/java/com/minecolonies/api/equipment/ModEquipmentTypes.java

@@ -232,4 +233,25 @@ public static boolean canPerformDefaultActions(ItemStack itemStack, Set<ToolActi
        }
        return true;
    }
+
+    @NotNull
+    public static EquipmentTypeEntry[] getAllWeapons()


Atm, we only allow swords and bows for weapons, though right.

Raycoms · 2025-07-10T13:32:19Z

src/main/java/com/minecolonies/core/client/gui/blockui/RotatingItemIcon.java

@@ -55,8 +55,13 @@ public void setItems(@NotNull final List<ItemStack> items)
            throw new IllegalArgumentException("Items list must contain at least one item.");
        }

+        final boolean hasChanged = !this.items.equals(items);


Honestly, I'd just make sure the index doesn't exceed list size and otherwise don't reset it on setItems?

src/main/java/com/minecolonies/core/colony/events/ColonyExpeditionEvent.java

…s_120

Thodor12 added 30 commits January 15, 2024 00:33

Temp

88ce1d8

Finish off visitor type system

da9e661

Merge branch 'version/main' into feature/visitor_types

916d80d

Final

35c7eb2

Fix

513380e

Fixes

5ca75e1

Port expeditions

871f59f

Lot of fixes

c0b2b71

Temp

3fefe0f

Move

74a655a

Merge branch 'feature/visitor_types' into feature/colony_expeditions_120

c309ff5

# Conflicts: # src/main/java/com/minecolonies/api/colony/managers/interfaces/IExpeditionManager.java # src/main/java/com/minecolonies/core/colony/managers/VisitorManager.java

Move

06bb8cb

Merge branch 'version/main' into feature/colony_expeditions_120

1cb0b13

Fixes

63e435e

Merge branch 'version/main' into feature/visitor_types

3abacb1

Fix

ab04bb8

Merge branch 'feature/visitor_types' into feature/colony_expeditions_120

3f5a362

Merge branch 'version/main' into feature/visitor_types

99a600d

# Conflicts: # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java

Temp

90771e4

Merge branch 'version/main' into feature/colony_expeditions_120

6be5771

# Conflicts: # src/main/java/com/minecolonies/core/entity/visitor/VisitorCitizen.java

Merge branch 'version/main' into feature/visitor_types

9fe28ba

Temp

befff5c

Updates

af5148f

Merge branch 'version/main' into feature/colony_expeditions_120

696725d

Merge branch 'version/main' into feature/visitor_types

506a9c3

Expedition spawning works

d1cc472

Merge branch 'version/main' into feature/colony_expeditions_120

ac9b1ec

# Conflicts: # gradle.properties

Merge branch 'version/main' into feature/colony_expeditions_120

78ba4c2

Thodor12 added 4 commits October 27, 2024 15:19

Update encounters sync for dedicated servers, update code

80b4083

Remove space

eb621f0

Update

b8cbaab

Raycoms reviewed Dec 17, 2024

View reviewed changes

src/main/java/com/minecolonies/api/colony/jobs/IJob.java Outdated Show resolved Hide resolved

Raycoms reviewed Dec 17, 2024

View reviewed changes

src/main/java/com/minecolonies/api/colony/managers/interfaces/expeditions/ColonyExpedition.java Outdated Show resolved Hide resolved

Thodor12 added 9 commits January 9, 2025 19:32

Temp

652c2d5

Several improvements and bugfixes

84820b3

Merge branch 'version/main' into feature/colony_expeditions_120

a372d22

Further changes

6d70fe2

Merge branch 'version/main' into feature/colony_expeditions_120

d1ab51f

Fixed 2 more bugs

82a3fdd

Merge branch 'version/main' into feature/colony_expeditions_120

2f9d177

Merge branch 'version/main' into feature/colony_expeditions_120

ac3bfb3

# Conflicts: # src/main/java/com/minecolonies/api/loot/ModLootConditions.java

Thodor12 marked this pull request as ready for review March 3, 2025 13:33

Thodor12 added 4 commits March 10, 2025 10:10

Fix several exceptions

05b01b9

Merge branch 'version/main' into feature/colony_expeditions_120

abc2707

# Conflicts: # src/main/java/com/minecolonies/core/colony/ColonyView.java # src/main/resources/assets/minecolonies/lang/manual_en_us.json

Several fixes

beed002

Merge branch 'version/main' into feature/colony_expeditions_120

947ba8b

# Conflicts: # gradle.properties

Raycoms requested changes May 10, 2025

View reviewed changes

Raycoms requested changes May 28, 2025

View reviewed changes

Thodor12 added 2 commits June 28, 2025 09:31

PR updates

15cd3f2

Raycoms reviewed Jul 10, 2025

View reviewed changes

Thodor12 added 5 commits July 16, 2025 20:46

Merge branch 'refs/heads/version/main' into feature/colony_expedition…

d9528cf

…s_120

Fixes

5e910d8

Updates

08ea947

Add debug log

3ae3538

Upd

b76cb27

Uh oh!

Colony expedition system #10286

Are you sure you want to change the base?

Colony expedition system #10286

Uh oh!

Conversation

Thodor12 commented Sep 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request:

Uh oh!

Uh oh!

Uh oh!

Raycoms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Raycoms May 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Raycoms May 10, 2025

Choose a reason for hiding this comment

Uh oh!

Thodor12 Jun 28, 2025

Choose a reason for hiding this comment

Uh oh!

Raycoms May 10, 2025

Choose a reason for hiding this comment

Uh oh!

Thodor12 Jun 28, 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!

Uh oh!

Raycoms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Raycoms left a comment

Choose a reason for hiding this comment

Uh oh!

Raycoms Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

Raycoms Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Thodor12 commented Sep 29, 2024 •

edited

Loading

Thodor12 Jun 28, 2025 •

edited

Loading