Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticleEffect

UNFINISHED! Class to manage particle effects.

Hierarchy

  • ParticleEffect

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly asset

asset: ParticleEffectAsset

Protected color

color: Color = Color.empty

Protected Readonly effectName

effectName: string

Private handle

handle: number

Protected invertAxis

invertAxis: InvertAxis = ...

Protected offset

offset: Vector3 = ...

Protected range

range: number = 1.0

Protected rotation

rotation: Vector3 = ...

Protected scale

scale: number = 1.0

Accessors

AssetName

  • get AssetName(): string

  • Get the name of the particle effect asset. Same as ParticleEffect.AssetName.

    Returns string

EffectName

  • get EffectName(): string

Handle

  • get Handle(): number

InvertAxis

IsActive

  • get IsActive(): boolean

Range

  • get Range(): number
  • set Range(range: number): void

Rotation

Methods

setParameter

  • setParameter(parameterName: string, value: number): void

  • Set a paramaeter of a particle effect.

    Parameters

    • parameterName: string

      Name of parameter.

    • value: number

      Value of parameter.

    Returns void

Abstract start

  • start(): boolean

stop

  • stop(): void

toString

  • toString(): string

  • Return the particle effect as string. AssetName\EffectName.

    Returns string

Generated using TypeDoc