Class ParticleEmissionOptions

ParticleEmissionOptions represents information about a manually triggered particle emission burst. The different fields represent properties of the generated particles that can be overriden or adjusted for this burst.

Index

Constructors

constructor

new ParticleEmissionOptions(
    targetEmitter?: ParticleEmitter,
    preserveShapePosition?: boolean,
    isWorldPosition?: boolean,
    position?: Immutable<Vector3>,
    color?: Immutable<SRGBColor>,
    lifetime?: number,
    size?: number,
    size3D?: Immutable<Vector3>,
    speed?: number,
    velocity?: Immutable<Vector3>,
    flipProbabilityU?: number,
    flipProbabilityV?: number,
    rotation?: number,
    rotation3D?: Immutable<Vector3>,
    seed?: number,
): ParticleEmissionOptions
Parameters
- OptionaltargetEmitter: ParticleEmitter
- OptionalpreserveShapePosition: boolean
- OptionalisWorldPosition: boolean
- Optionalposition: Immutable<Vector3>
- Optionalcolor: Immutable<SRGBColor>
- Optionallifetime: number
- Optionalsize: number
- Optionalsize3D: Immutable<Vector3>
- Optionalspeed: number
- Optionalvelocity: Immutable<Vector3>
- OptionalflipProbabilityU: number
- OptionalflipProbabilityV: number
- Optionalrotation: number
- Optionalrotation3D: Immutable<Vector3>
- Optionalseed: number
Returns ParticleEmissionOptions

Properties

`Protected` `Optional`_color

_color?: SRGBColor

`Protected` `Optional`_flipProbabilityU

_flipProbabilityU?: number

`Protected` `Optional`_flipProbabilityV

_flipProbabilityV?: number

`Protected`_isWorldPosition

_isWorldPosition: boolean

`Protected` `Optional`_lifetime

_lifetime?: number

`Protected` `Optional`_position

_position?: Vector3

`Protected`_preserveShapePosition

_preserveShapePosition: boolean

`Protected` `Optional`_rotation

_rotation?: number

`Protected` `Optional`_rotation3D

_rotation3D?: Vector3

`Protected` `Optional`_seed

_seed?: number

`Protected` `Optional`_size

_size?: number

`Protected` `Optional`_size3D

_size3D?: Vector3

`Protected` `Optional`_speed

_speed?: number

`Protected`_targetEmitter

_targetEmitter: ParticleEmitter

`Protected` `Optional`_velocity

_velocity?: Vector3

Accessors

color

get color(): SRGBColor

Optional color override for the emitted particle.

Returns SRGBColor
set color(value: Immutable<SRGBColor>): void
Parameters
- value: Immutable<SRGBColor>
Returns void

flipProbabilityU

get flipProbabilityU(): number

Optional U texture coordinate flip probability for the emitted particle.

Returns number
set flipProbabilityU(value: number): void
Parameters
- value: number
Returns void

flipProbabilityV

get flipProbabilityV(): number

Optional V texture coordinate flip probability for the emitted particle.

Returns number
set flipProbabilityV(value: number): void
Parameters
- value: number
Returns void

isWorldPosition

get isWorldPosition(): boolean

When enabled, the world position is assumed to be specified in world space.

Returns boolean
set isWorldPosition(value: boolean): void
Parameters
- value: boolean
Returns void

lifetime

get lifetime(): number

Optional lifetime override for the emitted particle, in seconds.

Returns number
set lifetime(value: number): void
Parameters
- value: number
Returns void

position

get position(): Vector3

Optional position of the emitted particle. If PreserveShapePosition is enabled, the relative position of the particle in the shape will be preserved.

Returns Vector3
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

preserveShapePosition

get preserveShapePosition(): boolean

When enabled, the relative position of the emitted particle within the shape will be preserved.

Returns boolean
set preserveShapePosition(value: boolean): void
Parameters
- value: boolean
Returns void

rotation

get rotation(): number

Optional rotation override for the emitted particle, in degrees.

Returns number
set rotation(value: number): void
Parameters
- value: number
Returns void

rotation3D

get rotation3D(): Vector3

Optional 3D rotation override for the emitted particle, in degrees.

Returns Vector3
set rotation3D(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

seed

get seed(): number

Optional random seed for the emitted particle.

Returns number
set seed(value: number): void
Parameters
- value: number
Returns void

size

get size(): number

Optional size override for the emitted particle.

Returns number
set size(value: number): void
Parameters
- value: number
Returns void

size3D

get size3D(): Vector3

Optional size override for the emitted particle.

Returns Vector3
set size3D(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

speed

get speed(): number

Optional speed override for the emitted particle, in meters.

Returns number
set speed(value: number): void
Parameters
- value: number
Returns void

targetEmitter

get targetEmitter(): ParticleEmitter

The targeted emitter. If not set, all emitters on the particle system will emit Particles.

Returns ParticleEmitter
set targetEmitter(value: ParticleEmitter): void
Parameters
- value: ParticleEmitter
Returns void

velocity

get velocity(): Vector3

Optional velocity override for the emitted particle, in meters/second.

Returns Vector3
set velocity(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

assign(other: Immutable<ParticleEmissionOptions>): ParticleEmissionOptions
Copies all properties defined by the prototype of ParticleEmissionOptions from other to this instance.
Parameters
- other: Immutable<ParticleEmissionOptions>
Returns ParticleEmissionOptions

clone

clone(): ParticleEmissionOptions

Clones this instance and returns a new ParticleEmissionOptions with identical values.

Returns ParticleEmissionOptions

isEqual

isEqual(
this: Immutable<ParticleEmissionOptions>,
other: Immutable<ParticleEmissionOptions>,
): boolean
Determines if this ParticleEmissionOptions instance is equal to the other instance.
Parameters
- this: Immutable<ParticleEmissionOptions>
- other: Immutable<ParticleEmissionOptions>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ParticleEmissionOptions>,
rhs: Immutable<ParticleEmissionOptions>,
): boolean
Determines if both ParticleEmissionOptions instances are equal.
Parameters
- lhs: Immutable<ParticleEmissionOptions>
- rhs: Immutable<ParticleEmissionOptions>
Returns boolean

Class ParticleEmissionOptions

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ParticleEmissionOptions

Properties

Protected Optional_color

Protected Optional_flipProbabilityU

Protected Optional_flipProbabilityV

Protected_isWorldPosition

Protected Optional_lifetime

Protected Optional_position

Protected_preserveShapePosition

Protected Optional_rotation

Protected Optional_rotation3D

Protected Optional_seed

Protected Optional_size

Protected Optional_size3D

Protected Optional_speed

Protected_targetEmitter

Protected Optional_velocity

Accessors

color

Returns SRGBColor

Parameters

Returns void

flipProbabilityU

Returns number

Parameters

Returns void

flipProbabilityV

Returns number

Parameters

Returns void

isWorldPosition

Returns boolean

Parameters

Returns void

lifetime

Returns number

Parameters

Returns void

position

Returns Vector3

Parameters

Returns void

preserveShapePosition

Returns boolean

Parameters

Returns void

rotation

Returns number

Parameters

Returns void

rotation3D

Returns Vector3

Parameters

Returns void

seed

Returns number

Parameters

Returns void

size

Returns number

Parameters

Returns void

size3D

Returns Vector3

Parameters

Returns void

speed

Returns number

Parameters

Returns void

targetEmitter

`Protected` `Optional`_color

`Protected` `Optional`_flipProbabilityU

`Protected` `Optional`_flipProbabilityV

`Protected`_isWorldPosition

`Protected` `Optional`_lifetime

`Protected` `Optional`_position

`Protected`_preserveShapePosition

`Protected` `Optional`_rotation

`Protected` `Optional`_rotation3D

`Protected` `Optional`_seed

`Protected` `Optional`_size

`Protected` `Optional`_size3D

`Protected` `Optional`_speed

`Protected`_targetEmitter

`Protected` `Optional`_velocity

`Static`isEqual