HytaleDocs
ItemBlock

Fluids

Asset path: Server/Item/Block/Fluids/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another Fluid most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

MaxFluidLevel

Type information: Integer defaults to: 8

Textures

Type information:

(Nullable) Array of the type:

BlockTypeTextures with the following properties:

KeyTypeDescription
All(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Sides(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
UpDown(Nullable) String

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Up(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
Down(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
North(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
South(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
West(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
East(Nullable) String defaults to: BlockTextures/Unknown.png

Reference to a common asset in the folders:

  • Common/Blocks/
  • Common/BlockTextures/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
  • Common/VFX/
with the extension: *.png
WeightInteger defaults to: 1

Effect

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"None"
"Wind"
"WindAttached"
"WindRandom"
"WindFractal"
"Ice"
"Water"
"Lava"
"Slime"
"Ripple"

DrawType

Type information:

Any one of the following String (defaults to Liquid):

NameDescription
"None"
"Liquid"

Opacity

Type information:

Any one of the following String (defaults to Solid):

NameDescription
"Solid"
"Semitransparent"
"Cutout"
"Transparent"

RequiresAlphaBlending

Type information: Boolean defaults to: true

FluidFXId

Type information: (Nullable) String defaults to: Empty

Reference to a FluidFX asset

Particles

The particles defined here will be spawned on top of fluids of this type placed in the world.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartAny one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

Ticker

Type information:

(Nullable) Any of these:

Key: TypeType
default case: Default
DefaultFluidTicker

DefaultFluidTicker with the following properties:

KeyTypeDescription
Type(Nullable) String

This field controls the type, it must be set to the constant value "Default" to function as this type.

FlowRate(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

The tick frequency for this fluid type, in seconds

CanDemoteBoolean defaults to: true

If false then the fluid will stay at its level

SupportedBy(Nullable) String
SpreadFluid(Nullable) String

Reference to a Fluid asset

Collisions(Nullable) Map

Defines what happens when this fluid tries to spread into another fluid

Finite
FiniteFluidTicker

FiniteFluidTicker with the following properties:

KeyTypeDescription
TypeConstant value: Finite

This field controls the type, it must be set to the constant value "Finite" to function as this type.

FlowRate(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

The tick frequency for this fluid type, in seconds

CanDemoteBoolean defaults to: true

If false then the fluid will stay at its level

SupportedBy(Nullable) String
Fire
FireFluidTicker

FireFluidTicker with the following properties:

KeyTypeDescription
TypeConstant value: Fire

This field controls the type, it must be set to the constant value "Fire" to function as this type.

FlowRate(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

The tick frequency for this fluid type, in seconds

CanDemoteBoolean defaults to: true

If false then the fluid will stay at its level

SupportedBy(Nullable) String
SpreadFluid(Nullable) String

Reference to a Fluid asset

Flammability(Nullable) Array of the type: FlammabilityConfig

Defines flammability configs per tag pattern

Light

Type information:

(Nullable)

ColorLight with the following properties:

KeyTypeDescription
Color(Nullable) A color the form:

#RGB

RadiusInteger defaults to: 0

DamageToEntities

Type information: Integer defaults to: 0

BlockParticleSetId

The block particle set defined here defines which particles should be spawned when an entity interacts with this block (like when stepping on it for example

Type information: (Nullable) String

Reference to a BlockParticleSet asset

ParticleColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

BlockSoundSetId

Sets the BlockSoundSet that will be used for this block for various events e.g. placement, breaking

Type information: (Nullable) String defaults to: EMPTY

Reference to a BlockSoundSet asset

Interactions

Type information:

(Nullable) Map of the following:

KeyTypeDescription
PrimaryEither String or RootInteraction

Reference to a RootInteraction asset

SecondaryEither String or RootInteraction

Reference to a RootInteraction asset

Ability1Either String or RootInteraction

Reference to a RootInteraction asset

Ability2Either String or RootInteraction

Reference to a RootInteraction asset

Ability3Either String or RootInteraction

Reference to a RootInteraction asset

Ability4Either String or RootInteraction

Reference to a RootInteraction asset

UseEither String or RootInteraction

Reference to a RootInteraction asset

PickEither String or RootInteraction

Reference to a RootInteraction asset

PickupEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEnterEither String or RootInteraction

Reference to a RootInteraction asset

CollisionLeaveEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEither String or RootInteraction

Reference to a RootInteraction asset

EntityStatEffectEither String or RootInteraction

Reference to a RootInteraction asset

SwapToEither String or RootInteraction

Reference to a RootInteraction asset

SwapFromEither String or RootInteraction

Reference to a RootInteraction asset

DeathEither String or RootInteraction

Reference to a RootInteraction asset

WieldingEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileSpawnEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileHitEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileMissEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileBounceEither String or RootInteraction

Reference to a RootInteraction asset

HeldEither String or RootInteraction

Reference to a RootInteraction asset

HeldOffhandEither String or RootInteraction

Reference to a RootInteraction asset

EquippedEither String or RootInteraction

Reference to a RootInteraction asset

DodgeEither String or RootInteraction

Reference to a RootInteraction asset

GameModeSwapEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakImpactEither String or RootInteraction

Reference to a RootInteraction asset

Notes:

Types referenced by this type

Map

(Nullable) Map of the following:

KeyType
any String
FluidCollisionConfig

FluidCollisionConfig with the following properties:

KeyTypeDescription
BlockToPlace(Nullable) String

The block to place when a collision occurs

SoundEvent(Nullable) String

Reference to a SoundEvent asset

PlaceFluidBoolean defaults to: false

Whether to still place the fluid on collision

On this page