Class ParticleEmissionMode

Controls how are particle positions on a shape chosen.

Index

Constructors

Accessors

interval speed type

Methods

markAsDirty modify

Constructors

constructor

new ParticleEmissionMode(
    type?: EnumValue<ParticleEmissionModeType>,
    speed?: number,
    interval?: number,
    isInternalConstructor?: boolean,
): ParticleEmissionMode
Parameters
- Optionaltype: EnumValue<ParticleEmissionModeType>
- Optionalspeed: number
- Optionalinterval: number
- OptionalisInternalConstructor: boolean
Returns ParticleEmissionMode

Overrides FrameworkObject.constructor

Accessors

interval

get interval(): number

Determines the minimum interval allowed between the generated particles. 0 specifies the particles can be generated anywhere on the shape.

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

speed

get speed(): number

Speed along which particle generation should move around the shape, relevant for Loop and PingPing emission modes.

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

type

get type(): EnumValue<ParticleEmissionModeType>

Type that determines general behaviour.

Returns EnumValue<ParticleEmissionModeType>
set type(value: EnumValue<ParticleEmissionModeType>): void
Parameters
- value: EnumValue<ParticleEmissionModeType>
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void