Class MainModule

Main module

Export

MainModule

Date

2024.3.22

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system duration flipRotation gravityModifier looping prewarm simulationSpace simulationSpeed startColor startDelay startLifetime startRotation3D startRotationX startRotationY startRotationZ startSize3D startSizeX startSizeY startSizeZ startSpeed

Accessors

enable gravityModifierMultiplier maxParticles scalingMode startDelayMultiplier startLifetimeMultiplier startRotation startRotationMultiplier startRotationXMultiplier startRotationYMultiplier startRotationZMultiplier startSize startSizeMultiplier startSizeXMultiplier startSizeYMultiplier startSizeZMultiplier startSpeedMultiplier system

Methods

_onDisable _onEnable _serialize dispose emit off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

duration

duration: number = 5.0

The duration of the particle emitter in secodns.

Memberof

MainModule

flipRotation

flipRotation: number = 0.0

Makes some particles spin in the opposite direction.

Memberof

MainModule

gravityModifier

gravityModifier: MinMaxCurve = ...

A scale that this Particle System applies to gravity.

Memberof

MainModule

looping

looping: boolean = true

Specifies whether the particle emitter loop.

Memberof

MainModule

prewarm

prewarm: boolean = false

When looping is enabled, this controls whether this particle system will look like it has already simulated for one loop when first becoming visible.

Memberof

MainModule

simulationSpace

simulationSpace: ParticleSystemSimulationSpace = ParticleSystemSimulationSpace.Local

This selects the space in which to simulate particles. It can be either world or local space.

Memberof

MainModule

simulationSpeed

simulationSpeed: number = 1.0

Override the default playback speed of the Particle System.

Memberof

MainModule

startColor

startColor: MinMaxGradient = ...

The initial color of particles when the Particle System first spawns them.

Memberof

MainModule

startDelay

startDelay: MinMaxCurve = ...

Start delay in seconds.

Memberof

MainModule

startLifetime

startLifetime: MinMaxCurve = ...

The total lifetime in seconds that each new particle has.

Memberof

MainModule

startRotation3D

startRotation3D: boolean = false

A flag to enable 3D particle rotation.

Memberof

MainModule

startRotationX

startRotationX: MinMaxCurve = ...

The initial rotation of particles around the x-axis when emitted.

Memberof

MainModule

startRotationY

startRotationY: MinMaxCurve = ...

The initial rotation of particles around the y-axis when emitted.

Memberof

MainModule

startRotationZ

startRotationZ: MinMaxCurve = ...

The initial rotation of particles around the z-axis when emitted.

Memberof

MainModule

startSize3D

startSize3D: boolean = false

A flag to enable specifying particle size individually for each axis.

Memberof

MainModule

startSizeX

startSizeX: MinMaxCurve = ...

The initial size of particles along the x-axis when the Particle System first spawns them.

Memberof

MainModule

startSizeY

startSizeY: MinMaxCurve = ...

The initial size of particles along the y-axis when the Particle System first spawns them.

Memberof

MainModule

startSizeZ

startSizeZ: MinMaxCurve = ...

The initial size of particles along the z-axis when the Particle System first spawns them.

Memberof

MainModule

startSpeed

startSpeed: MinMaxCurve = ...

The initial speed of particles when the Particle System first spawns them.

Memberof

MainModule

Accessors

enable

  • get enable(): boolean

  • Specifies whether enable the module.

    Returns boolean

    Memberof

    ParticleModule

  • set enable(value): void

  • Specifies whether enable the module.

    Parameters

    • value: boolean

    Returns void

    Memberof

    ParticleModule

gravityModifierMultiplier

  • get gravityModifierMultiplier(): number

  • Change the gravity multiplier.

    Returns number

    Memberof

    MainModule

  • set gravityModifierMultiplier(value): void

  • Change the gravity multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

maxParticles

  • get maxParticles(): number

  • Get the maximum number of particles to emit.

    Returns number

    Memberof

    MainModule

  • set maxParticles(value): void

  • Set the maximum number of particles to emit.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

scalingMode

  • get scalingMode(): ParticleSystemScalingMode

  • Control how the Particle System applies its Transform component to the particles it emits.

    Returns ParticleSystemScalingMode

    Memberof

    MainModule

  • set scalingMode(value): void

  • Control how the Particle System applies its Transform component to the particles it emits.

    Parameters

    Returns void

    Memberof

    MainModule

startDelayMultiplier

  • get startDelayMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startDelay in seconds.

    Returns number

    Memberof

    MainModule

  • set startDelayMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startDelay in seconds.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startLifetimeMultiplier

  • get startLifetimeMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startLifetime.

    Returns number

    Memberof

    MainModule

  • set startLifetimeMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startLifetime.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startRotation

  • get startRotation(): MinMaxCurve

  • The initial rotation of particles when the Particle System first spawns them.

    Returns MinMaxCurve

    Memberof

    MainModule

startRotationMultiplier

  • get startRotationMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startRotation.

    Returns number

    Memberof

    MainModule

  • set startRotationMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startRotation.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startRotationXMultiplier

  • get startRotationXMultiplier(): number

  • The initial rotation multiplier of particles around the x-axis when the Particle System first spawns them.

    Returns number

    Memberof

    MainModule

  • set startRotationXMultiplier(value): void

  • The initial rotation multiplier of particles around the x-axis when the Particle System first spawns them.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startRotationYMultiplier

  • get startRotationYMultiplier(): number

  • The initial rotation multiplier of particles around the y-axis when the Particle System first spawns them.

    Returns number

    Memberof

    MainModule

  • set startRotationYMultiplier(value): void

  • The initial rotation multiplier of particles around the y-axis when the Particle System first spawns them.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startRotationZMultiplier

  • get startRotationZMultiplier(): number

  • The initial rotation multiplier of particles around the z-axis when the Particle System first spawns them.

    Returns number

    Memberof

    MainModule

  • set startRotationZMultiplier(value): void

  • The initial rotation multiplier of particles around the z-axis when the Particle System first spawns them.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startSize

  • get startSize(): MinMaxCurve

  • The initial size of particles when the Particle System first spawns them.

    Returns MinMaxCurve

    Memberof

    MainModule

startSizeMultiplier

  • get startSizeMultiplier(): number

  • A multiplier for the initial size of particles when the Particle System first spawns them.

    Returns number

    Memberof

    MainModule

  • set startSizeMultiplier(value): void

  • A multiplier for the initial size of particles when the Particle System first spawns them.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startSizeXMultiplier

  • get startSizeXMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startSizeX.

    Returns number

    Memberof

    MainModule

  • set startSizeXMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startSizeX.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startSizeYMultiplier

  • get startSizeYMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startSizeY.

    Returns number

    Memberof

    MainModule

  • set startSizeYMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startSizeY.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startSizeZMultiplier

  • get startSizeZMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startSizeZ.

    Returns number

    Memberof

    MainModule

  • set startSizeZMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startSizeZ.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

startSpeedMultiplier

  • get startSpeedMultiplier(): number

  • A multiplier for ParticleSystem.MainModule.startSpeed.

    Returns number

    Memberof

    MainModule

  • set startSpeedMultiplier(value): void

  • A multiplier for ParticleSystem.MainModule.startSpeed.

    Parameters

    • value: number

    Returns void

    Memberof

    MainModule

system

Methods

Protected_onDisable

Protected_onEnable

  • _onEnable(): void
  • Protected

    Enable callback

    Returns void

    Memberof

    ParticleModule

Protected_serialize

  • _serialize(meta): void
  • Protected

    Serialize

    Parameters

    • meta: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

    Memberof

    MainModule

dispose

emit

  • emit(event): void

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

off

  • off(type, callback?): void

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    • type: string
    • Optionalcallback: SubscriberCallbackFn

      subscriber callback

    Returns void

    Memberof

    EventDispatcher

on

  • on(type, callback, options?): void

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

once

  • once(type, callback, options?): void

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }
      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

toJSON

  • toJSON(): {
        [key: string]: any;
    }

  • Serialize

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    Memberof

    ParticleModule

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods