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

    Interface Suit

    interface Suit {
        abbreviation: string;
        allClueColors: boolean;
        allClueRanks: boolean;
        clueColors: readonly Color[];
        createVariants: boolean;
        displayName: string;
        fill: string;
        fillColorblind: string;
        fillColors: readonly string[];
        id: string;
        inverted: boolean;
        name: string;
        noClueColors: boolean;
        noClueRanks: boolean;
        oneOfEach: boolean;
        pip: string;
        prism: boolean;
        reversed: boolean;
    }

    Hierarchy

    • SuitJSONModified
      • Suit
    Index

    Properties

    abbreviation allClueColors allClueRanks clueColors createVariants displayName fill fillColorblind fillColors id inverted name noClueColors noClueRanks oneOfEach pip prism reversed

    Properties

    abbreviation: string

    The one letter abbreviation to use when representing this suit as a card note.

    allClueColors: boolean
    allClueRanks: boolean
    clueColors: readonly Color[]
    createVariants: boolean

    Whether or not to create variant combinations based on this suit.

    displayName: string

    A simplified version of the suit name to show to end-users.

    fill: string

    The background color of cards of the suit.

    fillColorblind: string
    fillColors: readonly string[]

    Allows for a gradient of different colors.

    id: string

    The suit ID is a two character string:

    • Normal suits have a single capital letter. (e.g. "R" for "Red")
    • Special suits have a two character ID with a lowercase letter. (e.g. "Bk" for "Black")
    • Combination suits have a four character ID. (e.g. "BrRa" for "Muddy Rainbow")
    • Dark suits have a capital D prefix. (e.g. "DRa" for "Dark Rainbow")
    • Ambiguous suits have a capital A prefix and a number suffix. (e.g. AR1 for "Tomato")
    • Very Ambiguous suits have a capital V prefix and a number suffix. (e.g. "VR1" for "Tomato VA")
    • Extremely Ambiguous suits have a capital E prefix and a number suffix. (e.g. "EB1" for "Ice EA")
    • Dual-Color suits have a capital D prefix. (e.g. "DRY" for "Orange D", "DRB" for "Purple D", and "DRY2" for "Orange D2")
    inverted: boolean
    name: string
    noClueColors: boolean
    noClueRanks: boolean
    oneOfEach: boolean
    pip: string

    The symbol that represents this suit.

    prism: boolean
    reversed: boolean

    Settings

    Member Visibility

    On This Page

    Properties