Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...
    interface CardsData {
        _id: string | null;
        _stats: DocumentStats;
        cards: CardData[];
        description: string;
        displayCount: boolean;
        flags: DocumentFlags;
        folder: string | null;
        height: number;
        img: string | null;
        name: string;
        ownership: object;
        rotation: number;
        sort: number;
        system: object;
        type: string;
        width: number;
    }
    Index

    Properties

    _id: string | null

    The _id which uniquely identifies this stack of Cards document

    An object of creation and access information

    cards: CardData[]

    A collection of Card documents which currently belong to this stack

    description: string

    A text description of this stack

    displayCount: boolean

    Whether or not to publicly display the number of cards in this stack

    An object of optional key/value flags

    folder: string | null

    The _id of a Folder which contains this document

    height: number

    The visible height of this stack

    img: string | null

    An image or video which is used to represent the stack of cards

    name: string

    The text name of this stack

    ownership: object

    An object which configures ownership of this Cards

    rotation: number

    The angle of rotation of this stack

    sort: number

    The sort order of this stack relative to others in its parent collection

    system: object

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

    type: string

    The type of this stack, in BaseCards.metadata.types

    width: number

    The visible width of this stack