Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Accessors

id

  • get id(): number
  • Returns the numerical ID of the target Entity type.

    Returns number

Methods

Static addPlacedAbsolutePosition

  • Add* a placed particle effect from a template to the target entity at the given offset position and a rotation.

    Parameters

    Returns void

Static addPlacedLineAutoscale

  • Add* a placed particle effect from a template to the target entity. Line of the effect scales automatically.

    Parameters

    Returns void

Static addPlacedVolumeAutoscale

  • Add* a placed particle effect from a template to the target entity. Volume of the effect scales automatically.

    Parameters

    Returns void

Static addWornAbsolutePosition

Static addWornLineAutoscale

  • Add* a worn particle effect from a template to the target entity. Line of the effect scales automatically.

    Parameters

    Returns void

Static addWornVolumeAutoscale

  • Add* a worn particle effect from a template to the target entity's animation bone. Volume of the effect scales automatically.

    Parameters

    Returns void

Static enable

  • enable(entity: YEntity, id: string, enable: boolean): void
  • **Enable/**disable a particle effect on the target entity. Select the string ID for the target particle effect.

    Parameters

    • entity: YEntity
    • id: string
    • enable: boolean

    Returns void

Static get

Static isEnabled

  • isEnabled(entity: YEntity, id: string): boolean
  • Returns whether the target entity has the selected particle effect active. Select the string ID for the target particle effect.

    Parameters

    Returns boolean

Static play

Static remove

  • remove(entity: YEntity, id: string, immediately: boolean): void
  • Removes a worn particle effect from the target entity. Select the string ID for the target particle effect.

    Parameters

    • entity: YEntity
    • id: string
    • immediately: boolean

    Returns void

Generated using TypeDoc