Interface: OverlayTriggerRegistration

@faeyumbrea/obs-utils-api-types

---

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

Defined in: api.d.ts:42

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

Properties

icon?

optional icon?: string

Defined in: api.d.ts:52

Optional Font Awesome icon class (e.g. ‘fas fa-dice-d20’).

---

key

key: string

Defined in: api.d.ts:44

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

---

name

name: string

Defined in: api.d.ts:50

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

---

payloadSchema?

optional payloadSchema?: TriggerPayloadField[]

Defined in: api.d.ts:54

Fields carried in the event payload — drives editor condition inputs and trigger.X references.