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

    Interface _SystemManifestData

    Manifest properties exclusive to systems.

    interface _SystemManifestData {
        background?: string;
        documentTypes?: DocumentTypesConfiguration;
        grid?: {
            diagonals?: GridDiagonalRule;
            distance?: number;
            type?: GridType;
            units?: string;
        };
        initiative?: string;
        primaryTokenAttribute?: string;
        secondaryTokenAttribute?: string;
        type: "system";
    }
    Index

    Properties

    background? documentTypes? grid? initiative? primaryTokenAttribute? secondaryTokenAttribute? type

    Properties

    background?: string

    A web URL or local file path which provides a default background banner for worlds which are created using this system

    documentTypes?: DocumentTypesConfiguration

    Additional document subtypes provided by this system.

    grid?: {
        diagonals?: GridDiagonalRule;
        distance?: number;
        type?: GridType;
        units?: string;
    }

    The default grid settings to use for Scenes in this system.

    Type Declaration

    • Optionaldiagonals?: GridDiagonalRule

      The default rule used by this system for diagonal measurement on square and hexagonal grids.

    • Optionaldistance?: number

      A default distance measurement to use for Scenes in this system.

    • Optionaltype?: GridType

      A default grid type to use for Scenes in this system.

    • Optionalunits?: string

      A default unit of measure to use for distance measurement in this system.

    initiative?: string

    A default initiative formula used for this system.

    primaryTokenAttribute?: string

    An Actor data attribute path to use for Token primary resource bars

    secondaryTokenAttribute?: string

    An Actor data attribute path to use for Token secondary resource bars

    type: "system"

    The package type among world, system, and module

    Settings

    Member Visibility

    On This Page

    Properties