Interface: OverlayType
@faeyumbrea/obs-utils-api-types
@faeyumbrea/obs-utils-api-types / OverlayType
Defined in: api.d.ts:206
Public compile-time contract for modules integrating with OBS Utils.
Properties
Section titled “Properties”compactEditorButtons
Section titled “compactEditorButtons”compactEditorButtons:
Map<string,boolean>
Defined in: api.d.ts:212
hasCustomOverlayEditor
Section titled “hasCustomOverlayEditor”hasCustomOverlayEditor:
boolean
Defined in: api.d.ts:214
overlayClass
Section titled “overlayClass”overlayClass:
Component
Defined in: api.d.ts:209
overlayComponentEditors
Section titled “overlayComponentEditors”overlayComponentEditors:
Map<string,Component<any,any,any>>
Defined in: api.d.ts:211
overlayComponentImageSlots
Section titled “overlayComponentImageSlots”overlayComponentImageSlots:
Map<string,ImageSlotHandlers>
Defined in: api.d.ts:213
overlayComponentNames
Section titled “overlayComponentNames”overlayComponentNames:
Map<string,string>
Defined in: api.d.ts:210
overlayComponents
Section titled “overlayComponents”overlayComponents:
Map<string,Component<any,any,any>>
Defined in: api.d.ts:208
overlayEditor
Section titled “overlayEditor”overlayEditor:
Component
Defined in: api.d.ts:207
perActor
Section titled “perActor”perActor:
boolean
Defined in: api.d.ts:215
Methods
Section titled “Methods”registerComponent()
Section titled “registerComponent()”registerComponent(
key,readableName,type):void
Defined in: api.d.ts:227
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.d.ts:228
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: api.d.ts:229
Parameters
Section titled “Parameters”string
handlers
Section titled “handlers”Returns
Section titled “Returns”void
registerOverlayEditor()
Section titled “registerOverlayEditor()”registerOverlayEditor(
editor):void
Defined in: api.d.ts:217
Parameters
Section titled “Parameters”editor
Section titled “editor”Component<any, any, any>
Returns
Section titled “Returns”void