Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface TokenRingData

    interface TokenRingData {
        colors: { background?: string; ring?: string };
        effects?: number;
        enabled?: number;
        subject: { scale?: number; texture?: string };
    }
    Index

    Properties

    colors effects? enabled? subject

    Properties

    colors: { background?: string; ring?: string }

    Type Declaration

    • Optionalbackground?: string

      Color of the background (behind the token, inside the ring).

    • Optionalring?: string

      Color of the ring.

    effects?: number

    Numerical bitmask to toggle effects. Default: 0x01

    enabled?: number

    Dynamic Token ring is enabled?

    subject: { scale?: number; texture?: string }

    Type Declaration

    • Optionalscale?: number

      Scale of the subject texture.

    • Optionaltexture?: string

      Path of the subject texture.

    Settings

    Member Visibility

    On This Page

    Properties