Class: OverlayType
Defined in: api.ts:153
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OverlayType(
overlayClass):OverlayType
Defined in: api.ts:163
Parameters
Section titled “Parameters”overlayClass
Section titled “overlayClass”Component<any, any, any>
Returns
Section titled “Returns”OverlayType
Properties
Section titled “Properties”compactEditorButtons
Section titled “compactEditorButtons”compactEditorButtons:
Map<string,boolean>
Defined in: api.ts:159
hasCustomOverlayEditor
Section titled “hasCustomOverlayEditor”hasCustomOverlayEditor:
boolean=false
Defined in: api.ts:160
overlayClass
Section titled “overlayClass”overlayClass:
Component
Defined in: api.ts:156
overlayComponentEditors
Section titled “overlayComponentEditors”overlayComponentEditors:
Map<string,Component<any,any,any>>
Defined in: api.ts:158
overlayComponentNames
Section titled “overlayComponentNames”overlayComponentNames:
Map<string,string>
Defined in: api.ts:157
overlayComponents
Section titled “overlayComponents”overlayComponents:
Map<string,Component<any,any,any>>
Defined in: api.ts:155
overlayEditor
Section titled “overlayEditor”overlayEditor:
Component
Defined in: api.ts:154
perActor
Section titled “perActor”perActor:
boolean=true
Defined in: api.ts:161
Methods
Section titled “Methods”registerComponent()
Section titled “registerComponent()”registerComponent(
key,readableName,type):void
Defined in: api.ts:186
Register a renderable component type for this overlay.
Parameters
Section titled “Parameters”string
Stable key referenced from overlay data (e.g. ‘pt’, ‘pb’).
readableName
Section titled “readableName”string
i18n key for the display label. Resolved via
game.i18n.localize() at render time. Pass a literal string only
if you intentionally ship a single-locale module.
Component<any, any, any>
The Svelte component class that renders the data.
Returns
Section titled “Returns”void
registerComponentEditor()
Section titled “registerComponentEditor()”registerComponentEditor(
key,editor,compactButtons):void
Defined in: api.ts:191
Parameters
Section titled “Parameters”string
editor
Section titled “editor”Component<any, any, any>
compactButtons
Section titled “compactButtons”boolean = false
Returns
Section titled “Returns”void
registerOverlayEditor()
Section titled “registerOverlayEditor()”registerOverlayEditor(
editor):void
Defined in: api.ts:172
Parameters
Section titled “Parameters”editor
Section titled “editor”Component<any, any, any>
Returns
Section titled “Returns”void