Interface SuitJSON

This is similar to Suit, but it only has primitive types.

interface SuitJSON {
    abbreviation?: string;
    allClueColors?: boolean;
    allClueRanks?: boolean;
    clueColors?: readonly string[];
    createVariants?: boolean;
    displayName?: string;
    fill?: string;
    fillColors?: readonly string[];
    id: string;
    name: string;
    noClueColors?: boolean;
    noClueRanks?: boolean;
    oneOfEach?: boolean;
    pip: string;
    prism?: boolean;
}

Properties

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

Properties

Optional Readonlyabbreviation

abbreviation?: string

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

Optional ReadonlyallClueColors

allClueColors?: boolean

Optional ReadonlyallClueRanks

allClueRanks?: boolean

Optional ReadonlyclueColors

clueColors?: readonly string[]

Optional ReadonlycreateVariants

createVariants?: boolean

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

Optional ReadonlydisplayName

displayName?: string

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

Optional Readonlyfill

fill?: string

The background color of cards of the suit.

Optional 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

Optional ReadonlynoClueColors

noClueColors?: boolean

Optional ReadonlynoClueRanks

noClueRanks?: boolean

Optional ReadonlyoneOfEach

oneOfEach?: boolean

Readonlypip

pip: string

The symbol that represents this suit.

Optional Readonlyprism

prism?: boolean

Settings

Member Visibility

On This Page

Properties