Class TextureSheetAnimationModule

Texture sheet animation module

Export

TextureSheetAnimationModule

Date

2024.4.10

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system animation frameOverTime rowMode speedRange startFrame timeMode

Accessors

cycleCount enable frameOverTimeMultiplier numTilesX numTilesY rowIndex startFrameMultiplier system

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

animation

animation: ParticleSystemAnimationType = ParticleSystemAnimationType.WholeSheet

Specifies the animation type.

Memberof

TextureSheetAnimationModule

frameOverTime

frameOverTime: MinMaxCurve = ...

A curve to control which frame of the Texture sheet animation to play.

Memberof

TextureSheetAnimationModule

rowMode

rowMode: ParticleSystemAnimationRowMode = ParticleSystemAnimationRowMode.Random

Select how particles choose which row of a Texture Sheet Animation to use.

Memberof

TextureSheetAnimationModule

speedRange

speedRange: Vector2 = ...

Specify how particle speeds are mapped to the animation frames. If a particle is travelling slower than the minimum speed, it uses the first frame. If a particle is travelling faster than the maximum speed, then it uses the final frame. For all other speeds, the particle chooses a frame based on how far between the minimum and maximum value its speed is.

Memberof

TextureSheetAnimationModule

startFrame

startFrame: MinMaxCurve = ...

Define a random starting frame for the Texture sheet animation.

Memberof

TextureSheetAnimationModule

timeMode

timeMode: ParticleSystemAnimationTimeMode = ParticleSystemAnimationTimeMode.Lifetime

Select whether the system bases the playback on mapping a curve to the lifetime of each particle, by using the particle speeds, or if playback simply uses a constant frames per second.

Memberof

TextureSheetAnimationModule

Accessors

cycleCount

  • get cycleCount(): number

  • Specifies how many times the animation loops during the lifetime of the particle.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set cycleCount(value): void

  • Specifies how many times the animation loops during the lifetime of the particle.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

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

frameOverTimeMultiplier

  • get frameOverTimeMultiplier(): number

  • The frame over time mutiplier.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set frameOverTimeMultiplier(value): void

  • The frame over time mutiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

numTilesX

  • get numTilesX(): number

  • Defines the tiling of the Texture in the x-axis.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set numTilesX(value): void

  • Defines the tiling of the Texture in the x-axis.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

numTilesY

  • get numTilesY(): number

  • Defines the tiling of the Texture in the y-axis.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set numTilesY(value): void

  • Defines the tiling of the Texture in the y-axis.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

rowIndex

  • get rowIndex(): number

  • Explicitly select which row of the Texture sheet to use.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set rowIndex(value): void

  • Explicitly select which row of the Texture sheet to use.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

startFrameMultiplier

  • get startFrameMultiplier(): number

  • The starting frame multiplier.

    Returns number

    Memberof

    TextureSheetAnimationModule

  • set startFrameMultiplier(value): void

  • The starting frame multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    TextureSheetAnimationModule

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

    TextureSheetAnimationModule

dispose

emit

  • emit(event): void

  • Emit event

    Parameters

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

    Returns void

    Memberof

    EventDispatcher

fromJSON

  • fromJSON(json): void

  • Deserialize

    Parameters

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

    Returns void

    Memberof

    TextureSheetAnimationModule

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