Information displayed to the player in a popup over the bid
The text displayed for the bid
The numeric value of the bid
Explains a bid in the bidding box. Information is used to format a popup. Used primarily in Bridge.
Base values for each game’s bids. Each game gets a bid space of 100 or more.
Games typically have a Bid class or helper methods to convert from the global bid space to bids that make sense for the game.
Defines values in Euchre’s BidSpace.
Helper for dealing with bids in 500.
Object details a Pinochle Meld
Points for the meld
HTML detail of the meld.
The cards comprising the meld.
The ranks of cards.
The enum values do not necessarily correspond to the numeric rank of the card in any given game. Use the game’s RankSort method to sort cards by rank.
The color of a card. Computed from the suit.
Object representing the suit and rank of a card.
The suit of a card.
The rank of a card
Object representing a card.
Extends SuitRank with an isTrump flag and helpers.
Flag indicates whether the card is of the trump suit.
Helper property that returns true if the standard rank of the card is Jack through Ace.
The computed color of the card.
Method to determine if the suit and rank of card matches this card.
This class does not implement IEqualityComparer so use method to compare cards for equality.
Utility class for creating decks.
Returns the size of a deck of the given type.
Enum of deck types.
Collection of Cards with helper methods.
Constructs a Hand object from the string representation of cards.
Returns a serialized representation of this Hand.
Bridge variations: Chicago, Rubber, MiniBridge, or Duplicate
Bridge bidding schemes: SAYC or Custom.
MiniBridge choice of legal bids.
Chicago bridge partscore handling: Bonus or Carryforward.
Game options for Bridge
Whether undo is allowed in the game.
When allowUndo is false, this determines if only bids may be undone.
Bidding scheme being used.
Bidding style being used.
How partscores are handled in Chicago bridge.
The type of deck used for these options
If true, we rotate the hands to give the practice player the hand with the highest HCP.
Flag whether to score honors bonus.
Flag indicating whether the bot will play with transfers (SAYC only).
Fixed number of deals in rubber bridge. 0 = unlimited.
Number of rubbers to play in rubber bridge.
Bridge game variant: Chicago or rubber.
Flag indicating whether the bot will play with the Cappelletti convention (SAYC only).
Euchre bidding style
Euchre kind of first bid (either just level or level and suit together).
Trump and bid behavior when a Joker is the up card
When Trump can be led
If and when a misdeal may be called
When a bidder may order-up trump during the first round of bidding
Whether bidding is classic Euchre style or Bid Euchre style.
Game options for Euchre
Whether bidding is classic or trick-based.
Indicates whether and when game allows calling misdeal
Indicates the game allows a No Trump bid.
Indicates the game allows high/low No Trump bids.
Indicates that the lead play is to the left of an “alone” bidder.
Indicates the player who goes alone must take all 5 tricks or be Euchre’d.
A successful “alone” bid is worth 2 points instead of 4.
Indicates if bidding continues until everyone passes (Bid Euchre only)
Indicates if level and suit are bid together in a single bid instead of separately (Bid Euchre only)
Indicates that a player going alone exchanges 1 card with their partner.
When a bidder may order-up trump in the first round of bidding.
Makes bidding start with the dealer instead of the dealer’s left-hand opponent.
Requires that the partner of the dealer bid “alone” or pass. They cannot order up the suit.
Popular with players in Canada.
The number of cards in the deck excluding the joker.
Joker is added if withJoker option is true.
Indicates the game prompts to defend alone if opponents went alone.
When set, SuggestBid may be asked to decide defend alone or pass if opponents went alone.
Indicates the game prompts to defend alone anytime.
When set, SuggestBid may be asked to decide defend alone or pass.
The type of deck used for these options
Indicates the game offers players with 3 or more of the lowest 2 cards to swap them for 3 undealt cards.
When set, SuggestBid may be asked to decide to go under or pass.
Trump and bid behavior when a Joker is the up card
When trump may be led
Indicates if the winning bidder leads the first trick, unless alone with aloneLeadsLeft enabled (Bid Euchre only)
The minimum number of tricks that can be bid (Bid Euchre only)
When true, no alone bids are offered
The number of decks to use.
Controls whether we offer the Alone Call for 2 bid. Bid Euchre only.
When set, a successful make scores only the value of the bid. Bid Euchre only.
Requires the dealer to bid if the other players passed during the second round of bidding
Indicates the game scores taking no tricks as a 4-point Super Euchre for the opponents.
Requires the bidder take 4 cards to get 1 point or they are Euchre’d.
Indicates the deck contains a joker.
Indicates the bid winner gets a kitty. Bid Euchre only.
The 500 game variation.
Values for when players can bid Nullo/Misère
The points awarded for achieving Open Nullo/Misère
This also impacts which bids can be made following an Open Nullo/Misère bid
The points awarded for achieving Nullo/Misère
This also impacts which bids can be made following a Nullo/Misère bid
When a player bidding Nullo/Misère gets the kitty/widow.
When a player who has previously passed may bid again.
Game options for 500
Indicates when, if ever, a bidder who passed may bid.
Indicates bidder wins if both teams go over 500.
Size of the deck
deckSize is 40 plus number of cards in kitty/widow
The type of deck used for these options
Indicates that the jokers are low when bid is misère or open misère
Indicates the high bidder may raise their bid after everyone else passes.
Indicates that to be declared the winner, you must have been the bidder.
Determines if a Nullo/Misère bidder gets the kitty/widow.
The points associated with a Nullo/Misère bid.
Indicates that Open Nullo/Misère may only be bid after someone has bid at the 8-level.
The points associated with an Open Nullo/Misère bid.
Indicates whether an 8♠ bid overbids a Nullo/Misère bid.
Variation of the game. Mostly impacts defaults and terminology. In the American version, the 6-level bids of the first two players to bid are special bids called “inkles.”
Determines when Nullo/Misère can be bid.
Returns the effective suit of a card, which may be different than its standard suit. Used to return the proper rank for jokers and off-jacks
The card whose effective suit we return
The current trump suit
The effective suit of the card
Returns a card’s rank sort order given the trump suit and current options
The card whose rank sort we return
The current trump suit
An integer that can be used to compare the ranks of two cards
An enum value representing the game.
The mode of the game
What chat, if any, is available in the game
Who can see a Join game
Enum for the number of fixed deals in the game
Whether the game is played for a fixed number of deals to the game-over score
Game options common to all games.
If true, decks can be uploaded in Join and Practice games.
If true, client autoplays forced cards -- overriding the user’s setting of the same. If false, user’s setting is used.
If true, allows watchers to watch face-up
The amount of chat, if any, available to players in the game.
The number of deals, if playing a fixed number
The game-over score
Mode of the game: Play, Join, Practice or Compete
Who can see this game, if it’s a Join game
If true, the display of points accumulated by player name is hidden.
Indicates whether this is a Club event game
Flag indicating that this game was created using the More Games/Rules form
Used only to award the player the “House Rules” achievement
Flag indicating that all cards in a Join or Practice game are displayed face-up
Flag indicating that this game is a practice lesson
Flag indicating that this game is a practice lesson being recorded
Indicates whether this is team (partnership) or solo (individual) game
true can mean a 2- or 3-player partnership
Modifies isPartnership to indicate 2 teams of half the number of players each
Currently only used in a 6-player game for 2 teams of 3
Flag to disable suggestions in the game
Flag to disable watching the game
The number of players in the game
Indicates whether the game is played for a fixed number of hands or to a game-over score
Flag to randomly assign seats at the start of the game
Indicates whether the game uses “Review last deal”
Scheduled start time (UTC) for a future game
null means game is not scheduled
The number of seconds the player has to bid or pass; zero for unlimited
The number of seconds the player has to play a card; zero for unlimited
The buy-in stakes for a Compete mode game
Indicates that the game uses duplicate scoring
How shoot moon is scored in Hearts
Passing pattern for Hearts
The player that leads a Hearts hand
The possible values of the Hearts dumpPoints option
Game options for Hearts
Option indicating whether points can be played on the first trick.
The type of deck used for these options
Flag indicating that capturing the Jack of Diamonds is worth -10 points.
Cannot be set if jackOfDiamondsForMinus5 is set.
Flag indicating that capturing the Jack of Diamonds is worth -5 points.
Cannot be set if jackOfDiamonds is set.
The value of the Jack of Diamonds: 0, -5 or -10.
The maximum hand score. 13 or 26 depending on whether the Queen of Spades is worth 13.
Indicates that 50 points are subtracted from scores of exactly a multiple of 100 points
Indicates that 50 points are subtracted from scores of exactly a multiple of 50 points
Flag disables the Queen of Spades if set
The passing pattern
Indicates that ♠Q may not be dumped until Hearts is broken
Indicates that ♠Q breaks Hearts the same as the first dumped Heart
How shoot the moon is scored
If set in a team game, shooting the moon requires that just one player shoots
The various Oh Hell deal patterns
When Trump can be led
How failed (not on-the-nose) bids are scored
How failed (not on-the-nose) bids are scored
Game options for Oh Hell
How failed bids are scored
The type of deck used for these options
Indicates “hook rule” is in effect. This requires the sum of the bids to not equal the number of cards dealt
When trump may be led
Indicates that all players bid simultaneously
The ramp end number of cards dealt. Make equal to ramp switch for a one-direction ramp.
The ramp start number of cards dealt
The starting increment. Either -1 or 1. Computed from rampStartAt and rampSwitchAt.
The ramp switch number of cards dealt
A computed value of the total hands in the game using the current deal pattern
The points per trick added to 10 for a successful bid
The deal pattern
An enum of the supported Pinochle melds
A helper class for working with Pinochle Melds
A class representing a single Pinochle Meld
The cards comprising the meld
The group of the meld
The meld type
Count of melds of this type
The display name of this meld
Point value of the meld given the PinochleOptions passed
Pinochle bidding style
Number of cards in the kitty
If and when a mercy rule applies
Who passes, if anyone
Trick play requirements
What ranks are valuable. Sum is always 30 points per suit (3 if modern scoring)
The scoring scheme in use
Game options for Pinochle
True means a player with 5 or more 9s can call a misdeal as their first bid. Single deck only.
Causes the game to ask if the declarer want to shoot the moon
Indicates bidder wins if both teams go over the game-over score
The increment for the bids: 10 or 1
The bid style: auction or single
The value of the last trick taken: 20 for double deck, 10 for single
Indicates the game is double-deck
Indicates a 300-point meld (30 for modern) is scored for a double royal marriage
The type of deck used for these options
Whether a kitty is in use and, if so, how big
int size of the kitty
Indicates that the declarer must have a marriage or better in trump or they automatically fold following melding
Computed maximum points that can be captured during trick-taking
The time, in milliseconds, to display each meld during meld display
Multiplier for the meld value: 10 or 1
When a mercy rules applies, if ever
Indicates the declaring team must have at least 20 points (200 in classic scoring) in meld or they automatically fold following melding
Indicates a team must take at least 20 points (200 in classic scoring) during trick-taking or they score zero
The minimum bid
Requires the winner(s) to be either the bidder(s) who made their bid or the opponents who set the bidder(s)
Requires a player void in the led non-trump suit, must play trump if they have any
Two pinochles score 80 points (8 for modern scoring) instead of 300 (30 for modern) for a double pinochle
True means we will not ask if players wish to throw in their hand
Adds a “Pass with Help” bid (unimplemented)
The number of cards passed when whoPasses != PinochlePass.NoPass
Adds three more meld types: a 190-point “Run With Extra King,” a 190-point “Run With Extra Queen,” and a 230-point “Run With Extra Marriage.” If a player has one of these, they do not get credit for a simple run. Also, if both this option and “Double Royal Marriage” is on, “Double Royal Marriage” beats “Run With Extra Marriage.” Single deck only.
The scoring scheme: Classic or Modern. Classic values are 10x the Modern values.
Requires the dealer to bid if the other players passed during the first round of bidding
Whether players must head tricks and which ones.
Divisor for the trick score: 10 or 1
The value of the last trick adjusted for scoring style
The ranks that count
Who passes to their partners, if anyone
Indicates whether players can discard and refill after bidding
Available only in 4-, 5-, and 6-point; always “NonTrump” in 9-point.
Indicates when players can play trump
The point value of the Pitch game
Each point variation presents different options. The higher-point games are quite different from the lower-point games.
Who leads in the 5-player “call your partner” game
Game options for Pitch
Allows the dealer to become the pitcher by matching the highest bid
Type of deck being used
Deducts twice the bid from the score if the player takes points totaling exactly twice their bid
Indicates that players may discard non-trump and refill their hand
Indicates who leads in the 5-player “call your partner” game
The type of deck used for these options
Indicates whether to give additional cards to the pitcher, after which they discard down to 6.
In 4-, 5-, 6-, and 9-point games this is a 3-card kitty. In 7-, 10-, 11-, and 13-point games this is all cards remaining in the deck and is always true unless playing with 5 or more players.
Indicates if the point for the low trump card goes to the team that captures it (taker). If false, low goes to the team that was dealt it (holder).
The minimum bid
Indicates players only earn points when you are the pitching team
Indicates that you must bid to win. May be modified by setOpponentsAndWin so that either bidding or setting wins.
Indicates that we offer the shoot bid
Requires the pitcher to lead trump on the first trick
When you may play trump and if only trump is played
Indicates that the pitching team only earns points equal to their bid
Indicates that you can win by setting your opponents. Used with mustBidToWin to result in Bid/Set to win.
Indicates that shooting means you must take all tricks; otherwise, you just need to take all points.
Requires the dealer to bid if the other players passed
Indicates that one point is awarded for capturing the 10 of trump and there is no “game” point
The point variation of Pitch
When Spades can be led
When nil bids are offered
When blind bids are offered
How failing to make bid is scored
If and when a mercy rule applies
The possible values of the nilOrZero option.
The possible values of the renege option.
The possible variations of Spades.
Game options for Spades
Flag indicating that bids cannot the number of tricks available, e.g., 13
Flag indicating the tricks taken in the first hand determine scores
If and when blind nils are offered
If and when blind bids other than nil are offered
The number of cards a blind nil bidder exchanges with their partner
How failed bids are scored
The type of deck used for these options
The high bidder (or first going left from dealer of equal high bids) leads.
When spades may be led
The number of sets that trigger an automatic loss
Players must play their lowest club on the first trick, if possible.
When a mercy rules applies, if ever
The minimum team bid
The minimum non-nil blind bid
Indicates whether overtricks on a failed Nil are (1) directly counted as bags, (2) added to the tricks taken by the Nil bidder’s partner, or (3) don’t take bags and aren’t added to the team score.
Indicates whether Nil or Zero is offered as a bid.
The number of cards a nil bidder exchanges with their partner
The point value of making a nil bid
When the player can bid Nil
Players may not trump-in on the first trick
Whether players are allowed to renege and what the penalty is
Indicates whether we subtract 100 points when 10 bags are accumulated across hands. False means there are no bags; overtricks simply add 1 point.
Indicates whether a bid of 10 scores +/- 200 points.
The variation of Spades
Whist variation
The kitty size
If/when we show the contents of the kitty to other players
Game options for Whist
Indicates that the cards in the kitty are added to the high bidder’s hand. They then discard an equal number of cards.
Indicates the high bidder leads the first trick. Otherwise, the player to the left of the dealer leads.
The number of cards in the deck
Indicates the defending team is given points for tricks they take over 6. Otherwise, only the bidding team earn points.
Indicates scores an NT bid at twice the normal value for its level.
Indicates if an extra hand should be played if the teams are tied at the end of the game. Only applies if playing a fixed number of hands.
Indicates that a successful defense against NT does not score double. Only applies if both defensiveScoring and doubleForNT are true.
The type of deck being used. Depends on the size of the kitty.
Indicates a bonus is awarded for holding 3 or 4 honors
Indicates the low cards are considered the highest rank cards
The kitty size enum value
The int kitty size
The number of sets that trigger an automatic loss
Indicates a low (downtown) bid beats a high (uptown) bid of the same level
The minimum bid
Indicates the defending team is given points for the bid if the bidding team is set. Otherwise, points for the bid are subtracted from the bidding team’s score if they're set.
Whether and when the kitty is shown
The variation of Whist: Classic or Bid
Base class for a player. Has only the information needed by the bots' suggest methods.
The numeric bid value in BidSpace.
This value must be transformed into the bid space of a particular game in order for it to make sense. Games where bids consist of a suit and a value encode them in this 32-bit value.
A list of player’s bid values in order.
Flag indicating that this player has folded.
The running game score of this player.
Bridge encodes the parts of the score into bit fields in this 64-bit long.
If this is the first void off-suit a player has shown, we assume the sloughed suit is a “good suit” (they either have boss or are now void in trump).
This is still set when trumping in, but ignored until an off-suit is sloughed.
The hand score, or number of tricks taken this hand by this player.
Flag computed from Bid and Folded that indicates whether the player is currently participating in the play of the hand.
The cards played by this player thus far in this hand.
The seat position of this player. Seats are numbered starting with 0. Can be used to determine partners and opponents.
The suits we belive this player is void in based on not following suit.
Object POSTed to the web bot endpoint for suggest bid.
Return value from the endpoint is a BidBase.
The bid the existing cloud code would suggest.
The seat of the dealer.
The cards in the player’s hand.
List of legal bids. The BidBase returned by the SuggestBid method must be in this list.
All the players in the game. Can be used to identify your partners in 6-player games.
List of whether each player is vulnerable by seat.
Sorts the cards in this object so that bot methods that rely on sort order return consistent results.
The object on which it was invoked
Object POSTed to the web bot endpoint for suggest card.
Return value from the endpoint is a Card.
The card the existing cloud code would suggest.
The cards that have already been played in the hand.
The player seat and card of the cards that have already been played in the hand in the order they were played.
The current trick taking card, if any. May be null.
Flag indicating whether the player’s partner is currently taking the trick.
The cards that are legal to play. The card returned by the SuggestCard method must be in this list.
All the players in the game. Can be used to identify your partners in 6-player games.
Cards in the current trick, if any.
The player who is currently taking the trick, if any.
Sorts the cards in this object so that bot methods that rely on sort order return consistent results.
trick is not sorted; the cards in the trick are in the order they were played.
The object on which it was invoked
Object POSTed to the web bot endpoint for suggest discard.
Return value from the endpoint is List<Card>. The number of cards suggested depends on the game and its options.
The discard the existing cloud code would suggest.
The cards in the discarding player’s hand.
Sorts the cards in this object so that bot methods that rely on sort order return consistent results.
The object on which it was invoked
Object POSTed to the web bot endpoint for suggest pass.
Return value from the endpoint is a Hand.
The pass the existing cloud code would suggest.
The cards in the passing player’s hand.
The number of cards expected to be returned.
Sorts the cards in this object so that bot methods that rely on sort order return consistent results.
The object on which it was invoked
Base class of SuggestBidState, SuggestCardState, SuggestDiscardState, and SuggestPassState
The game rules options. T will be one of the GameOptions classes.
The player being asked to play the card.
The hand member of the OtherPlayer object contains the cards remaining in the player’s hand.
The suit of trump. Suit.Unknown represents a “No Trump” bid or game without trump.
Copyright © 2021-2025 Trickster Cards, Inc. All rights reserved.
Base class of Bid object used to send bid, bid text, and other info to the client.
Includes a set of constants for bids that are not the winning bid.