e0132bd24efe
cl-ggp: Update site.
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Thu, 24 Mar 2016 14:03:46 +0000 |
parents | ef26a5dd830f |
children | 1f003474d0d9 |
branches/tags | (none) |
files | cl-ggp/reference/index.html |
Changes
--- a/cl-ggp/reference/index.html Wed Mar 23 23:00:35 2016 +0000 +++ b/cl-ggp/reference/index.html Thu Mar 24 14:03:46 2016 +0000 @@ -48,51 +48,60 @@ <p>The base class for a GGP player. Custom players should extend this.</p> <h4 id="slot-name">Slot NAME</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>STRING</code></li> +<li>Initarg: <code>:NAME</code></li> +<li>Initform: <code>"CL-GGP"</code></li> <li>Reader: <code>PLAYER-NAME</code></li> </ul> <p>The name of the player.</p> <h4 id="slot-port">Slot PORT</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>(INTEGER 0)</code></li> +<li>Initarg: <code>:PORT</code></li> +<li>Initform: <code>9999</code></li> <li>Reader: <code>PLAYER-PORT</code></li> </ul> <p>The port the HTTP server should listen on.</p> <h4 id="slot-match-roles">Slot MATCH-ROLES</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>(OR NULL LIST)</code></li> +<li>Initform: <code>NIL</code></li> <li>Reader: <code>PLAYER-MATCH-ROLES</code></li> </ul> <p>A list of the roles for the current match. Feel free to read and use this if you like. <strong>Do not modify this.</strong></p> <h4 id="slot-start-clock">Slot START-CLOCK</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>(OR NULL (INTEGER 1))</code></li> +<li>Initform: <code>NIL</code></li> </ul> <p>The start clock for the current game. <strong>Do not touch this.</strong> Use the <code>timeout</code> value passed to your methods instead.</p> <h4 id="slot-play-clock">Slot PLAY-CLOCK</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>(OR NULL (INTEGER 1))</code></li> +<li>Initform: <code>NIL</code></li> </ul> <p>The play clock for the current game. <strong>Do not touch this.</strong> Use the <code>timeout</code> value passed to your methods instead.</p> <h4 id="slot-message-start">Slot MESSAGE-START</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> <li>Type: <code>(OR NULL (INTEGER 0))</code></li> +<li>Initform: <code>NIL</code></li> </ul> <p>The (internal-real) timestamp of when the current GGP message was received. <strong>Do not touch this.</strong> Use the <code>timeout</code> value passed to your methods instead.</p> <h4 id="slot-current-match">Slot CURRENT-MATCH</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> +<li>Initform: <code>NIL</code></li> </ul> <p>The ID of the current match the player is playing, or <code>nil</code> if it is waiting. <strong>Do not touch this.</strong></p> <h4 id="slot-server">Slot SERVER</h4> <ul> -<li>Allocation: INSTANCE</li> +<li>Allocation: <code>:INSTANCE</code></li> </ul> <p>The Clack server object of the player. <strong>Do not touch this.</strong> Use <code>start-player</code> and <code>kill-player</code> to start/stop the server safely.</p> <h3 id="kill-player-function">KILL-PLAYER (function)</h3>