Class Life

Sets the life property on initialized particles.

Hierarchy

default
- Life

Index

Constructors

Properties

isEnabled lifePan type

Methods

init initialize reset fromJSON requiresWebGlApi

Constructors

constructor

new Life(
    min?: number,
    max?: number,
    center?: boolean,
    isEnabled?: boolean,
): Life
Constructs a Life property instance.
Parameters
- Optionalmin: number
  The minimum life
- Optionalmax: number
  The maximum life
- Optionalcenter: boolean
  Determines whether to average the life value
- isEnabled: boolean = true
  Determines if the initializer should be enabled or not
Returns Life
Overrides Initializer.constructor
- Defined in src/initializer/Life.ts:28

Properties

isEnabled

isEnabled: boolean

lifePan

lifePan: Span<number>

type

type: string

Methods

init

init(emitter: Emitter, particle?: Particle): void
Initializes the property on the emitter or particle.
Parameters
- emitter: Emitter
- Optionalparticle: Particle
Returns void
Inherited from Initializer.init
- Defined in src/initializer/Initializer.ts:25

initialize

initialize(particle: Particle): void
Sets the particle's initial life.
Parameters
- particle: Particle
  the particle to initialize the property on
Returns void
Overrides Initializer.initialize
- Defined in src/initializer/Life.ts:47

`Abstract`reset

reset(): void
Returns void
Inherited from Initializer.reset
- Defined in src/initializer/Initializer.ts:42

`Static`fromJSON

fromJSON(json: LifeJSON): Life
Creates a Life initializer from JSON.
Parameters
- json: LifeJSON
  The JSON to construct the instance from.
Returns Life
Overrides Initializer.fromJSON
- Defined in src/initializer/Life.ts:60

`Static`requiresWebGlApi

requiresWebGlApi(): boolean
Determines if the initializer requires a WebGL API to be provided to its constructor.

Returns boolean
Inherited from Initializer.requiresWebGlApi
- Defined in src/initializer/Initializer.ts:55