HytaleDocs

Particles (ParticleSystem)

Asset path: Server/Particles/*.particlesystem

Parent

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

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

Spawners

A list of all the ParticleSpawners used in this System.

Max Entries: 255

Type information:

Array of the type:

ParticleSpawnerGroup with the following properties:

KeyTypeDescription
SpawnerId(Nullable) String

Reference to a ParticleSpawner asset

The id of the used Spawner.

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)$

Offsets the centre of the spawner from the centre of the system.

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)$

Rotates the Spawner.

FixedRotationBoolean defaults to: false

If checked, the spawner won't rotate with the system (the system rotates with its anchor (model, block, item, etc.)).

SpawnRate(Nullable)
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

Defines how many spawners get created per second.

If TotalSpawners is 1 (the default), this value is ignored and the single spawner is created immediately.

Please note that TotalSpawners is at default 1, so you'll need to increase it for more spawners.

LifeSpan(Nullable)
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

Defines how long a spawner lasts.

Please note that LifeSpan defined in the spawner may be lower.

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

Defines how many seconds to wait until creating the first spawner.

WaveDelay(Nullable)
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

Defines the interval in seconds between the burst of spawners.

Please note that a spawner only disappears when all its particles are gone, so the interval may get stretched.

TotalSpawnersInteger defaults to: 1

The amount of spawners that can get spawned at maximum throughout the lifetime of this system.

MaxConcurrentInteger defaults to: 0

Defines how many created spawners can be present at the same time. Only used when SpawnRate is defined.

The client caps this value at 10.

InitialVelocity(Nullable)
InitialVelocity

InitialVelocity with the following properties:

KeyTypeDescription
Yaw(Nullable) Rangef

Defines the rotation around the y-Axis.

Pitch(Nullable) Rangef

Defines the rotation around the x-Axis.

0 / 180 > at the same height as its origin

Down < - 90 + > Up

Speed(Nullable) Rangef

Defines the starting speed in the direction set by Yaw and Pitch.

Defines in what direction the spawner moves upon creation.

Please note that the velocity can be affected by Attractors.

EmitOffset(Nullable)
RangeVector3f

RangeVector3f with the following properties:

KeyTypeDescription
X(Nullable) Rangef
Y(Nullable) Rangef
Z(Nullable) Rangef

Defines in what region the spawners can be created around the ParticleSystem centre. If it contains:

  • only 1 range, the spawners will always get created in a line.
  • 2 ranges, the spawners will get created in a circle. E.g. rings can be created with this.
  • all 3 ranges, the spawners will get created inside a sphere. This shape can be hollowed out in the inside via the Min values.
Attractors(Nullable) Array of the type: ParticleAttractor

A list of attractors to control the motion of the spawners over time.

LifeSpan

How long this System lasts in seconds.

Values of 0 or below mean unlimited.

Type information:

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

CullDistance

How far away the system still renders.

Default: 40.

Values below 1 fall back to the default.

Type information:

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

BoundingRadius

The radius of the sphere used for the visibility checks (CullDistance, field of vision and occlusion).

Default: 10.

Values below 1 fall back to the default.

Type information:

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

IsImportant

If checked, the system still renders when it is outside the player's field of vision, beyond the CullDistance or occluded.

Type information: Boolean defaults to: false

On this page