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

    Interface TableResultData

    interface TableResultData {
        _id: string | null;
        documentCollection?: string;
        documentId?: string;
        drawn?: boolean;
        flags: DocumentFlags;
        img?: string;
        range?: number[];
        text?: string;
        type?: string;
        weight?: number;
    }
    Index

    Properties

    _id documentCollection? documentId? drawn? flags img? range? text? type? weight?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this TableResult embedded document

    documentCollection?: string

    A named collection from which this result is drawn

    documentId?: string

    The _id of a Document within the collection this result references

    drawn?: boolean

    Has this result already been drawn (without replacement)

    flags: DocumentFlags

    An object of optional key/value flags

    img?: string

    An image file url that represents the table result

    range?: number[]

    A length 2 array of ascending integers which defines the range of dice roll totals which produce this drawn result

    Optionaltext

    text?: string

    The text which describes the table result

    type?: string

    A result subtype from CONST.TABLE_RESULT_TYPES

    weight?: number

    The probabilistic weight of this result relative to other results

    Settings

    Member Visibility

    On This Page

    Properties