液体实验室

液体实验室

一个用于简化自定义流体和气体创建的流畅API。

基础库

描述

Liquid Lab 是一个流体 API,旨在简化在 Fabric 上创建自定义流体的过程,因为几乎每个流体属性都是硬编码的。其功能包括设置雾颜色、数据驱动的混合行为,以及向上流动的自定义气态流体。该 API 的存在是为了制作高质量的流体,而不仅仅是换皮的水或岩浆。

功能

基础流体更改

为基类 Fluid 添加了大量实用方法

实体溅射

  • 通过 onEntityEntry 实现
  • 当实体首次接触流体时调用
  • 参数:
    • 实体所在的世界
    • 接触流体的实体

实体交互

  • 通过 onEntityCollision 实现
  • 当实体处于流体内部时调用
  • 参数:
    • 实体所在的世界
    • 流体的方块位置
    • 处于流体内部的实体

实体粘性

  • 通过 getFluidMotion 实现
  • 用于流体的推力和粘性
  • 参数:
    • 实体所在的世界
  • 返回一个 FluidMotion 对象,存储:
    • 实体的 XYZ 速度倍率
    • 流体的推力
    • 实体主动移动时的移动速度

物品粘性

  • 通过 getItemMotion 实现
  • 用于物品实体的浮力和粘性
  • 参数:
    • 实体所在的世界
  • 返回一个 FluidMotion 对象,存储:
    • 物品的 XYZ 速度倍率
    • 物品的最大垂直速度
    • 物品在流体中上升的速度

雾

  • 通过 getFogProperties 实现
  • 使流体能够拥有特殊的雾
  • 参数:
    • 实体所在的世界
    • 摄像机的位置
    • 正在观察雾的实体
  • 返回一个 FogProperties 对象,存储:
    • 雾起点的方块距离
    • 雾终点的方块距离
    • 雾的 RGB 颜色

雨滴粒子

  • 通过 getRainParticle 实现
  • 当雨落在流体上时,为流体提供独特的溅射粒子
  • 返回:
    • 流体被雨淋时使用的粒子

桶音效

  • 通过 getBucketEmptySound 实现
  • 使流体不仅拥有自定义的装填音效,还能拥有自定义的倒空音效
  • 返回:
    • 倒空桶时播放的音效

寻路

  • 通过 canPathfindThrough 实现
  • 允许流体直接标识某物是否应尝试在其内部寻路
  • 参数:
    • 实体所具有的导航类型
  • 返回:
    • 通过该流体寻路是否有效

流体标签

该 API 添加了 7 个流体标签:

  • liquid_lab:enhanced_mobility
    • 定义该流体可游泳且可冲刺游泳
  • liquid_lab:swimmable
    • 定义该流体是否可以游泳
  • liquid_lab:drowns
    • 定义该流体是否会使浸没其中的实体溺水
  • liquid_lab:evaporates
    • 定义该流体是否不能放置在下界
  • liquid_lab:fall_damage_reducing
    • 使该流体以与岩浆相同的方式影响摔落伤害
  • liquid_lab:fall_damage_resetting
    • 使该流体以与水相同的方式影响摔落伤害
  • liquid_lab:gaseous
    • 仅将该流体标记为气体,不具有任何其他功能

气态流体

此外,该 API 还添加了向上流动的反向流体。气态流体的注册方式与普通流体相同,只是方块形态使用 GasFluidBlock 创建,流体形态通过扩展 FlowableGasFluid 创建。对于渲染,请在客户端初始化器中使用 SimpleGasFluidRenderHandler,而非 SimpleFluidRenderHandler。

流体混合

提供了一个简单而灵活的系统,用于创建数据驱动的流体混合,以实现模组之间的兼容性。

文件夹结构

要添加流体混合,首先在命名空间文件夹中创建一个名为 fluid_mixing 的文件夹。此处的文件应为 JSON 文件,并命名为该命名空间的有效流体标签,才能正常运作。

文件结构

  • replace 可选。此文件是否替换该流体的所有规则
  • rules 该流体需遵循的规则列表
    • type 定义规则何时适用。可以是 on_update,即当流体被附近方块更新时应用规则;或 on_flow,即当另一种流体流入该流体时应用规则。
    • is_still 可选。该流体必须是源方块还是流动方块。如果未定义,则接受该流体的任何形态
    • smoke 可选。此交互是否产生烟雾粒子
    • predicate 交互成功所必须通过的方块谓词
    • transform 用于放置交互结果方块的方块状态提供器

方块谓词

  • 添加了 liquid_lab:touching_fluids
    • 当相邻流体匹配 fluids 参数且该流体能流入该方块时通过
  • 添加了 liquid_lab:adjacent_blocks
    • 当相邻方块匹配谓词的 blocks 参数时通过

实用工具

该 API 添加了一些简单的实用方法,使实现流体的某些方面更加简单。

流体工具

包含与流体交互相关的方法,例如 splashEntity,用于在 onEntityEntry 中轻松制作自定义溅射效果。

粒子工具

包含与注册方块泄漏粒子相关的方法。该类允许为流体和气体分别或一次性注册滴落、下落和着陆粒子。