feat: Advanced Fluid Interaction

[null2264]

This PR not only introduced "advanced custom generator", but also reworked how the mod handles fluid interaction as a whole to make it more compatible with most mods that control fluid interaction since it will only cancel the original function on success and doesn't directly touch how Minecraft handle fluid interactions.

Planned to be released for v4.0.

Features

Advanced Generators

This will allow players (and modpack makers) to create a custom generator with custom fluids or blocks

{
    // You can disable advanced generators by setting it like this:
    // advanced: {}
    //
    // Or just delete it entirely.

    "advanced": {
        // This is the fluid that will touch another fluid (in this example, it's lava touching water)
        "minecraft:lava": {
            "minecraft:water": {  // For this example, we mimic cobblestone/stone generator's behaviour
                // Result format is similar to custom generators' format
                "results": {  // Mimic cobblestone generator
                    "*": [  // Unlike custom generators' format, wildcard is supported as a modifier (accept any block)
                        {
                            "id": "minecraft:cobblestone",
                            "weight": 100.0
                        }
                    ]
                },
                // Only triggered when lava touch water from the top
                "resultsFromTop": {  // Mimic stone generator, only works for fluids
                    "*": [
                        {
                            "id": "minecraft:stone",
                            "weight": 100.0
                        }
                    ]
                }
            },
            "b:minecraft:blue_ice": {  // Mimic basalt generator's behaviour
                "results": {  // Blocks only support "results"
                    "minecraft:soul_soil": [
                        {
                            "id": "minecraft:basalt",
                            "weight": 100.0
                        }
                    ]
                }
            },
            "create:honey": {
                "silent": true,  // This will prevent generator from making the extinguish sound effect when block is generated
                "results": {
                    "*": [
                        {
                            "id": "create:limestone",
                            "weight": 100.0
                        }
                    ]
                }
            }
        }
    }
}

Fluid Interaction API

This is mainly for mod developers. With this developers can now create a plugin for CobbleGen, and register a fluid interaction more easily.

To make one, you need to create a class that implements CobbleGenPlugin, for example:

public class CreateFluidInteraction implements CobbleGenPlugin
{
    public void registerInteraction() {
        if (!FabricLoader.getInstance().isModLoaded("create")) return;
        FLUID_INTERACTION.addGenerator(
                Fluids.LAVA,
                new CobbleGenerator(List.of(new WeightedBlock("create:limestone", 1.0)),
                                    AllFluids.HONEY.get(),
                                    false
                )
        );
        FLUID_INTERACTION.addGenerator(
                Fluids.LAVA,
                new CobbleGenerator(List.of(new WeightedBlock("create:scoria", 1.0)),
                                    AllFluids.CHOCOLATE.get(),
                                    false
                )
        );
    }
}

Then add your plugin location to a cobblegen_plugin entrypoint in fabric.mod.json, for example:

  "entrypoints": {
    "cobblegen_plugin": [
      "io.github.null2264.cobblegen.integration.create.CreateFluidInteraction"
    ]
  },

Checklist

• Fluid Interaction API
  This should make CobbleGen more compatible with most mods that control fluid interactions
  • Make other generators use this API
  • Implement Advanced Custom Generator
• Testing
  • Without Create/Porting Lib
    • 1.18.2
    • 1.19.2
  • With Create/Porting Lib
    • 1.18.2
    • 1.19.2

[DemonSlayer112]

This looks amazing! :D
I assume if we wanted a basalt gen to work with only 1 block, like soul sand only, we would specifiy "blue_ice" as being "air"?

And if we did do this, how would the mod treat a normal basalt gen(lava near soulsoil and ice) apart from lava(near just....a soulsoil and air for instance)?

also for a little fun for people air is a outputable block xD
Ig this is amazing for farm testing

[null2264]

I assume if we wanted a basalt gen to work with only 1 block, like soul sand only, we would specifiy "blue_ice" as being "air"?

Correct

And if we did do this, how would the mod treat a normal basalt gen(lava near soulsoil and ice) apart from lava(near just....a soulsoil and air for instance)?

Because of how the mod is coded, it'll probably overwrite normal basalt gen unless you surround the generated block with blocks other than air and a blue ice.

Here's a working build for testing.
cobblegen.zip