summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Scripts.html
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@vistahigherlearning.com>2019-06-04 20:49:16 -0400
committerDavid Thompson <dthompson@vistahigherlearning.com>2019-06-04 20:49:16 -0400
commit279f17ac0e1b3d019c2b294098e834d249376686 (patch)
tree47be849d3b35635d167e00cd8448815a75167a23 /manuals/chickadee/Scripts.html
parent7b808b9268ec735a7a176d10bf1887b3fa66d13e (diff)
Update chickadee manual.
Diffstat (limited to 'manuals/chickadee/Scripts.html')
-rw-r--r--manuals/chickadee/Scripts.html29
1 files changed, 13 insertions, 16 deletions
diff --git a/manuals/chickadee/Scripts.html b/manuals/chickadee/Scripts.html
index c9939f5..b8472dc 100644
--- a/manuals/chickadee/Scripts.html
+++ b/manuals/chickadee/Scripts.html
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Copyright (C) 2017 David Thompson davet@gnu.org
+<!-- Copyright (C) 2017, 2018, 2019 David Thompson davet@gnu.org
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -13,6 +13,8 @@ A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+* Chickadee: (chickadee). Game programming toolkit for Guile.
+
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
@@ -141,59 +143,54 @@ script is returned that can be used to cancel it when desired.
</pre></div>
<dl>
-<dt><a name="index-spawn_002dscript"></a>Procedure: <strong>spawn-script</strong> <em><var>thunk</var></em></dt>
+<dt><a name="index-spawn_002dscript"></a>Procedure: <strong>spawn-script</strong> <em>thunk</em></dt>
<dd><p>Apply <var>thunk</var> as a script and return a handle to it.
</p></dd></dl>
<dl>
-<dt><a name="index-script"></a>Syntax: <strong>script</strong> <em><var>body</var> &hellip;</em></dt>
+<dt><a name="index-script"></a>Syntax: <strong>script</strong> <em>body &hellip;</em></dt>
<dd><p>Evaluate <var>body</var> as a script and return a handle to it.
</p></dd></dl>
<dl>
-<dt><a name="index-script_003f"></a>Procedure: <strong>script?</strong> <em><var>obj</var></em></dt>
+<dt><a name="index-script_003f"></a>Procedure: <strong>script?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a script handle.
</p></dd></dl>
<dl>
-<dt><a name="index-script_002dcancelled_003f"></a>Procedure: <strong>script-cancelled?</strong> <em><var>obj</var></em></dt>
+<dt><a name="index-script_002dcancelled_003f"></a>Procedure: <strong>script-cancelled?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> has been cancelled.
</p></dd></dl>
<dl>
-<dt><a name="index-script_002drunning_003f"></a>Procedure: <strong>script-running?</strong> <em><var>obj</var></em></dt>
+<dt><a name="index-script_002drunning_003f"></a>Procedure: <strong>script-running?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> has not yet terminated or been
cancelled.
</p></dd></dl>
<dl>
-<dt><a name="index-script_002dcomplete_003f"></a>Procedure: <strong>script-complete?</strong> <em><var>obj</var></em></dt>
+<dt><a name="index-script_002dcomplete_003f"></a>Procedure: <strong>script-complete?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> has terminated.
</p></dd></dl>
<dl>
-<dt><a name="index-cancel_002dscript"></a>Procedure: <strong>cancel-script</strong> <em><var>co</var></em></dt>
+<dt><a name="index-cancel_002dscript"></a>Procedure: <strong>cancel-script</strong> <em>co</em></dt>
<dd><p>Prevent further execution of the script <var>co</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-yield"></a>Procedure: <strong>yield</strong> <em><var>handler</var></em></dt>
+<dt><a name="index-yield"></a>Procedure: <strong>yield</strong> <em>handler</em></dt>
<dd><p>Suspend the current script and pass its continuation to the
procedure <var>handler</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-sleep"></a>Procedure: <strong>sleep</strong> <em><var>duration</var></em></dt>
+<dt><a name="index-sleep"></a>Procedure: <strong>sleep</strong> <em>duration</em></dt>
<dd><p>Wait <var>duration</var> before resuming the current script.
</p></dd></dl>
<dl>
-<dt><a name="index-channel_002dget"></a>Procedure: <strong>channel-get</strong> <em><var>channel</var></em></dt>
-<dd><p>Wait for a message from <var>channel</var>.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-forever"></a>Syntax: <strong>forever</strong> <em><var>body</var> &hellip;</em></dt>
+<dt><a name="index-forever"></a>Syntax: <strong>forever</strong> <em>body &hellip;</em></dt>
<dd><p>Evaluate <var>body</var> in an endless loop.
</p></dd></dl>