Reference
President
import { … } from "@johnmorrisdotca/toranpu/president";3.5 kB minified and gzipped, with everything it imports (measured with esbuild)
President: its rules, its computer player and its saved-game format.
Exports
| Name | Kind | What it is |
|---|---|---|
afterTurn | function | Whose move it is after from played or passed: the next seat still in that has not passed, or — when nobody is left to answer — the trick cleared and led by whoever played last, or the next seat after them still in. |
ClimbMove | type | Cards played to beat the table (or lead), or a pass. |
ClimbPlay | type | What is on the table: the last cards played to this trick, and whose they were. |
ClimbTrick | type | The part of a climbing game's state the trick machinery moves: every climbing game carries these. |
decodePresident | function | Text read back into the game of President it records, by playing every move again through the rules; null for anything they cannot play out. |
encodePresident | function | A game of President as text: its table, its seed and its moves, never a hand. |
freshTrick | function | A fresh trick to lead, for a new deal. |
isClimbMove | function | A move read back from storage, checked for shape: cards to play, or a pass. |
laid | function | The trick after seat lays these cards on it: out of their hand, on the table, and seen by all. |
nextRound | function | The next seat round from from (not counting it) that wanted accepts, or null when none does. |
passedOn | function | The trick after seat passes. |
playPresident | function | The game after that move, with the move added to its record, or null for a move the rules refuse. |
PRESIDENT_RULES | constant | President as one CardGameRules: everything a table asks of the game. |
presidentComputer | function | The move a computer in the seat to play makes: always one the rules allow. |
PresidentGame | type | A GAME OF PRESIDENT: its table and moves (what is kept), and the round they have reached. |
presidentMayPlay | function | Whether these cards may be played now by the seat to play: one rank, one to four of it, higher than the table's and as many. |
PresidentMove | type | A climbing move, or the cards a President or Vice-President hands back down at the start of a round. |
presidentMoves | function | Every move the seat to play may make now; none once the game is over. |
presidentRank | function | A rank's height: the three lowest (0), the two highest (12). |
PresidentSwap | type | Cards handed over at the start of a round: the best cards up, whatever the receiver chooses back down. |
presidentSwapCount | function | How many cards the President and the Beggar swap: two, or one when only three are at the table. |
presidentTitle | function | A seat's title from a round's finishing order. |
PresidentTitle | type | Each seat's title from a round's finishing order: 0 President, 1 Vice-President, the last two Vice-Beggar and Beggar, everybody else a Citizen. |
presidentView | function | The part of the game the seat to play can see, which is all its computer is given. |
PresidentView | type | What one seat can see of a game of President: its own hand, the table, and what has been said and shown. |
presidentWinners | function | The most points wins; level on the most shares it. |
seatsIn | function | The seats still holding cards. |
sortPresident | function | Cards in President's order, lowest first, suits in a fixed order only so a hand always sorts the same way. |
startPresident | function | A new game of President for these players (one name a seat) at this size, dealt from the seed dealt, or null for a table President is not offered for. |