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

    Interface RollTableData

    interface RollTableData {
        _id: string | null;
        _stats: DocumentStats;
        description?: string;
        displayRoll?: boolean;
        flags: DocumentFlags;
        folder: string | null;
        formula: string;
        img?: string;
        name: string;
        ownership?: object;
        replacement?: boolean;
        results?: TableResultData[];
        sort?: number;
    }
    Index

    Properties

    _id _stats description? displayRoll? flags folder formula img? name ownership? replacement? results? sort?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this RollTable document

    _stats

    _stats: DocumentStats

    An object of creation and access information

    description?: string

    The HTML text description for this RollTable document

    displayRoll?: boolean

    Is the Roll result used to draw from this RollTable displayed in chat?

    flags: DocumentFlags

    An object of optional key/value flags

    folder: string | null

    The _id of a Folder which contains this RollTable

    formula: string

    The Roll formula which determines the results chosen from the table

    img?: string

    An image file path which provides the thumbnail artwork for this RollTable

    name: string

    The name of this RollTable

    ownership?: object

    An object which configures ownership of this RollTable

    replacement?: boolean

    Are results from this table drawn with replacement?

    results?: TableResultData[]

    A Collection of TableResult embedded documents which belong to this RollTable

    sort?: number

    The numeric sort value which orders this RollTable relative to its siblings

    Settings

    Member Visibility

    On This Page

    Properties