Interface: TriggerPayloadField

@faeyumbrea/obs-utils-api-types

---

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

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

One field in a trigger’s payload schema. Drives both the editor’s condition inputs (when filter !== false) and the value paths components can reference via trigger.X (when display !== false).

Properties

choices?

optional choices?: Record<string, string>

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

Allowed string values and their label keys, rendered as choices in event editors.

---

default?

optional default?: any

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

Default value used when the editor seeds a fresh condition.

---

display?

optional display?: boolean

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

If false, this field cannot be referenced via trigger.. Defaults to true.

---

filter?

optional filter?: boolean

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

If false, this field is not exposed to the editor condition inputs. Defaults to true.

---

key

key: string

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

Storage / lookup key.

---

label

label: string

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

i18n key for the label. Resolved via game.i18n.localize() at render time.

---

type

type: "string" | "number" | "boolean" | "Actor" | "ChatMessage" | "Roll"

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