Skip to content
Void Monster Docs

Type to search guides and API reference.

    OBS Utils/Developer docs

    Interface: OBSRemoteEventTypeRegistration

    Public 5.3.0API 5.3.0

    @faeyumbrea/obs-utils-api-types

    @faeyumbrea/obs-utils-api-types / OBSRemoteEventTypeRegistration

    Defined in: api.d.ts:22

    Public compile-time contract for modules integrating with OBS Utils.

    Properties

    Section titled “Properties”

    conditionFields?

    Section titled “conditionFields?”

    optional conditionFields?: OBSRemoteConditionField[]

    Defined in: api.d.ts:34

    Per-instance condition fields the user fills in when configuring.

    icon?

    Section titled “icon?”

    optional icon?: string

    Defined in: api.d.ts:32

    Optional Font Awesome icon class for the header (e.g. ‘fas fa-heart’).

    key

    Section titled “key”

    key: string

    Defined in: api.d.ts:24

    Unique key — namespace with your module id (e.g. ‘dnd5e.hpThreshold’).

    matcher?

    Section titled “matcher?”

    optional matcher?: (conditions, context) => boolean

    Defined in: api.d.ts:40

    Decide whether a configured instance should fire given its saved conditions and the runtime context passed to triggerOBSRemoteEvent. Omit → instance always fires.

    Parameters

    Section titled “Parameters”
    conditions
    Section titled “conditions”

    Record<string, any>

    context
    Section titled “context”

    any

    Returns

    Section titled “Returns”

    boolean

    name

    Section titled “name”

    name: string

    Defined in: api.d.ts:30

    i18n key for the section header. Resolved via game.i18n.localize() at render time. Pass a literal string only if you are intentionally shipping a single-locale module — the UI will display it verbatim.