Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PluginStateAnimation<P, S>

Type parameters

  • P = any

  • S = any

Hierarchy

  • PluginStateAnimation

Index

Properties

Methods

Properties

Readonly display

display: { description?: string; name: string }

Type declaration

  • Optional Readonly description?: string
  • Readonly name: string

Optional Readonly isExportable

isExportable?: boolean

name

name: string

Optional stateSerialization

stateSerialization?: { fromJSON: any; toJSON: any }

The state must be serializable to JSON. If JSON.stringify is not enough, custom converted to an object that works with JSON.stringify can be provided.

Type declaration

  • fromJSON:function
    • fromJSON(data: any): S

    • Parameters

      • data: any

      Returns S

  • toJSON:function
    • toJSON(state: S): any

    • Parameters

      • state: S

      Returns any

Methods

apply

Optional canApply

  • Parameters

    Returns CanApply

Optional getDuration

  • Parameters

    Returns Duration

initialState

  • Parameters

    Returns S

params

Optional setup

  • setup(params: P, state: S, ctx: PluginContext): void | Promise<void> | Promise<S>

  • Parameters

    Returns void | Promise<void> | Promise<S>

Optional teardown

  • teardown(params: P, state: S, ctx: PluginContext): void | Promise<void>

  • Parameters

    Returns void | Promise<void>

Generated using TypeDoc