Heroic Lands

Interface DocumentConfig

Per-document-type registration block within SohlConfig.

interface DocumentConfig {
    compendiums?: string[];
    dataModels: StrictObject<
        Constructor<
            SohlDataModel<any, any, any>
            | TypeDataModel<any, any>,
            any[],
        >,
    >;
    defaultType?: string;
    documentClass: any;
    documentSheets: { cls: any; types: string[] }[];
    macros?: StrictObject<FilePath>;
    typeIcons: StrictObject<string>;
    typeLabels: StrictObject<string>;
    types: string[];
}

Properties

compendiums? dataModels defaultType? documentClass documentSheets macros? typeIcons typeLabels types

Properties

Optionalcompendiums

compendiums?: string[]

Compendium pack ids associated with this type.

dataModels

dataModels: StrictObject<
    Constructor<
        SohlDataModel<any, any, any>
        | TypeDataModel<any, any>,
        any[],
    >,
>

DataModel constructors keyed by subtype.

OptionaldefaultType

defaultType?: string

Default subtype for new documents.

documentClass

documentClass: any

The document subclass Foundry should instantiate.

documentSheets

documentSheets: { cls: any; types: string[] }[]

Sheet classes paired with the subtypes they apply to.

Type declaration

  • cls: any

    Sheet class constructor.

  • types: string[]

    Subtypes this sheet handles.

Optionalmacros

macros?: StrictObject<FilePath>

Macro file paths keyed by name.

typeIcons

typeIcons: StrictObject<string>

Type icons keyed by subtype.

typeLabels

typeLabels: StrictObject<string>

Localized type labels keyed by subtype.

types

types: string[]

All registered subtypes.

Settings

Member Visibility

On This Page

Properties