Interface: OverlayTriggerRegistration

@faeyumbrea/obs-utils-api-types

---

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

Defined in: public-api.d.ts:303

Properties

createTestPayload?

optional createTestPayload?: (context) => Record<string, unknown>

Defined in: public-api.d.ts:317

Optional editor sample factory. Context contains actor, user and custom field overrides; older editors ignore this field.

Parameters

context

Record<string, unknown>

Returns

Record<string, unknown>

---

icon?

optional icon?: string

Defined in: public-api.d.ts:313

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

---

key

key: string

Defined in: public-api.d.ts:305

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

---

name

name: string

Defined in: public-api.d.ts:311

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: public-api.d.ts:315

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