-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconsole_blocking_input.html
More file actions
184 lines (180 loc) · 11.7 KB
/
console_blocking_input.html
File metadata and controls
184 lines (180 loc) · 11.7 KB
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-C2YXLNQ21C"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-C2YXLNQ21C');
</script>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>libtcod documentation | Blocking user input</title>
<script type="text/javascript" src="../js/doctcod.js"></script>
<link href="../css/style.css" rel="stylesheet" type="text/css">
</head>
<link type="text/css" rel="stylesheet" href="../css/shCore.css">
</link>
<link type="text/css" rel="stylesheet" href="../css/shThemeDefault.css">
</link>
<script language="javascript" src="../js/shCore.js"></script>
<script language="javascript" src="../js/shBrushBash.js"></script>
<body>
<div class="header">
<p><span class="title1">libtcod</span><span class="title2">documentation</span></p>
</div>
<div class="breadcrumb">
<div class="breadcrumbtext">
<p>
you are here: <a onclick="link('../index2.html')">Index</a> > <a onclick="link('console.html')">2.
Console</a> > <a onclick="link('console_input.html')">2.4. Handling user input</a> > <a
onclick="link('console_blocking_input.html')">2.4.1. Blocking user input</a><br>
<a class="next" onclick="link('console_non_blocking_input.html')">2.4.2. Non blocking user input</a>
</p>
</div>
</div>
<div class="filter"><input type="checkbox" id="chk_c" name="chk_c" onchange="enable('c',this.checked)"
checked='checked'><label for='chk_c'> C </label><input type="checkbox" id="chk_cpp" name="chk_cpp"
onchange="enable('cpp',this.checked)" checked='checked'><label for='chk_cpp'> C++ </label><input type="checkbox"
id="chk_py" name="chk_py" onchange="enable('py',this.checked)" checked='checked'><label for='chk_py'> Py
</label><input type="checkbox" id="chk_lua" name="chk_lua" onchange="enable('lua',this.checked)"
disabled='disabled'><label class='disabled' for='chk_lua'> Lua </label><input type="checkbox" id="chk_cs"
name="chk_cs" onchange="enable('cs',this.checked)" disabled='disabled'><label class='disabled' for='chk_cs'> C#
</label></div>
<div class="main">
<div class="maintext">
<h1>2.4.1. Blocking user input</h1>
<p>This function stops the application until an event occurs.<br /> </p>
<a name="0"></a>
<h3>Waiting for any event (mouse or keyboard)</h3>
<p>This function waits for an event from the user. The eventMask shows what events we're waiting for.<br /> The
return value indicate what event was actually triggered. Values in key and mouse structures are updated
accordingly.<br /> If flush is false, the function waits only if there are no pending events, else it returns
the first event in the buffer.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">typedef</span><span class="code-keyword"> enum</span><span
class="code-symbol"> {</span><span
class="code-tcod"><br /> TCOD_EVENT_NONE</span><span
class="code-symbol">=</span><span class="code-value">0</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_KEY_PRESS</span><span
class="code-symbol">=</span><span class="code-value">1</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_KEY_RELEASE</span><span
class="code-symbol">=</span><span class="code-value">2</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_KEY</span><span
class="code-symbol">=</span><span class="code-tcod">TCOD_EVENT_KEY_PRESS</span><span
class="code-symbol">|</span><span class="code-tcod">TCOD_EVENT_KEY_RELEASE</span><span
class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_MOUSE_MOVE</span><span
class="code-symbol">=</span><span class="code-value">4</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_MOUSE_PRESS</span><span
class="code-symbol">=</span><span class="code-value">8</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_MOUSE_RELEASE</span><span
class="code-symbol">=</span><span class="code-value">16</span><span class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_MOUSE</span><span
class="code-symbol">=</span><span class="code-tcod">TCOD_EVENT_MOUSE_MOVE</span><span
class="code-symbol">|</span><span class="code-tcod">TCOD_EVENT_MOUSE_PRESS</span><span
class="code-symbol">|</span><span class="code-tcod">TCOD_EVENT_MOUSE_RELEASE</span><span
class="code-symbol">,</span><span
class="code-tcod"><br /> TCOD_EVENT_ANY</span><span
class="code-symbol">=</span><span class="code-tcod">TCOD_EVENT_KEY</span><span
class="code-symbol">|</span><span class="code-tcod">TCOD_EVENT_MOUSE</span><span
class="code-symbol">,</span><span class="code-symbol"> <br /> }</span><span
class="code-tcod"> TCOD_event_t</span><span class="code-symbol">;</span><span class="code-keyword">
<br /> static</span><span class="code-tcod"> TCOD_event_t</span> TCODSystem<span
class="code-symbol">::</span>waitForEvent<span class="code-symbol">(</span><span
class="code-keyword">int</span> eventMask<span class="code-symbol">,</span><span class="code-tcod">
TCOD_key_t</span><span class="code-symbol"> *</span>key<span class="code-symbol">,</span><span
class="code-tcod"> TCOD_mouse_t</span><span class="code-symbol"> *</span>mouse<span
class="code-symbol">,</span><span class="code-keyword"> bool</span> flush<span class="code-symbol">)</span>
</p>
<p class="c"><span class="code-tcod">TCOD_event_t</span> TCOD_sys_wait_for_event<span
class="code-symbol">(</span><span class="code-keyword">int</span> eventMask<span
class="code-symbol">,</span><span class="code-tcod"> TCOD_key_t</span><span class="code-symbol">
*</span>key<span class="code-symbol">,</span><span class="code-tcod"> TCOD_mouse_t</span><span
class="code-symbol"> *</span>mouse<span class="code-symbol">,</span><span class="code-keyword"> bool</span>
flush<span class="code-symbol">)</span></p>
<p class="py">sys_wait_for_event<span class="code-symbol">(</span>eventMask<span
class="code-symbol">,</span>key<span class="code-symbol">,</span>mouse<span
class="code-symbol">,</span>flush<span class="code-symbol">)</span></p>
</div>
<table class="param">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr class="hilite">
<td>eventMask</td>
<td>event types to wait for (other types are discarded)<br /> </td>
</tr>
<tr>
<td>key</td>
<td>updated in case of a key event. Can be null if eventMask contains no key event type<br /> </td>
</tr>
<tr class="hilite">
<td>mouse</td>
<td>updated in case of a mouse event. Can be null if eventMask contains no mouse event type<br /> </td>
</tr>
<tr>
<td>flush</td>
<td>if true, all pending events are flushed from the buffer. Else, return the first available event<br />
</td>
</tr>
</tbody>
</table>
<h6>Example:</h6>
<div class="code">
<p class="cpp"><span class="code-tcod">TCOD_key_t</span> key<span class="code-symbol">;</span><span
class="code-tcod"><br />TCOD_mouse_t</span> mouse<span class="code-symbol">;</span><span
class="code-tcod"><br />TCOD_event_t</span> ev<span class="code-symbol"> =</span> TCODSystem<span
class="code-symbol">::</span>waitForEvent<span class="code-symbol">(</span><span
class="code-tcod">TCOD_EVENT_ANY</span><span class="code-symbol">,</span><span
class="code-symbol">&</span>key<span class="code-symbol">,</span><span
class="code-symbol">&</span>mouse<span class="code-symbol">,</span><span
class="code-keyword">true</span><span class="code-symbol">)</span><span class="code-symbol">;</span><span
class="code-keyword"><br />if</span><span class="code-symbol"> (</span> ev<span class="code-symbol">
==</span><span class="code-tcod"> TCOD_EVENT_KEY_PRESS</span><span class="code-symbol"> &&</span> key<span
class="code-symbol">.</span>c<span class="code-symbol"> ==</span><span class="code-character">
'i'</span><span class="code-symbol"> )</span><span class="code-symbol"> {</span><span class="code-symbol">
...</span> open inventory<span class="code-symbol"> ...</span><span class="code-symbol"> }</span></p>
<p class="c"><span class="code-tcod">TCOD_key_t</span> key<span class="code-symbol">;</span><span
class="code-tcod"><br />TCOD_mouse_t</span> mouse<span class="code-symbol">;</span><span
class="code-tcod"><br />TCOD_event_t</span> ev<span class="code-symbol"> =</span>
TCOD_sys_wait_for_event<span class="code-symbol">(</span><span class="code-tcod">TCOD_EVENT_ANY</span><span
class="code-symbol">,</span><span class="code-symbol">&</span>key<span class="code-symbol">,</span><span
class="code-symbol">&</span>mouse<span class="code-symbol">,</span>true<span
class="code-symbol">)</span><span class="code-symbol">;</span><span
class="code-keyword"><br />if</span><span class="code-symbol"> (</span> ev<span class="code-symbol">
==</span><span class="code-tcod"> TCOD_EVENT_KEY_PRESS</span><span class="code-symbol"> &&</span> key<span
class="code-symbol">.</span>c<span class="code-symbol"> ==</span><span class="code-character">
'i'</span><span class="code-symbol"> )</span><span class="code-symbol"> {</span><span class="code-symbol">
...</span> open inventory<span class="code-symbol"> ...</span><span class="code-symbol"> }</span></p>
</div>
<hr>
</div>
</div>
<div class="footer">
<div class="footertext">
<p>libtcod 1.6.4, © 2008, 2009, 2010, 2012, 2017 Jice, Mingos & rmtew<br>
This file has been generated by doctcod.</p>
<p>
<table width='100%'>
<tr>
<td width="33%"><a href="https://github.com/libtcod/libtcod">libtcod website</a></td>
<td width="33%"><a href="https://www.reddit.com/r/roguelikedev">libtcod on /r/roguelikedev</a></td>
<td width="33%">libtcod tutorials [ <a
href="http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod">Python</a> | <a
href="http://www.roguebasin.com/index.php?title=Complete_roguelike_tutorial_using_C%2B%2B_and_libtcod_-_part_1:_setting_up">C++</a> ]
</td>
</tr>
</table>
</p>
</div>
</div>
</body>
<script>
initFilter();
SyntaxHighlighter.all();
</script>
</html>