Skip to main content
Version: 5.0

Interface: OverlayTriggerRegistration

Defined in: api.ts:71

Properties​

icon?​

optional icon?: string

Defined in: api.ts:81

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

key​

key: string

Defined in: api.ts:73

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

name​

name: string

Defined in: api.ts:79

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.ts:83

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