Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...
    interface CardData {
        _id: string | null;
        back: CardFaceData;
        description: string;
        drawn: boolean;
        face: number | null;
        faces: CardFaceData[];
        flags: DocumentFlags;
        height: number;
        name: string;
        origin: string;
        rotation: number;
        sort: number;
        suit: string;
        system: object;
        type: string;
        value: number | null;
        width: number;
    }
    Index

    Properties

    _id: string | null

    The _id which uniquely identifies this Card document

    An object of face data which describes the back of this card

    description: string

    A text description of this card which applies to all faces

    drawn: boolean

    Whether this card is currently drawn from its source deck

    face: number | null

    The index of the currently displayed face, or null if the card is face-down

    faces: CardFaceData[]

    An array of face data which represent displayable faces of this card

    An object of optional key/value flags

    height: number

    The visible height of this card

    name: string

    The text name of this card

    origin: string

    The document ID of the origin deck to which this card belongs

    rotation: number

    The angle of rotation of this card

    sort: number

    The sort order of this card relative to others in the same stack

    suit: string

    An optional suit designation which is used by default sorting

    system: object

    Data for a Card subtype, defined by a System or Module

    type: string

    A category of card (for example, a suit) to which this card belongs

    value: number | null

    An optional numeric value of the card which is used by default sorting

    width: number

    The visible width of this card