dot big bang

Developer API
Menu

Class ParticleSystemComponent

All
  • Public
  • Public/Protected
  • All

Hierarchy

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

drag

drag: number

dragEnabled

dragEnabled: boolean

emitterDistribution

emitterDistribution: ParticleSystemComponentEmitterDistribution

emitterShape

emitterShape: ParticleSystemComponentEmitterShape

Readonly emitterSize

emitterSize: Vector3

Readonly endColor

endColor: Color

endOpacity

endOpacity: number

endSize

endSize: number

faceCamera

faceCamera: boolean

gravityEnabled

gravityEnabled: boolean

Readonly gravityVelocity

gravityVelocity: Vector3

Readonly id

id: string

The 36-character identifier string of the Component. The id is unique within the Entity is belongs to. Currently, the same id may be used by another Component on a different Entity.

ignoreFog

ignoreFog: boolean

Whether particles are hidden when inside fog See this.game.renderer.fog for more info on fog

Readonly initialDirection

initialDirection: Euler

initialVelocity

initialVelocity: number

Readonly initialVelocitySpread

initialVelocitySpread: Euler

lifetime

lifetime: number

lifetimeVariation

lifetimeVariation: number

loop

loop: boolean

numParticles

numParticles: number

offset

offset: Vector3

The offset from the Entity origin where the particle system should be rendered. The value of the offset is expressed in the local Entity's space unit.

spawnRate

spawnRate: number

Readonly startColor

startColor: Color

startOpacity

startOpacity: number

startSize

startSize: number

systemType

systemType: ParticleSystemComponentType

Readonly type

type: ComponentType

The type of the Component.

visible

visible: boolean

Whether the particle system should be rendered or not.

visibleInDepthPass

visibleInDepthPass: boolean

Accessors

entity

  • Gets the Entity the Component is part of. This throws an exception if the Component is not in an Entity. Use the isInEntity property to test for that.

    Returns Entity

game

  • Gets the Game the Component is part of (via the Entity it belongs to). This throws an exception if the Component is not in the game. Use the isInGame property to test for that.

    Returns Game<{ saveData: SaveData<any, any> }>

isInEntity

  • get isInEntity(): boolean

  • Returns true if the Component is part of an Entity.

    Returns boolean

isInGame

  • get isInGame(): boolean

  • Returns true if the Component is part of the Game (via the Entity it belongs to).

    Returns boolean