Skip to content
Void Monster Docs

Type to search guides and API reference.

    OBS Utils/Developer docs

    Type Alias: OverlayTileMode

    Public 5.3.0API 5.3.0

    @faeyumbrea/obs-utils-api-types

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

    OverlayTileMode = "actors" | "players" | "users" | "once"

    Defined in: types.d.ts:71

    How the renderer iterates an overlay across contexts.

    • 'actors' (default) — one tile per actor in the bound actor list. Ambient overlays like HP bars.
    • 'players' — one tile per non-GM user. Useful for roll-banner triggered overlays.
    • 'users' — one tile per active user (includes GMs).
    • 'once' — singleton. The overlay mounts once regardless of context.