Class: OverlayType
Defined in: api.ts:286
Constructors
Constructor
new OverlayType(
overlayClass):OverlayType
Defined in: api.ts:297
Parameters
overlayClass
Component<any, any, any>
Returns
OverlayType
Properties
compactEditorButtons
compactEditorButtons:
Map<string,boolean>
Defined in: api.ts:292
hasCustomOverlayEditor
hasCustomOverlayEditor:
boolean=false
Defined in: api.ts:294
overlayClass
overlayClass:
Component
Defined in: api.ts:289
overlayComponentEditors
overlayComponentEditors:
Map<string,Component<any,any,any>>
Defined in: api.ts:291
overlayComponentImageSlots
overlayComponentImageSlots:
Map<string,ImageSlotHandlers>
Defined in: api.ts:293
overlayComponentNames
overlayComponentNames:
Map<string,string>
Defined in: api.ts:290
overlayComponents
overlayComponents:
Map<string,Component<any,any,any>>
Defined in: api.ts:288
overlayEditor
overlayEditor:
Component
Defined in: api.ts:287
perActor
perActor:
boolean=true
Defined in: api.ts:295
Methods
registerComponent()
registerComponent(
key,readableName,type):void
Defined in: api.ts:321
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:326
Parameters
key
string
editor
Component<any, any, any>
compactButtons?
boolean = false
Returns
void
registerComponentImageSlots()
registerComponentImageSlots(
key,handlers):void
Defined in: api.ts:331
Parameters
key
string
handlers
Returns
void
registerOverlayEditor()
registerOverlayEditor(
editor):void
Defined in: api.ts:307
Parameters
editor
Component<any, any, any>
Returns
void