Proper Fluid Handling

[ChampionAsh5357 183]

We currently have the ability to add fluids to all entities, but no real system to handle the fluid itself. Specifically, I will be talking about the associated physics as the client side effects are simply just fluid checks with events. The relevant common code effects can also be matched using the many provided events added by Forge. There are a few places where relevant tagged data would need to be check for custom fluid handling, but its less important for the purposes of this post.

 

To make a minimum viable fluid with unique physics, one must apply two methods provided within the entity: Entity#handleFluidAcceleration which does exactly what it says and Entity#func_233571_b_ which grabs where the entities eyes are within the fluid level. Both of these are used in different places. The first is used within the entity tick via Entity#func_233566_aG_.  The second is used to determine if the user might be jumping off the ground within a fluid, moving through fluid, swimming in fluid, etc.

 

Exposing this would result in some class object or registry that would store the associated fluid tag, a function given the entity and returning the acceleration, a consumer containing the entity if the fluid acceleration returns true to update a specific state. The fluid code would also need to be patched within LivingEntity#livingTick to check the tags for the correct fluid the entity is in when jumping and whether or not entities can swim within it.

 

I want to discuss what would be the optimal way of storing and handling these instances. Creating an event is out of the question as its unnecessary ticks for a portion of the code that can be handled with a registry. It would also be good to consider fluids in some sort of dynamic context where existing hardcoded traits could be genericized in some fashion. However, most of this code dances in the realm of tags, so there would need to be some discussion on how to handle and comply with Forge's stance on tags.

[Zekrom_64 0]

I think this is a needed feature, the only mod I've seen so far with correct fluid physics was Create and it did so by registering all of its fluids as "minecraft:fluid/water" which had a ton of side-effects.

 

Would some of this fit in the FluidAttributes class that modded fluids need anyway? It could have properties such as acceleration or a custom physics flag. If mods need dynamic acceleration based on an entity there could be methods to override like how water does with FluidAttributes#getColor. Patching the Entity code might be complicated though, the existing #handleFluidAcceleration method only takes a fluid tag and a fixed acceleration value.