Skip to content

@vttforge/core / DocumentConfig

Interface: DocumentConfig<TClass> ​

What every CONFIG.<Document> entry carries.

Extended by ​

Type Parameters ​

TClass ​

TClass = AnyClass

Properties ​

collection? ​

optional collection?: AnyClass


compendiumIndexFields? ​

optional compendiumIndexFields?: string[]


dataModels ​

dataModels: Record<string, AnyClass>


documentClass ​

documentClass: TClass


sheetClasses? ​

optional sheetClasses?: Record<string, Record<string, unknown>>


optional sidebar?: object

applicationClass? ​

optional applicationClass?: AnyClass

order? ​

optional order?: number


typeIcons? ​

optional typeIcons?: Record<string, string>

Icon per subtype, shown in the sidebar and on creation dialogs.


typeLabels? ​

optional typeLabels?: Record<string, string>

MIT licensed.