HytaleDocs
ItemBlock

FluidFX

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

Parent

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

When inheriting from another FluidFX 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

Fog

Type information:

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

NameDescription
"Color"
"ColorLight"
"EnvironmentTint"

FogColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

FogDistance

Type information: (Nullable) Array of Number

FogDepthStart

Type information: Number defaults to: 40.0

FogDepthFalloff

Type information: Number defaults to: 10.0

ColorsSaturation

Type information: Number defaults to: 1.0

ColorsFilter

Type information: (Nullable) Array of Number

DistortionAmplitude

Type information: Number defaults to: 8.0

DistortionFrequency

Type information: Number defaults to: 4.0

Particle

Type information:

(Nullable) Particle System that can be spawned in relation to a fluid.

FluidParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

The id of the particle system.

Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

The colour used if none was specified in the particle settings.

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

The scale of the particle system.

MovementSettings

Type information:

(Nullable)

FluidFXMovementSettings with the following properties:

KeyTypeDescription
SwimUpSpeedNumber defaults to: 0.0
SwimDownSpeedNumber defaults to: 0.0
SinkSpeedNumber defaults to: 0.0
HorizontalSpeedMultiplierNumber defaults to: 0.0
FieldOfViewMultiplierNumber defaults to: 0.0
EntryVelocityMultiplierNumber defaults to: 0.0

On this page