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

    Interface MacroData

    interface MacroData {
        _id: string | null;
        _stats: DocumentStats;
        author: string | null;
        command: string;
        flags: DocumentFlags;
        folder: string | null;
        img?: string;
        name: string;
        ownership?: object;
        scope?: string;
        sort?: number;
        type: string;
    }
    Index

    Properties

    _id _stats author command flags folder img? name ownership? scope? sort? type

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Macro document

    _stats

    _stats: DocumentStats

    An object of creation and access information

    author: string | null

    The _id of a User document which created this Macro

    command: string

    The string content of the macro command

    flags: DocumentFlags

    An object of optional key/value flags

    folder: string | null

    The _id of a Folder which contains this Macro

    img?: string

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

    name: string

    The name of this Macro

    ownership?: object

    An object which configures ownership of this Macro

    scope?: string

    The scope of this Macro application from CONST.MACRO_SCOPES

    sort?: number

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

    type: string

    A Macro subtype from CONST.MACRO_TYPES

    Settings

    Member Visibility

    On This Page

    Properties