Skip to content
Void Monster Docs

Type to search guides and API reference.

    OBS Utils/Developer docs

    Interface: OverlayData

    Public 5.3.0API 5.3.0

    @faeyumbrea/obs-utils-api-types

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

    Defined in: types.d.ts:72

    Properties

    Section titled “Properties”

    animation?

    Section titled “animation?”

    optional animation?: OverlayAnimationData

    Defined in: types.d.ts:83

    Tracks + transitions + zones. Drives all reactive visibility and transform behavior. Absent ⇒ overlay is fully ambient (no animation).

    components

    Section titled “components”

    components: OverlayComponentData[]

    Defined in: types.d.ts:74

    config

    Section titled “config”

    config: Record<string, any>

    Defined in: types.d.ts:76

    customCSS?

    Section titled “customCSS?”

    optional customCSS?: string

    Defined in: types.d.ts:86

    enabled?

    Section titled “enabled?”

    optional enabled?: boolean

    Defined in: types.d.ts:78

    id?

    Section titled “id?”

    optional id?: string

    Defined in: types.d.ts:85

    name?

    Section titled “name?”

    optional name?: string

    Defined in: types.d.ts:77

    style

    Section titled “style”

    style: string

    Defined in: types.d.ts:75

    tileBy?

    Section titled “tileBy?”

    optional tileBy?: OverlayTileMode

    Defined in: types.d.ts:84

    type

    Section titled “type”

    type: string

    Defined in: types.d.ts:73