Class TokenRing

constructor

• new TokenRing(token): TokenRing

• A TokenRing is constructed by providing a reference to a Token object.

  Parameters

  • token: Token

  Returns TokenRing

ringName

bkgName

ringUVs

bkgUVs

ringColorLittleEndian

bkgColorLittleEndian

defaultRingColorLittleEndian

defaultBackgroundColorLittleEndian

effects

scaleCorrection

scaleAdjustmentX

scaleAdjustmentY

subjectScaleAdjustment

textureScaleAdjustment

colorBand

Static effects

Static baseTexture

Static texturesData

Static tokenRingSamplerShader

token

• get token(): any

• Reference to the token that should be animated.

  Returns any

Static initialized

• get initialized(): boolean

• Is the token rings framework enabled? Will be null if the system hasn't initialized yet.

  Returns boolean

configure

• configure(mesh?): void

• Configure the sprite mesh.

  Parameters

  • Optional mesh: PrimarySpriteMesh

    The mesh to which TokenRing functionality is configured.

  Returns void

clear

• clear(): void

• Clear configuration pertaining to token ring from the mesh.

  Returns void

configureSize

• configureSize(): void

• Configure token ring size.

  Returns void

configureVisuals

• configureVisuals(): void

• Configure the token ring visuals properties.

  Returns void

flashColor

• flashColor(color, animationOptions?): Promise<boolean | void>

• Flash the ring briefly with a certain color.

  Parameters

  • color: typeof Color

    Color to flash.
  • animationOptions: CanvasAnimationOptions = {}

    Options to customize the animation.

  Returns Promise<boolean | void>

Static initialize

• initialize(): void

• Initialize the Token Rings system, registering the batch plugin and patching PrimaryCanvasGroup#addToken.

  Returns void

Static createAssetsUVs

• createAssetsUVs(): void

• Create texture UVs for each asset into the token rings sprite sheet.

  Returns void

Static getTextureUVs

• getTextureUVs(name, scaleCorrection?): Float32Array

• Get the UVs array for a given texture name and scale correction.

  Parameters

  • name: string

    Name of the texture we want to get UVs.
  • Optional scaleCorrection: number = 1

    The scale correction applied to UVs.

  Returns Float32Array

Static getRingDataBySize

• getRingDataBySize(size): {
      bkgName: string;
      ringName: string;
      colorBand: RingColorBand;
  }

• Get ring and background names for a given size.

  Parameters

  • size: number

    The size to match (grid size dimension)

  Returns {
      bkgName: string;
      ringName: string;
      colorBand: RingColorBand;
  }

  • bkgName: string

  • ringName: string

  • colorBand: RingColorBand

Static createSpikeEasing

• createSpikeEasing(spikePct?): Function

• Create an easing function that spikes in the center. Ideal duration is around 1600ms.

  Parameters

  • Optional spikePct: number = 0.5

    Position on [0,1] where the spike occurs.

  Returns Function

Static easeTwoPeaks

• easeTwoPeaks(pt): number

• Easing function that produces two peaks before returning to the original value. Ideal duration is around 500ms.

  Parameters

  • pt: number

    The proportional animation timing on [0,1].

  Returns number

  The eased animation progress on [0,1].