Class TokenRing

constructor

• new TokenRing(token: canvas.placeables.Token): TokenRing

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

  Parameters

  • token: canvas.placeables.Token

  Returns TokenRing

bkgColorLittleEndian

bkgName

bkgUVs

colorBand

defaultBackgroundColorLittleEndian

defaultRingColorLittleEndian

effects

maskName

maskUVs

ringColorLittleEndian

ringName

ringUVs

scaleAdjustmentX

scaleAdjustmentY

scaleCorrection

subjectScaleAdjustment

textureScaleAdjustment

StaticbaseTexture

Staticeffects

StatictexturesData

StatictokenRingSamplerShader

token

• get token(): void | canvas.placeables.Token

  Reference to the token that should be animated.

  Returns void | canvas.placeables.Token

Staticinitialized

• get initialized(): boolean | null

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

  Returns boolean | null

clear

• clear(): void

  Clear configuration pertaining to token ring from the mesh.

  Returns void

configure

• configure(mesh?: any): void

  Configure the sprite mesh.

  Parameters

  • Optionalmesh: any

    The mesh to which TokenRing functionality is configured (default to token.mesh)

  Returns void

configureSize

• configureSize(options?: { fit?: string; scaleMultiplier?: number }): void

  Configure token ring size according to mesh texture, token dimensions, fit mode, and dynamic ring fit mode.

  Parameters

  • Optionaloptions: { fit?: string; scaleMultiplier?: number } = {}

    • Optionalfit?: string

      The desired fit mode

    • OptionalscaleMultiplier?: number

      A custom scale multiplier applied on scale correction

  Returns void

configureVisuals

• configureVisuals(): void

  Configure the token ring visuals properties.

  Returns void

flashColor

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

  Flash the ring briefly with a certain color.

  Parameters

  • color: Color

    Color to flash.

  • animationOptions: CanvasAnimationOptions = {}

    Options to customize the animation.

  Returns Promise<boolean | void>

StaticcreateAssetsUVs

• createAssetsUVs(): void

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

  Returns void

StaticcreateSpikeEasing

• createSpikeEasing(spikePct?: number): Function

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

  Parameters

  • OptionalspikePct: number = 0.5

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

  Returns Function

StaticeasePingPong

• easePingPong(pt: number): number

  Soft ping pong curve for photosensitive people.

  Parameters

  • pt: number

    The proportional animation timing on [0,1].

  Returns number

  The eased animation progress on [0,1].

StaticeaseTwoPeaks

• easeTwoPeaks(pt: number): 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].

StaticgetRingDataBySize

• getRingDataBySize(size: number): RingData

  Get ring and background names for a given size.

  Parameters

  • size: number

    The size to match (grid size dimension)

  Returns RingData

StaticgetTextureUVs

• getTextureUVs(name: string, scaleCorrection?: number): void | 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.

  • OptionalscaleCorrection: number = 1

    The scale correction applied to UVs.

  Returns void | Float32Array

Staticinitialize

• initialize(): void

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

  Returns void