Class: OverlayType
@faeyumbrea/obs-utils-api-types
@faeyumbrea/obs-utils-api-types / OverlayType
Defined in: public-api.d.ts:469
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OverlayType(
overlayClass):OverlayType
Defined in: public-api.d.ts:479
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: public-api.d.ts:475
hasCustomOverlayEditor
Section titled “hasCustomOverlayEditor”hasCustomOverlayEditor:
boolean
Defined in: public-api.d.ts:477
overlayClass
Section titled “overlayClass”overlayClass:
Component
Defined in: public-api.d.ts:472
overlayComponentEditors
Section titled “overlayComponentEditors”overlayComponentEditors:
Map<string,Component<any,any,any>>
Defined in: public-api.d.ts:474
overlayComponentImageSlots
Section titled “overlayComponentImageSlots”overlayComponentImageSlots:
Map<string,ImageSlotHandlers>
Defined in: public-api.d.ts:476
overlayComponentNames
Section titled “overlayComponentNames”overlayComponentNames:
Map<string,string>
Defined in: public-api.d.ts:473
overlayComponents
Section titled “overlayComponents”overlayComponents:
Map<string,Component<any,any,any>>
Defined in: public-api.d.ts:471
overlayEditor
Section titled “overlayEditor”overlayEditor:
Component
Defined in: public-api.d.ts:470
perActor
Section titled “perActor”perActor:
boolean
Defined in: public-api.d.ts:478
Methods
Section titled “Methods”registerComponent()
Section titled “registerComponent()”registerComponent(
key,readableName,type):void
Defined in: public-api.d.ts:490
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: public-api.d.ts:491
Parameters
Section titled “Parameters”string
editor
Section titled “editor”Component<any, any, any>
compactButtons?
Section titled “compactButtons?”boolean
Returns
Section titled “Returns”void
registerComponentImageSlots()
Section titled “registerComponentImageSlots()”registerComponentImageSlots(
key,handlers):void
Defined in: public-api.d.ts:492
Parameters
Section titled “Parameters”string
handlers
Section titled “handlers”Returns
Section titled “Returns”void
registerOverlayEditor()
Section titled “registerOverlayEditor()”registerOverlayEditor(
editor):void
Defined in: public-api.d.ts:480
Parameters
Section titled “Parameters”editor
Section titled “editor”Component<any, any, any>
Returns
Section titled “Returns”void