Class TokenRingConfig

Token Ring configuration Singleton Class.

Example

Add a new custom ring configuration. Allow only ring pulse, ring gradient and background wave effects.
const customConfig = new foundry.canvas.tokens.DynamicRingData({
  id: "myCustomRingId",
  label: "Custom Ring",
  effects: {
    RING_PULSE: "TOKEN.RING.EFFECTS.RING_PULSE",
    RING_GRADIENT: "TOKEN.RING.EFFECTS.RING_GRADIENT",
    BACKGROUND_WAVE: "TOKEN.RING.EFFECTS.BACKGROUND_WAVE"
  },
  spritesheet: "canvas/tokens/myCustomRings.json",
  framework: {
    shaderClass: MyCustomTokenRingSamplerShader,
    ringClass: TokenRing
  }
});
CONFIG.Token.ring.addConfig(customConfig.id, customConfig);
Copy

Example

Get a specific ring configuration
const config = CONFIG.Token.ring.getConfig("myCustomRingId");
console.log(config.spritesheet); // Output: canvas/tokens/myCustomRings.json
Copy

Example

Use a specific ring configuration
const success = CONFIG.Token.ring.useConfig("myCustomRingId");
console.log(success); // Output: true
Copy

Example

Get the labels of all configurations
const configLabels = CONFIG.Token.ring.configLabels;
console.log(configLabels);
// Output:
// {
//   "coreSteel": "Foundry VTT Steel Ring",
//   "coreBronze": "Foundry VTT Bronze Ring",
//   "myCustomRingId" : "My Super Power Ring"
// }
Copy

Example

Get the IDs of all configurations
const configIDs = CONFIG.Token.ring.configIDs;
console.log(configIDs); // Output: ["coreSteel", "coreBronze", "myCustomRingId"]
Copy

Example

Create a hook to add a custom token ring configuration. This ring configuration will appear in the settings.
Hooks.on("initializeDynamicTokenRingConfig", ringConfig => {
  const mySuperPowerRings = new foundry.canvas.tokens.DynamicRingData({
    id: "myCustomRingId",
    label: "My Super Power Rings",
    effects: {
      RING_PULSE: "TOKEN.RING.EFFECTS.RING_PULSE",
      RING_GRADIENT: "TOKEN.RING.EFFECTS.RING_GRADIENT",
      BACKGROUND_WAVE: "TOKEN.RING.EFFECTS.BACKGROUND_WAVE"
    },
    spritesheet: "canvas/tokens/mySuperPowerRings.json"
  });
  ringConfig.addConfig("mySuperPowerRings", mySuperPowerRings);
});
Copy

Example

Activate color bands debugging visuals to ease configuration
CONFIG.Token.ring.debugColorBands = true;
Copy