Class: OverlayType
Defined in: api.ts:319
Constructors
Constructor
new OverlayType(
overlayClass):OverlayType
Defined in: api.ts:330
Parameters
overlayClass
Component<any, any, any>
Returns
OverlayType
Properties
compactEditorButtons
compactEditorButtons:
Map<string,boolean>
Defined in: api.ts:325
hasCustomOverlayEditor
hasCustomOverlayEditor:
boolean=false
Defined in: api.ts:327
overlayClass
overlayClass:
Component
Defined in: api.ts:322
overlayComponentEditors
overlayComponentEditors:
Map<string,Component<any,any,any>>
Defined in: api.ts:324
overlayComponentImageSlots
overlayComponentImageSlots:
Map<string,ImageSlotHandlers>
Defined in: api.ts:326
overlayComponentNames
overlayComponentNames:
Map<string,string>
Defined in: api.ts:323
overlayComponents
overlayComponents:
Map<string,Component<any,any,any>>
Defined in: api.ts:321
overlayEditor
overlayEditor:
Component
Defined in: api.ts:320
perActor
perActor:
boolean=true
Defined in: api.ts:328
Methods
registerComponent()
registerComponent(
key,readableName,type):void
Defined in: api.ts:354
Register a renderable component type for this overlay.
Parameters
key
string
Stable key referenced from overlay data (e.g. 'pt', 'pb').
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.
type
Component<any, any, any>
The Svelte component class that renders the data.
Returns
void
registerComponentEditor()
registerComponentEditor(
key,editor,compactButtons?):void
Defined in: api.ts:359
Parameters
key
string
editor
Component<any, any, any>
compactButtons?
boolean = false
Returns
void
registerComponentImageSlots()
registerComponentImageSlots(
key,handlers):void
Defined in: api.ts:364
Parameters
key
string
handlers
Returns
void
registerOverlayEditor()
registerOverlayEditor(
editor):void
Defined in: api.ts:340
Parameters
editor
Component<any, any, any>
Returns
void