Options
All
  • Public
  • Public/Protected
  • All
Menu

A particle represents one of the element emitted by a particle system. This is mainly define by its coordinates, direction, velocity and age.

Hierarchy

  • Particle

Index

Constructors

  • Creates a new instance Particle

    Parameters

    • particleSystem: ParticleSystem

      the particle system the particle belongs to

    Returns Particle

Properties

age: number

The current age of the particle.

angle: number

The current angle of the particle.

angularSpeed: number

Defines how fast is the angle changing.

cellIndex: number

Defines the cell index used by the particle to be rendered from a sprite.

color: Color4

The color of the particle.

colorStep: Color4

The color change of the particle per step.

direction: Vector3

The world direction of the particle in the scene.

id: number

Unique ID of the particle

lifeTime: number

Defines how long will the life of the particle be.

particleSystem: ParticleSystem

The particle system the particle belongs to.

position: Vector3

The world position of the particle in the scene.

remapData: Vector4

The information required to support color remapping

scale: Vector2

The current scale of the particle.

size: number

The current size of the particle.

Methods

  • Copy the properties of particle to another one.

    Parameters

    • other: Particle

      the particle to copy the information to.

    Returns void

  • updateCellIndex(): void
  • Defines how the sprite cell index is updated for the particle

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme