@hanabi-live/game
    Preparing search index...

    Interface Variant

    interface Variant {
        alternatingClues: boolean;
        chimneys: boolean;
        clueColors: readonly Color[];
        clueRanks: readonly (1 | 2 | 3 | 4 | 5)[];
        clueStarved: boolean;
        colorCluesTouchNothing: boolean;
        cowAndPig: boolean;
        criticalRank: undefined | 7 | 3 | 1 | 2 | 4 | 5;
        duck: boolean;
        funnels: boolean;
        id: number;
        identityNotePattern: string;
        maxScore: number;
        name: string;
        newID: string;
        oddsAndEvens: boolean;
        offsetCornerElements: boolean;
        rankCluesTouchNothing: boolean;
        ranks: readonly (1 | 2 | 3 | 4 | 5 | 7)[];
        showSuitNames: boolean;
        specialRank: undefined | 7 | 3 | 1 | 2 | 4 | 5;
        specialRankAllClueColors: boolean;
        specialRankAllClueRanks: boolean;
        specialRankDeceptive: boolean;
        specialRankNoClueColors: boolean;
        specialRankNoClueRanks: boolean;
        stackSize: 1 | 2 | 3 | 4 | 5;
        sudoku: boolean;
        suitAbbreviations: readonly string[];
        suits: readonly Suit[];
        synesthesia: boolean;
        throwItInAHole: boolean;
        upOrDown: boolean;
    }

    Hierarchy

    • VariantJSONModified
      • Variant
    Index

    Properties

    alternatingClues chimneys clueColors clueRanks clueStarved colorCluesTouchNothing cowAndPig criticalRank duck funnels id identityNotePattern maxScore name newID oddsAndEvens offsetCornerElements rankCluesTouchNothing ranks showSuitNames specialRank specialRankAllClueColors specialRankAllClueRanks specialRankDeceptive specialRankNoClueColors specialRankNoClueRanks stackSize sudoku suitAbbreviations suits synesthesia throwItInAHole upOrDown

    Properties

    alternatingClues: boolean
    chimneys: boolean
    clueColors: readonly Color[]
    clueRanks: readonly (1 | 2 | 3 | 4 | 5)[]
    clueStarved: boolean
    colorCluesTouchNothing: boolean
    cowAndPig: boolean
    criticalRank: undefined | 7 | 3 | 1 | 2 | 4 | 5
    duck: boolean
    funnels: boolean
    id: number

    A number from 0 to N. For example, "No Variant" is variant 0, "6 Suits" is variant 1, and so on. This is a legacy field; we want to transition to using a more descriptive string ID, which will allow for custom user-defined variants.

    identityNotePattern: string
    maxScore: number
    name: string
    newID: string

    A string that describes the variant. For example, "No Variant" is R+Y+G+B+P.

    oddsAndEvens: boolean
    offsetCornerElements: boolean
    rankCluesTouchNothing: boolean
    ranks: readonly (1 | 2 | 3 | 4 | 5 | 7)[]
    showSuitNames: boolean
    specialRank: undefined | 7 | 3 | 1 | 2 | 4 | 5
    specialRankAllClueColors: boolean
    specialRankAllClueRanks: boolean
    specialRankDeceptive: boolean
    specialRankNoClueColors: boolean
    specialRankNoClueRanks: boolean
    stackSize: 1 | 2 | 3 | 4 | 5
    sudoku: boolean
    suitAbbreviations: readonly string[]
    suits: readonly Suit[]
    synesthesia: boolean
    throwItInAHole: boolean
    upOrDown: boolean

    Settings

    Member Visibility

    On This Page

    Properties