summaryrefslogtreecommitdiff
path: root/manuals/sly/Keyboard.html
diff options
context:
space:
mode:
Diffstat (limited to 'manuals/sly/Keyboard.html')
-rw-r--r--manuals/sly/Keyboard.html137
1 files changed, 137 insertions, 0 deletions
diff --git a/manuals/sly/Keyboard.html b/manuals/sly/Keyboard.html
new file mode 100644
index 0000000..b0de8f3
--- /dev/null
+++ b/manuals/sly/Keyboard.html
@@ -0,0 +1,137 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2013, 2014 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
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+
+A copy of the license is also available from the Free Software
+Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+
+
+The document was typeset with
+http://www.texinfo.org/ (GNU Texinfo).
+ -->
+<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>Sly: Keyboard</title>
+
+<meta name="description" content="Sly: Keyboard">
+<meta name="keywords" content="Sly: Keyboard">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<meta charset="UTF-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Input.html#Input" rel="up" title="Input">
+<link href="Mouse.html#Mouse" rel="next" title="Mouse">
+<link href="Input.html#Input" rel="prev" title="Input">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space: nowrap}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: serif; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
+</head>
+
+<body lang="en">
+<a name="Keyboard"></a>
+<div class="header">
+<p>
+Next: <a href="Mouse.html#Mouse" accesskey="n" rel="next">Mouse</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<a name="Keyboard-1"></a>
+<h4 class="subsection">4.4.1 Keyboard</h4>
+
+<div class="example">
+<pre class="example">(use-modules (sly input keyboard))
+</pre></div>
+
+<p>Keyboard hooks, signals, and procedures.
+</p>
+<dl>
+<dt><a name="index-key_002dpress_002dhook"></a>Scheme Variable: <strong>key-press-hook</strong></dt>
+<dd><p>This hook is run whenever a key is pressed down. Procedures added to
+this hook should accept two arguments: <code>key</code>, a symbol, and
+<code>char</code>, a unicode character.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002drelease_002dhook"></a>Scheme Variable: <strong>key-release-hook</strong></dt>
+<dd><p>This hook is run whenever a key is released. Procedures added to this
+hook should accept two arguments: <code>key</code>, a symbol, and
+<code>char</code>, a unicode character.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002dlast_002ddown"></a>Scheme Signal: <strong>key-last-down</strong></dt>
+<dd><p>The last key pressed.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002dlast_002dup"></a>Scheme Signal: <strong>key-last-up</strong></dt>
+<dd><p>The last key released.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002ddown_003f"></a>Scheme Procedure: <strong>key-down?</strong> <em><var>key</var></em></dt>
+<dd><p>Create a signal for the state of <code>key</code>. The signal value is
+<code>#t</code> when <code>key</code> is pressed and <code>#f</code> otherwise.
+</p></dd></dl>
+
+<p>A lot of games use directional keys to control the player. The below
+procedure and signals make this style of movement easy to use.
+</p>
+<dl>
+<dt><a name="index-key_002ddirections"></a>Scheme Procedure: <strong>key-directions</strong> <em><var>up</var> <var>down</var> <var>left</var> <var>right</var></em></dt>
+<dd><p>Create a signal whose value is a 2D unit vector that can be used for
+8-directional movement. The vector is determined by the state of the
+directional keys: <code>up</code>, <code>down</code>, <code>left</code>, <code>right</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002darrows"></a>Scheme Signal: <strong>key-arrows</strong></dt>
+<dd><p>A 2D directional vector based on the state of the arrow keys.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-key_002dwasd"></a>Scheme Signal: <strong>key-wasd</strong></dt>
+<dd><p>A 2D directional vector based on the state of the WASD keys.
+</p></dd></dl>
+
+
+
+
+</body>
+</html>