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;
    name: string;
    noClueColors: boolean;
    noClueRanks: boolean;
    oneOfEach: boolean;
    pip: string;
    prism: boolean;
    reversed: boolean;
}

Hierarchy

  • SuitJSONModified
    • Suit

Properties

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

Properties

Readonlyabbreviation

abbreviation: string

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

ReadonlyallClueColors

allClueColors: boolean

ReadonlyallClueRanks

allClueRanks: boolean

ReadonlyclueColors

clueColors: readonly Color[]

ReadonlycreateVariants

createVariants: boolean

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

ReadonlydisplayName

displayName: string

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

Readonlyfill

fill: string

The background color of cards of the suit.

ReadonlyfillColorblind

fillColorblind: string

ReadonlyfillColors

fillColors: readonly string[]

Allows for a gradient of different colors.

Readonlyid

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")

Readonlyname

name: string

ReadonlynoClueColors

noClueColors: boolean

ReadonlynoClueRanks

noClueRanks: boolean

ReadonlyoneOfEach

oneOfEach: boolean

Readonlypip

pip: string

The symbol that represents this suit.

Readonlyprism

prism: boolean

Readonlyreversed

reversed: boolean

Settings

Member Visibility

On This Page

Properties