Home Reference Source
public class | source

Life

Extends:

Initializer → Life

Sets the life property on initialized particles.

Static Method Summary

Static Public Methods
public static

fromJSON(json: object): Life

Creates a Life initializer from JSON.

Constructor Summary

Public Constructor
public

constructor(min: number, max: number, center: boolean, isEnabled: boolean): *

Constructs a Life property instance.

Member Summary

Public Members
public

The life span of the particle.

Method Summary

Public Methods
public

initialize(particle: Particle): *

Sets the particle's initial life.

Inherited Summary

From class Initializer
public static abstract

Returns a new instance of the initializer from the JSON object passed.

public static

Determines if the initializer requires a Web GL API to be provided to its constructor.

public
public

type: *

public

init(emitter: Emitter, particle: Particle): *

Initializes the property on the emitter or particle.

public abstract

initialize(target: object)

Place custom property initialization code in this method in the subclass.

public abstract

reset()

Static Public Methods

public static fromJSON(json: object): Life source

Creates a Life initializer from JSON.

Override:

Initializer#fromJSON

Params:

NameTypeAttributeDescription
json object

The JSON to construct the instance from.

json.min number

The minimum life time

json.max number

The maximum life time

json.center number

The center of the life time

json.isEnabled boolean
  • optional
  • default: true

Determines if the initializer should be enabled or not

Return:

Life

Public Constructors

public constructor(min: number, max: number, center: boolean, isEnabled: boolean): * source

Constructs a Life property instance.

Override:

Initializer#constructor

Params:

NameTypeAttributeDescription
min number

The minimum life

max number

The maximum life

center boolean
  • optional

Determines whether to average the life value

isEnabled boolean
  • optional
  • default: true

Determines if the initializer should be enabled or not

Return:

*

void

Public Members

public lifePan: Span source

The life span of the particle.

Public Methods

public initialize(particle: Particle): * source

Sets the particle's initial life.

Override:

Initializer#initialize

Params:

NameTypeAttributeDescription
particle Particle

the particle to initialize the property on

Return:

*

void