Interface: OBSRemoteConditionField

@faeyumbrea/obs-utils-api-types

---

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

Defined in: api.d.ts:8

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

Properties

default?

optional default?: any

Defined in: api.d.ts:20

Default value when a new instance is added.

---

key

key: string

Defined in: api.d.ts:10

Storage key on the configured instance’s conditions object.

---

label

label: string

Defined in: api.d.ts:18

i18n key for the field label. 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.

---

type

type: "string" | "number" | "boolean"

Defined in: api.d.ts:12

What the user fills in.