Reworked Wishing Well implementation with persistency and performance enhancements.

Author: armele

README.md

@@ -14,7 +14,7 @@ Craft a Marketplace hut. Using the build tool, choose the "Economics" style from
 
 Marketplace Hut - Supports the Marketplace building and the Shopkeeper job.  
 Advanced Clipboard - Just like the regular clipboard but with a button that filters the outstanding needs down to only those expected to be fulfilled by a player.  
-Trade Coin - These coins can be minted from the marketplace by sneak-right-clicking your advanced clipboard on the Marketplace hut. The hut must be upgraded, first! Trade Coins will (eventually) be used as the basis for triggering most Trade Post mod features.
+Trade Coin - These coins can be minted from the marketplace by sneak-right-clicking your advanced clipboard on the Marketplace hut. The hut must be upgraded, first! Trade Coins will (eventually) be used as the basis for triggering most Trade Post mod features.  Coins can be used at a Wishing Well to trigger certain effects.
 
 ### Custom Blocks
 
@@ -24,6 +24,13 @@ Marketplace Hut Block - Block implementation of the item above.
 The value of a Trade Coin can be configured.
 The level of the marketplace required to mint coins can be configured.
 
+### Making Wishes
+When you throw a coin into a wishing well with another object, your wish might come true!
+Currently implemented or in-progress:
+- Kill all zombies nearby (1 Coin + Zombie Flesh)
+- Terminate an in progress raid (1 Coin + 1 Iron Sword) NOT YET FULLY IMPLEMENTED
+
+
 ## Installation
 
 Download the appropriate mctradepost-x.y.z.jar file from Github at the root project directory.  
@@ -32,28 +39,32 @@ Note that MineColonies and its dependencies must be present to work.
 
 ### Compatibility Reference
 
-mctradepost-0.1.003 -> MineColonies 1.1.950 (Minecraft 1.21.1)  
+mctradepost-0.2.001 -> MineColonies 1.1.950 (Minecraft 1.21.1)  
 
 ## Building Design Reference
 ### Marketplace
 The marketplace building should have two item frames or glowing item frames for each level of the building.
 These frames should be mounted in empty (air) blocks tagged with the "display_shelf" tag.  (Apply the tag to a placeholder item, then remove that placeholder and put the frame in.)
 
+### Wishing Well
+A wishing well can be created by surrounding a 2x2 puddle of water (depth 1) with stone bricks.  (Future designs will be more aesthetically pleasing.)
 
 ## Current Status
 
 This mod can best be described as a "pre-alpha" state. It functionality may change rapidly and without warning.
+"Wishing Well" Interface for spending earned income (IN PROGRESS)
 
 ### Roadmap (Roughly Prioritized)
 
-Interface for spending earned income.  
+Implement Coin Usage
 - Unlock subsequent levels of the merchant building  
 - Summon traders  
 - Add trader recipes  
 Happiness based on colony wealth per citizen  
 Leisure time / resorts / vacations (Resort hut w/custom needs items; travel agency hut)  
 Huts to allow skill-up in non-primary/secondary stats.  
 Pet shops, pet functions, pet-related colony roles.  
+In-Game Instructions
 Assembling colonies into collections (empire, state, etc.)  
 Express shipping (intracolony and inter-colony) - faster item transport. Faster people transport.  
 

gradle.properties

@@ -32,7 +32,7 @@ mod_name=MC Trade Post
 # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
 mod_license=All Rights Reserved
 # The mod version. See https://semver.org/
-mod_version=0.1.003
+mod_version=0.2.001
 # The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
 # This should match the base package used for the mod sources.
 # See https://maven.apache.org/guides/mini/guide-naming-conventions.html

mctradepost-0.1.003.jar mctradepost-0.2.001.jarmctradepost-0.1.003.jar renamed to mctradepost-0.2.001.jar

@@ -1,5 +1,7 @@
 package com.deathfrog.mctradepost;
 
+import java.util.function.Supplier;
+
 import org.slf4j.Logger;
 
 import com.deathfrog.mctradepost.api.sounds.ModSoundEvents;
@@ -26,12 +28,16 @@
 import net.minecraft.client.renderer.entity.EntityRendererProvider;
 import net.minecraft.core.Registry;
 import net.minecraft.core.registries.Registries;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraft.server.level.ServerPlayer;
+import net.minecraft.world.entity.EntityType;
+import net.minecraft.world.entity.MobCategory;
 import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.CreativeModeTabs;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.Rarity;
 import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.neoforged.api.distmarker.Dist;
 import net.neoforged.api.distmarker.OnlyIn;
 import net.neoforged.bus.api.IEventBus;
@@ -53,11 +59,14 @@
 import net.neoforged.neoforge.network.event.RegisterPayloadHandlersEvent;
 import net.neoforged.neoforge.network.handling.DirectionalPayloadHandler;
 import net.neoforged.neoforge.network.registration.PayloadRegistrar;
+import net.neoforged.neoforge.registries.DeferredHolder;
 import net.neoforged.neoforge.registries.DeferredItem;
 import net.neoforged.neoforge.registries.DeferredRegister;
 import net.neoforged.neoforge.registries.RegisterEvent;
+import com.deathfrog.mctradepost.core.entity.CoinEntity;
 /*
  */
+import com.deathfrog.mctradepost.core.entity.CoinRenderer;
 
 // TODO: To register a sound in Minecraft, you'll need to add a sound event to the game's sounds.json file. You can do this by adding your custom sound events within the assets/minecraft/sounds.json file of your resource pack or mod. You'll also need to place the audio file (usually in .ogg format) in the correct directory (e.g., resources/assets/mod-id/sounds). 
 /* MISSING SOUNDS:
@@ -348,26 +357,31 @@ public class MCTradePostMod
 
     // Create a Deferred Register to hold Items which will all be registered under the "mctradepost" namespace
     public static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID);
+    
+    // Create a Deferred Register to hold Entities which will all be registered under the "mctradepost" namespace
+    public static final DeferredRegister<EntityType<?>> ENTITIES = DeferredRegister.create(Registries.ENTITY_TYPE, MCTradePostMod.MODID);
 
+    
     public static final DeferredItem<AdvancedClipboardItem> ADVANCED_CLIPBOARD = ITEMS.register("advanced_clipboard",
         () -> new AdvancedClipboardItem(new Item.Properties().stacksTo(1)));
+
+    public static final DeferredHolder<EntityType<?>, EntityType<CoinEntity>> COIN_ENTITY_TYPE =
+            ENTITIES.register("coin_entity", () ->
+                EntityType.Builder.<CoinEntity>of(CoinEntity::new, MobCategory.MISC)
+                    .sized(0.25f, 0.25f)    // Size of the entity (like an ItemEntity)
+                    .clientTrackingRange(8) // Reasonable for item-like entities
+                    .updateInterval(10)     // Sync rate
+                    .build(ResourceLocation.fromNamespaceAndPath(MCTradePostMod.MODID, "coin_entity").toString())
+            );
 
-    public static final DeferredItem<CoinItem> MCTP_COIN = ITEMS.register("mctp_coin", 
+    public static final DeferredItem<CoinItem> MCTP_COIN_ITEM = ITEMS.register("mctp_coin", 
         () -> new CoinItem(new Item.Properties().stacksTo(64).rarity(Rarity.UNCOMMON)));
 
     public static MCTPBaseBlockHut blockHutMarketplace;
 
     // Create a Deferred Register to hold CreativeModeTabs which will all be registered under the "examplemod" namespace
     public static final DeferredRegister<CreativeModeTab> CREATIVE_MODE_TABS = DeferredRegister.create(Registries.CREATIVE_MODE_TAB, MODID);
 
-    // Creates a new Block with the id "examplemod:example_block", combining the namespace and path
-    // public static final DeferredBlock<Block> EXAMPLE_BLOCK = BLOCKS.registerSimpleBlock("example_block", BlockBehaviour.Properties.of().mapColor(MapColor.STONE));
-    
-    // Creates a new BlockItem with the id "examplemod:example_block", combining the namespace and path
-    // public static final DeferredItem<BlockItem> EXAMPLE_BLOCK_ITEM = ITEMS.registerSimpleBlockItem("example_block", EXAMPLE_BLOCK);
-
-    // Creates a new food item with the id "examplemod:example_id", nutrition 1 and saturation 2
-    // public static final DeferredItem<Item> EXAMPLE_ITEM = ITEMS.registerSimpleItem("example_item", new Item.Properties().food(new FoodProperties.Builder().alwaysEdible().nutrition(1).saturationModifier(2f).build()));
 
     // Creates a creative tab with the id "examplemod:example_tab" for the example item, that is placed after the combat tab
     /* 
@@ -389,8 +403,13 @@ public MCTradePostMod(IEventBus modEventBus, ModContainer modContainer)
 
         // Register the Deferred Register to the mod event bus so blocks get registered
         BLOCKS.register(modEventBus);
+        
         // Register the Deferred Register to the mod event bus so items get registered
         ITEMS.register(modEventBus);
+       
+        // Register the Deferred Register to the mod event bus so entities get registered
+        ENTITIES.register(modEventBus);
+        
         // Register the Deferred Register to the mod event bus so tabs get registered
         CREATIVE_MODE_TABS.register(modEventBus);
 
@@ -535,6 +554,12 @@ public static void registerLayerDefinitions(EntityRenderersEvent.RegisterLayerDe
             event.registerLayerDefinition(ClientRegistryHandler.FEMALE_SHOPKEEPER, FemaleShopkeeperModel::createMesh);
         }
 
+        @OnlyIn(Dist.CLIENT)
+        @SubscribeEvent
+        public static void onRegisterRenderers(EntityRenderersEvent.RegisterRenderers event) {
+            event.registerEntityRenderer(MCTradePostMod.COIN_ENTITY_TYPE.get(), CoinRenderer::new);
+        }
+
         @SubscribeEvent
         public static void onAddLayers(EntityRenderersEvent.AddLayers event) {
             LOGGER.info("Handling model initialization");

src/main/java/com/deathfrog/mctradepost/MCTradePostMod.java

@@ -8,4 +8,5 @@ public class MCTradePostTileEntities
 
     public static DeferredHolder<BlockEntityType<?>, BlockEntityType<MCTPTileEntityColonyBuilding>> BUILDING;
 
+    public static DeferredHolder<BlockEntityType<?>, BlockEntityType<MCTPTileEntityColonyBuilding>> MARKETPLACE;
 }

src/main/java/com/deathfrog/mctradepost/api/tileentities/MCTradePostTileEntities.java

@@ -20,4 +20,8 @@ public BuildingEntry getBuildingEntry() {
         return ModBuildings.marketplace.get();
     }
 
+    public void handleRitual() {
+        
+    }
+
 }

src/main/java/com/deathfrog/mctradepost/core/blocks/huts/BlockHutMarketplace.java

@@ -1,6 +1,7 @@
 package com.deathfrog.mctradepost.core.colony.jobs.buildings.workerbuildings;
 
 import com.minecolonies.api.colony.IColony;
+import com.minecolonies.api.colony.IColonyManager;
 import com.minecolonies.api.colony.buildings.modules.settings.ISettingKey;
 import com.minecolonies.api.colony.jobs.registry.JobEntry;
 import com.minecolonies.api.crafting.IGenericRecipe;
@@ -32,10 +33,12 @@
 import com.deathfrog.mctradepost.core.client.gui.modules.WindowEconModule;
 import com.deathfrog.mctradepost.core.colony.jobs.buildings.modules.BuildingEconModule;
 import com.deathfrog.mctradepost.core.colony.jobs.buildings.modules.MCTPBuildingModules;
+import com.deathfrog.mctradepost.core.event.wishingwell.RitualData;
 import com.google.common.collect.ImmutableList;
 
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -48,6 +51,7 @@
  */
 public class BuildingMarketplace extends AbstractBuilding
 {
+    protected RitualData ritualData = new RitualData();
 
     public BuildingMarketplace(@NotNull IColony colony, BlockPos pos) {
         super(colony, pos);
@@ -109,6 +113,14 @@ public int getMaxBuildingLevel()
         return CONST_DEFAULT_MAX_BUILDING_LEVEL;
     }
 
+    /**
+     * Gets the ritual data for this marketplace, which tracks the state of wishing wells within the colony.
+     * @return the ritual data for this marketplace.
+     */
+    public RitualData getRitualData() {
+        return ritualData;
+    }
+
     @Override
     public void registerBlockPosition(@NotNull final BlockState block, @NotNull final BlockPos pos, @NotNull final Level world)
     {
@@ -209,6 +221,8 @@ public void deserializeNBT(@NotNull final HolderLookup.Provider provider, final
             displayShelfContents.put(contents.getPos(), contents);
         }
 
+        ritualData.deserializeNBT(provider, compound);
+
         syncDisplayFramesWithSavedItems();
     }
 
@@ -227,7 +241,7 @@ public ItemStack mintCoins(Player player, int coinsToMint) {
 
             BuildingEconModule econ = this.getModule(MCTPBuildingModules.ECON_MODULE);
             if (valueToRemove < econ.getTotalBalance()) {
-                coinStack = new ItemStack(MCTradePostMod.MCTP_COIN.get(), coinsToMint);
+                coinStack = new ItemStack(MCTradePostMod.MCTP_COIN_ITEM.get(), coinsToMint);
                 econ.incrementBy(WindowEconModule.CURRENT_BALANCE, -valueToRemove);
                 econ.markDirty();
             } else {
@@ -261,6 +275,33 @@ public void depositCoins(Player player, ItemStack coinsToDeposit) {
         }
     }     
 
+    /**
+     * Finds the nearest BuildingMarketplace to the given BlockPos in the given Level,
+     * assuming BlockPos is located inside a colony.
+     * 
+     * @param level the level to search in
+     * @param pos the BlockPos to search near
+     * @return the nearest BuildingMarketplace, or null if none is found
+     */
+    public static BuildingMarketplace getMarketplaceFromPos(Level level, BlockPos pos) {
+        // Check if inside a MineColonies colony
+        BuildingMarketplace closestMarketplace = null;
+        IColonyManager colonyManager = IColonyManager.getInstance();
+        IColony colony = colonyManager.getColonyByPosFromWorld(level, pos);
+        
+        if (colony != null) {
+            // Find the nearest BuildingMarketplace
+            closestMarketplace = colony.getBuildingManager()
+                .getBuildings()
+                .values()
+                .stream()
+                .filter(b -> b instanceof BuildingMarketplace)
+                .map(b -> (BuildingMarketplace) b)
+                .min(Comparator.comparingDouble(market -> market.getPosition().distSqr(pos)))
+                .orElse(null);
+        }
+        return closestMarketplace;
+    }
 
     /**
      * Serializes the NBT data for the building, including the display shelf contents.
@@ -282,6 +323,9 @@ public CompoundTag serializeNBT(@NotNull final HolderLookup.Provider provider)
         }
 
         compound.put(TAG_DISPLAYSHELVES, shelfTagList);
+
+        ritualData.serializeNBT(provider);
+
         return compound;
     }