File: captureAllKeys.html

package info (click to toggle)
sludge 2.2.2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,852 kB
  • sloc: cpp: 32,432; sh: 1,237; makefile: 634; xml: 284
file content (44 lines) | stat: -rwxr-xr-x 1,595 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>captureAllKeys</TITLE>
  <link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>captureAllKeys</h2>
<HR>

<H3>Syntax:</H3>

<P>
<pre class="syntax">captureAllKeys (<i>onOff</i>);</pre>
</P>

<H3>Purpose:</H3>

<P>
Turns on and off capturing of all keypresses, including Alt, Shift, Caps Lock, Scroll Lock and so on. Whenever a keypress is detected, your current keyboard handler is called (as specified by the <a href="onKeyboard.html">onKeyboard</a> function).
</P>

<P>
Passing in a Boolean value of FALSE turns off capture of these extended keys... passing in TRUE turns capture of every single keypress on. By default, capture of all keys is off.
</P>

<P>
If extended key capture is on, whenever an extended key is pressed your keyboard handler function will be passed a string containing a 4-digit number, representing the key that has been pressed. If extended key capture is off, your game will not react to extended keypresses. <b>In either case, your game will continue to react to standard keypresses, as described on the <a href="onKeyboard.html">onKeyboard</a> page.</b>
</P>

<H3>Return value:</H3>

<P>
No return value.
</P>

<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>

<HR>
</BODY>
</html>