// $Id: Reference.htm 119 2004-05-16 00:02:24Z ggs_mburo $ // This is a GGS file, licensed under the GPL ODK Reference

ODK Reference

GGS Classes

CGGSAliasOne alias, parsed from the 'alias' message
CGGSWhoUserOne user, parsed from the 'who' message

GGS Messages

CMsgBase message class
CMsgGGSAliasResponse to an 'alias' command
CMsgGGSErrGGS error message
CMsgGGSFingerResponse to a 'finger' command
CMsgGGSHelpResponse to a 'help' command, sometimes also sent on startup
CMsgGGSTellSomeone is talking to you
CMsgGGSUnknownGGS sent an unknown message
CMsgGGSUserUser logs in to/out of GGS

/os Classes

COsBoardboard, board type, and color to move
COsBoardTypeboard shape and size
COsClockremaining time for one player
COsFingerRatingrating type and rating for one player from a finger message
COsGameall information for one game
COsMatchTypeboard type and match type (anti, synchro, etc.)
COsMatchInformation about a match (but not including game data)
COsMovepass or square to play
COsMoveListvector of COsMoveListItems
COsMoveListItemmove, time taken, and evaluation
COsPlayerInfoname and rating
COsPositionboard, clocks, komi stuff
COsRankDataone line of response from the 'rank' command
COsRatingrating and standard deviation in rating
COsRatingTypeboard type, anti, rand
COsRequesta match challenge
COsStoredGameinformation about a stored game

/os Message classes

CMsgOsBase /os message class
CMsgOsCommentSomeone commented on a game
CMsgOsEndSent at the end of each game of a synchro match
CMsgOsErr/os error message
CMsgOsFingerResponse to a 'finger' command
CMsgOsJoinYou have joined (are playing or watching) a game
CMsgOsMatchDeltaA match starts or ends
CMsgOsRankResponse to a 'rank' command (get a player's ranking)
CMsgOsRatingUpdateRating update after a rated game ends
CMsgOsRequestDeltaSomeone challenged someone else to a match
CMsgOsStoredResponse to a 'stored' command (unfinished games)
CMsgOsTopResponse to a 'top' command (list top-ranked players)
CMsgOsTrustViolationTrust violation in a game
CMsgOsUnknownUnknown /os message
CMsgOsUpdateSomeone moved in a game you are playing/watching
CMsgOsWatchResponse to a 'watch' command (# of players watching games)
CMsgOsWatchChangeSomeone has started/stopped watching a game you are playing

Handlers for /os messages

Partial list

HandleOsGameOverA game ended and you were watching or playing
HandleOsMatchDeltaA match starts or ends
HandleOsRequestDeltaSomeone challenged someone else to a match