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

    Interface UseScoreboardResult

    Return value of useScoreboard.

    interface UseScoreboardResult {
        adjust: (
            id: string,
            kind: "player" | "team",
            delta: number,
        ) => Promise<void>;
        defaultIncrement: number;
        entries: ScoreEntry[];
    }
    Index

    Properties

    adjust defaultIncrement entries

    Properties

    adjust: (id: string, kind: "player" | "team", delta: number) => Promise<void>

    Apply a score delta to a player or team. Persists the change to IndexedDB and broadcasts a SCORE_UPDATE event.

    defaultIncrement: number

    Suggested increment step — the lowest difficulty point value, or 1 if none configured.

    entries: ScoreEntry[]

    Sorted list of scoreboard rows (descending by score).

    Settings

    Member Visibility

    On This Page

    Properties