# HG changeset patch # User Steve Losh # Date 1458828212 0 # Node ID 2fbcca0516fd272ce1de5a04ac414faa814bc005 # Parent 0f3f3fce275197817566cef82da33fdfb65e586b Render initarg/initforms into docs diff -r 0f3f3fce2751 -r 2fbcca0516fd docs/03-reference.markdown --- a/docs/03-reference.markdown Wed Mar 23 23:04:20 2016 +0000 +++ b/docs/03-reference.markdown Thu Mar 24 14:03:32 2016 +0000 @@ -20,58 +20,67 @@ #### Slot NAME -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `STRING` +* Initarg: `:NAME` +* Initform: `"CL-GGP"` * Reader: `PLAYER-NAME` The name of the player. #### Slot PORT -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `(INTEGER 0)` +* Initarg: `:PORT` +* Initform: `9999` * Reader: `PLAYER-PORT` The port the HTTP server should listen on. #### Slot MATCH-ROLES -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `(OR NULL LIST)` +* Initform: `NIL` * Reader: `PLAYER-MATCH-ROLES` A list of the roles for the current match. Feel free to read and use this if you like. **Do not modify this.** #### Slot START-CLOCK -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `(OR NULL (INTEGER 1))` +* Initform: `NIL` The start clock for the current game. **Do not touch this.** Use the `timeout` value passed to your methods instead. #### Slot PLAY-CLOCK -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `(OR NULL (INTEGER 1))` +* Initform: `NIL` The play clock for the current game. **Do not touch this.** Use the `timeout` value passed to your methods instead. #### Slot MESSAGE-START -* Allocation: INSTANCE +* Allocation: `:INSTANCE` * Type: `(OR NULL (INTEGER 0))` +* Initform: `NIL` The (internal-real) timestamp of when the current GGP message was received. **Do not touch this.** Use the `timeout` value passed to your methods instead. #### Slot CURRENT-MATCH -* Allocation: INSTANCE +* Allocation: `:INSTANCE` +* Initform: `NIL` The ID of the current match the player is playing, or `nil` if it is waiting. **Do not touch this.** #### Slot SERVER -* Allocation: INSTANCE +* Allocation: `:INSTANCE` The Clack server object of the player. **Do not touch this.** Use `start-player` and `kill-player` to start/stop the server safely.