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

    Interface TokenData

    interface TokenData {
        _id: string | null;
        _movementHistory: object[];
        _regions: string[];
        actorId: string | null;
        actorLink?: boolean;
        alpha?: number;
        bar1?: TokenBarData;
        bar2?: TokenBarData;
        delta?: ActorDeltaData;
        depth?: number;
        detectionModes: { [id: string]: TokenDetectionMode<true> };
        displayBars?: number;
        displayName?: number;
        disposition?: number;
        elevation?: number;
        flags: DocumentFlags;
        height?: number;
        hidden?: boolean;
        level?: string;
        light?: LightData;
        locked?: boolean;
        lockRotation?: boolean;
        name: string;
        occludable: TokenOcclusionData;
        ring: TokenRingData;
        rotation?: number;
        shape?: TokenShapeType;
        sight: TokenSightData;
        sort?: number;
        texture: TextureData;
        width?: number;
        x?: number;
        y?: number;
    }
    Index

    Properties

    _id _movementHistory _regions actorId actorLink? alpha? bar1? bar2? delta? depth? detectionModes displayBars? displayName? disposition? elevation? flags height? hidden? level? light? locked? lockRotation? name occludable ring rotation? shape? sight sort? texture width? x? y?

    Properties

    _id

    _id: string | null

    The Token _id which uniquely identifies it within its parent Scene

    _movementHistory

    _movementHistory: object[]

    _regions

    _regions: string[]
    actorId: string | null

    The _id of an Actor document which this Token represents

    actorLink?: boolean

    Does this Token uniquely represent a singular Actor, or is it one of many?

    alpha?: number

    The opacity of the token image

    bar1?: TokenBarData

    The configuration of the Token's primary resource bar

    bar2?: TokenBarData

    The configuration of the Token's secondary resource bar

    delta?: ActorDeltaData

    The ActorDelta embedded document which stores the differences between this token and the base actor it represents.

    depth?: number

    The depth of the Token in grid units

    detectionModes: { [id: string]: TokenDetectionMode<true> }

    A record of detection modes which are available to this Token

    displayBars?: number

    The display mode of Token resource bars, from CONST.TOKEN_DISPLAY_MODES

    displayName?: number

    The display mode of the Token nameplate, from CONST.TOKEN_DISPLAY_MODES

    disposition?: number

    A displayed Token disposition from CONST.TOKEN_DISPOSITIONS

    elevation?: number

    The vertical elevation of the Token, in distance units

    flags: DocumentFlags

    An object of optional key/value flags

    height?: number

    The height of the Token in grid units

    hidden?: boolean

    Is the Token currently hidden from player view?

    level?: string

    The level ID

    light?: LightData

    Configuration of the light source that this Token emits

    locked?: boolean

    Is the Token currently locked? A locked token cannot be moved or rotated via standard keyboard or mouse interaction.

    lockRotation?: boolean

    Prevent the Token image from visually rotating?

    name: string

    The name used to describe the Token

    occludable: TokenOcclusionData

    Configuration of occlusion options

    ring: TokenRingData

    Configuration of the Dynamic Token Ring

    rotation?: number

    The rotation of the Token in degrees, from 0 to 360. A value of 0 represents a southward-facing Token.

    shape?: TokenShapeType

    The shape of the Token

    sight: TokenSightData

    Configuration of sight and vision properties for the Token

    sort?: number

    The sort order

    texture: TextureData

    The token's texture on the canvas.

    width?: number

    The width of the Token in grid units

    x?: number

    The x-coordinate of the top-left corner of the Token

    y?: number

    The y-coordinate of the top-left corner of the Token

    Settings

    Member Visibility

    On This Page

    Properties