Class ParticleBurst

constructor

• new ParticleBurst(): ParticleBurst

• Returns ParticleBurst

• new ParticleBurst(time, count, cycles?, interval?, isInternalConstructor?): ParticleBurst

• Parameters

  • time: number
  • count: FloatDistribution
  • Optionalcycles: number
  • Optionalinterval: number
  • OptionalisInternalConstructor: boolean

  Returns ParticleBurst

count

• get count(): FloatDistribution

• Number of particles to emit when the burst triggers.

  Returns FloatDistribution
• set count(value): void

• Parameters

  • value: number | CompoundAnimationCurve | FloatDistribution

  Returns void

cycles

• get cycles(): number

• Determines how many times to trigger the burst. If 0 the burst will trigger infinitely. Use Interval to to control the time between each cycle.

  Returns number
• set cycles(value): void

• Parameters

  • value: number

  Returns void

interval

• get interval(): number

• Controls how much time needs to pass before triggering another burst cycle, in seconds.

  Returns number
• set interval(value): void

• Parameters

  • value: number

  Returns void

time

• get time(): number

• Time at which to trigger the burst, in seconds.

  Returns number
• set time(value): void

• Parameters

  • value: number

  Returns void

markAsDirty

• markAsDirty(dirtyFlags): void

• Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action): 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.

    • • (): void

      • Returns void

  Returns void

ReadonlyonDirty