core/com.pico.spatial.core.ecs/ParticleComponent

ParticleComponent

@MainThread

class ParticleComponent : Component

A Component that is used to play particle effects in the scene.

Particle effects, such as fireworks, explosions, and other visual effects, can be created in the Spatial Editor. When a node containing particle effects is loaded from an AssetBundle, its corresponding entity will automatically have a ParticleComponent added to it.

At runtime, you can modify the exposed properties of an existing ParticleComponent, but cannot create new instances. Neither copy construction nor manual instantiation is supported.

Properties

attractorStrength

var attractorStrength: Float

The strength of the attractor effect. Only available when isAttractorEnabled is true.

isAttractorEnabled

var isAttractorEnabled: Boolean

Whether the attractor effect is enabled.

var isEmitting: Boolean

Whether the emitter is emitting. This property is used to activate or deactivate the emitting of particles.

isVortexEnabled

var isVortexEnabled: Boolean

Whether the vortex effect is enabled.

var startColor: ParticleColorVaryingProperty

The initial color of particles at spawn.

var vortexStrength: Float

The strength of the vortex effect. Only available when isVortexEnabled is true.

Functions

open override fun clone(): Component

Creates and returns a copy of this Component instance.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String