| All subtypes |
game |
The Game object itself |
An instance of the free.jin.Game class |
|
gameType |
A short string describing the relation of the game to the user |
"my" (a game either played or examined by the user), "observed", "isolated" (the user sees only a snapshot of the game, such as obtained, for example, with the "sposition" command) |
|
initialPosition |
The initial position in the game |
An instance of the free.chess.Position class |
|
variant |
The name of the wild variant |
"Chess", "Kriegspiel", "Atomic" |
|
whiteName |
The nickname/handle of the player with the white pieces |
"fpawn", "Darooha" |
|
blackName |
The nickname/handle of the player with the black pieces |
"POTZY", "fpawn" |
|
whiteTime |
The initial time on the clock of the player with the white pieces, in minutes |
1, 5, 15 |
|
blackTime |
The initial time on the clock of the player with the black pieces, in minutes |
2, 3, 60 |
|
whiteInc |
The increment to the clock of the player with the white pieces after each move, in seconds |
0, 2, 5 |
|
blackInc |
The increment to the clock of the player with the black pieces after each move, in seconds |
1, 3, 20 |
|
whiteRating |
The rating of the player with the white pieces |
1605, 1900, 2727 |
|
blackRating |
The rating of the player with the black pieces |
1456, 0, 2102 |
|
whiteTitle |
The title(s) of the player with the white pieces |
"GM", "WIM", "", "FM", "DM", "C", "U" |
|
blackTitle |
The title(s) of the player with the black pieces |
"GM", "WIM", "", "FM", "DM", "C", "U" |
|
isGameRated |
Is the game rated? |
true, false |
|
ratingCategory |
The rating category of the game |
"Bullet" , "Blitz", "Standard", "Wild", "Loser's" , "Bughouse", "Crazyhouse", "5-minute" , "1-minute" , "Lightning" , "Suicide" , "Losers" , "Atomic"  |
|
isPlayed |
Is the game played? (it can also be examined) |
true, false |
|
isTimeOdds |
Is the game a time odds game? |
true, false |
| Move |
move |
The made move |
An instance of the free.chess.Move class, and if the game is plain chess (not wild), an instance of the free.chess.ChessMove class |
| Takeback/Backward |
takebackCount |
The amount of plies (half-moves) taken back |
1, 2, 5, 999 |
| Board Flip |
isFlipped |
Is the board shown with the black pieces at the bottom? |
true, false |
| Illegal Move Attempt |
illegalMove |
The attempted illegal move |
An instance of the free.chess.Move class, and if the game is plain chess (not wild), an instance of the free.chess.ChessMove class |
| Clock Update |
player |
The player whose clock is being updated |
"white", "black" |
|
time |
The amount of time on the clock, in milliseconds |
14340, 600000, 500 |
|
isClockRunning |
Is the clock running? |
true, false |
| Offers |
offerType |
The type of the offer |
"draw", "abort", "adjourn", "takeback" |
|
isOffered |
True if the offer has just been made, false if removed |
true, false |
|
player |
The player who made the offer |
"white", "black" |
|
takebackCount |
The amount of plies offered to take back. Only valid if the type of the offer is "takeback" |
1, 2, 3 |
| Other Position Change |
newPosition |
The new position |
An instance of the free.chess.Position class |
| Game End |
gameResult |
The result of the game |
For games you are playing: "win", "loss", "draw", "unknown". For other games: "1-0", "0-1", "1/2-1/2" or "unknown". |
| Available for all subtypes, but only if the user is playing the game |
myName |
The nickname/handle of the user |
"EeEk", "ChessCracker" |
|
oppName |
The nickname/handle of the opponent |
"MAd", "Lyon" |
|
myTime |
The amount of time on the user's clock at the beginning of the game, in minutes |
5, 1, 10 |
|
myInc |
The amount of time the user's clock is incremented by after each move, in seconds |
0, 1, 10 |
|
oppTime |
The amount of time on the opponent's clock at the beginning of the game, in minutes |
5, 1, 10 |
|
oppInc |
The amount of time the opponent's clock is incremented by after each move, in seconds |
0, 1, 10 |
|
myRating |
The user's rating |
1873, 2304, 0 |
|
oppRating |
The opponent's rating |
2376, 0, 1202 |
|
myTitle |
The user's title(s) |
"GM", "WIM", "", "FM", "DM", "C", "U" |
|
oppTitle |
The opponent's title(s) |
"GM", "WIM", "", "FM", "DM", "C", "U" |
|
userPlayer |
The color of the user |
"black", "white" |