Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticleEffectAsset

UNFINISHED! Class that represents a particle effect asset.

Hierarchy

  • ParticleEffectAsset

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly assetName

assetName: string

Accessors

Asset

  • get Asset(): string

AssetName

  • get AssetName(): string

IsLoaded

  • get IsLoaded(): boolean

Methods

markAsNoLongerNeeded

  • markAsNoLongerNeeded(): void

request

  • request(timeout: number): Promise<boolean>

  • Load a particle effect into the game memory.

    Parameters

    • timeout: number

      Max time to load Particle Effect

    Returns Promise<boolean>

Private setNextCall

  • setNextCall(): boolean

startNonLoopedAtCoord

  • startNonLoopedAtCoord(effectName: string, pos: Vector3, rot?: Vector3, scale?: number, invertAxis?: InvertAxis): boolean

  • Start a particle effect at a world position.

    Parameters

    • effectName: string

      Name of effect.

    • pos: Vector3
    • rot: Vector3 = ...

      Rotation from entity position.

    • scale: number = 1.0

      Size of the effect.

    • invertAxis: InvertAxis = ...

      Which axis to invert (default none).

    Returns boolean

startNonLoopedOnEntity

  • Start a particle effect on an entity

    Parameters

    • effectName: string

      Name of effect.

    • entity: Entity

      Entity to use effect on.

    • off: Vector3 = ...

      Offset from entity position.

    • rot: Vector3 = ...

      Rotation from entity position.

    • scale: number = 1.0

      Size of the effect.

    • invertAxis: InvertAxis = ...

      Which axis to invert (default none).

    Returns boolean

toString

  • toString(): string

Generated using TypeDoc