Viktorani API - v0.0.8
    Preparing search index...

    Interface Timer

    A countdown timer that can be broadcast to players.

    target === 'all' broadcasts to everyone; 'admin' shows only on the GM screen; a team or player ID restricts visibility to that entity.

    interface Timer {
        audioNotify: TimerNotify;
        autoReset: TimerAutoReset;
        duration: number;
        gameId: string;
        id: string;
        label: string;
        message: string;
        paused: boolean;
        remaining: number;
        startedAt: number | null;
        target: string;
        visible: boolean;
        visualNotify: TimerNotify;
    }
    Index

    Properties

    audioNotify: TimerNotify

    Who hears the audio beep on expiry.

    autoReset: TimerAutoReset

    Whether and when the timer resets automatically.

    duration: number

    Total duration in seconds.

    gameId: string
    id: string
    label: string
    message: string
    paused: boolean
    remaining: number

    Remaining seconds at the last pause/update.

    startedAt: number | null

    Date.now() value when the timer last started (or null if not yet started).

    target: string
    visible: boolean
    visualNotify: TimerNotify

    Who sees the visual flash on expiry.