ParticleHelper

This class is made for on one-liner static method to help creating particle system set.

Hierarchy

  • ParticleHelper

Index

Properties

Static BaseAssetsUrl

Find examples in Playground
BaseAssetsUrl: string

Gets or sets base Assets URL

Methods

Static CreateAsync

Find examples in Playground
  • This is the main static method (one-liner) of this helper to create different particle systems

    Parameters

    • type: string

      This string represents the type to the particle system to create

    • scene: Nullable<Scene>

      The scene where the particle system should live

    • Optional gpu: boolean

      If the system will use gpu

    Returns Promise<ParticleSystemSet>

    the ParticleSystemSet created

Static CreateDefault

Find examples in Playground
  • Create a default particle system that you can tweak

    Parameters

    • emitter: Nullable<AbstractMesh | Vector3>

      defines the emitter to use

    • Optional capacity: number

      defines the system capacity (default is 500 particles)

    • Optional scene: Scene

      defines the hosting scene

    • Optional useGPU: boolean

      defines if a GPUParticleSystem must be created (default is false)

    Returns IParticleSystem

    the new Particle system

Static ExportSet

Find examples in Playground
  • Static function used to export a particle system to a ParticleSystemSet variable. Please note that the emitter shape is not exported

    Parameters

    Returns ParticleSystemSet

    the created particle system set

Generated using TypeDoc