Class: ObsUtilsApi
Defined in: api.ts:65
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ObsUtilsApi():
ObsUtilsApi
Defined in: api.ts:72
Returns
Section titled “Returns”ObsUtilsApi
Properties
Section titled “Properties”obsRemoteEventTypes
Section titled “obsRemoteEventTypes”obsRemoteEventTypes:
Map<string,OBSRemoteEventTypeRegistration>
Defined in: api.ts:70
overlayTypeNames
Section titled “overlayTypeNames”overlayTypeNames:
Map<string,string>
Defined in: api.ts:67
overlayTypes
Section titled “overlayTypes”overlayTypes:
Map<string,OverlayType>
Defined in: api.ts:66
singleInstanceOverlays
Section titled “singleInstanceOverlays”singleInstanceOverlays:
Set<Component>
Defined in: api.ts:68
singleInstanceOverlaysSvelte5
Section titled “singleInstanceOverlaysSvelte5”singleInstanceOverlaysSvelte5:
Set<Component>
Defined in: api.ts:69
Methods
Section titled “Methods”getOBSWebsocketClient()
Section titled “getOBSWebsocketClient()”getOBSWebsocketClient():
Promise<any> |undefined
Defined in: api.ts:140
Returns
Section titled “Returns”Promise<any> | undefined
getSelectedActors()
Section titled “getSelectedActors()”getSelectedActors():
any
Defined in: api.ts:128
Returns
Section titled “Returns”any
isOBS()
Section titled “isOBS()”isOBS():
any
Defined in: api.ts:148
Returns
Section titled “Returns”any
registerOBSRemoteEventType()
Section titled “registerOBSRemoteEventType()”registerOBSRemoteEventType(
reg):void
Defined in: api.ts:81
Public — modules call this in their init hook to expose a new event type.
Parameters
Section titled “Parameters”OBSRemoteEventTypeRegistration
Returns
Section titled “Returns”void
registerOverlayType()
Section titled “registerOverlayType()”registerOverlayType(
key,readableName,type):void
Defined in: api.ts:113
Register a new overlay type. Surfaces in the Stream Composer’s “+ new” menu and elsewhere the type list is consumed.
Parameters
Section titled “Parameters”string
Stable key written into OverlayData.type (e.g. ‘wysiwyg’).
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.
The OverlayType instance with the renderer and editor wired up.
Returns
Section titled “Returns”void
registerUniqueOverlay()
Section titled “registerUniqueOverlay()”registerUniqueOverlay(
overlay):void
Defined in: api.ts:119
Parameters
Section titled “Parameters”overlay
Section titled “overlay”Component
Returns
Section titled “Returns”void
registerUniqueOverlaySvelte5()
Section titled “registerUniqueOverlaySvelte5()”registerUniqueOverlaySvelte5(
overlay):void
Defined in: api.ts:124
Parameters
Section titled “Parameters”overlay
Section titled “overlay”Component
Returns
Section titled “Returns”void
setAVData()
Section titled “setAVData()”setAVData(
actorValueArray):void
Defined in: api.ts:136
Parameters
Section titled “Parameters”actorValueArray
Section titled “actorValueArray”ActorValues
Returns
Section titled “Returns”void
setSelectedActors()
Section titled “setSelectedActors()”setSelectedActors(
actorArray):Promise<void>
Defined in: api.ts:132
Parameters
Section titled “Parameters”actorArray
Section titled “actorArray”string[]
Returns
Section titled “Returns”Promise<void>
triggerOBSRemoteEvent()
Section titled “triggerOBSRemoteEvent()”triggerOBSRemoteEvent(
key,context?):Promise<void>
Defined in: api.ts:94
Public — modules call this when their in-system condition fires
(e.g. on updateActor with system.attributes.hp.value changed).
Looks up every configured instance for the type, runs the matcher,
and executes the configured OBS actions for instances that pass.
Safe to call from any client; the actual OBS action execution is already gated to the OBS-mode client by triggerOBSAction.
Parameters
Section titled “Parameters”string
context?
Section titled “context?”Record<string, any> = {}
Returns
Section titled “Returns”Promise<void>