-
-
Notifications
You must be signed in to change notification settings - Fork 97
/
gameLoop.html
373 lines (321 loc) · 13.5 KB
/
gameLoop.html
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<!DOCTYPE html>
<html lang="en">
<head>
<title>Kontra.js – GameLoop</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="https://straker.github.io/kontra/">
<script>
// adjust path based on location (github pages required kontra url)
if (window.location.host.indexOf('localhost') !== -1) {
let base = document.querySelector('base');
base.setAttribute('href', '/');
}
</script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/themes/prism.min.css">
<link rel="stylesheet" href="assets/styles.css">
<script src="assets/js/kontra.js"></script>
</head>
<body>
<div class="content">
<header class="main-nav">
<div id="kontra-heading" class="nav-heading">Kontra</div>
<a href="#main">Skip navigation</a>
<nav>
<button class="menu-button" aria-expanded="false" aria-controls="menu"><span aria-hidden="true">☰</span> Menu</button>
<!-- add role=list back to list so screen readers still read it as list when
css list-style: none is set
@see https://web-a11y.slack.com/archives/C042TSFGN/p1501699529181172 -->
<ul id="menu" role="list">
<li><a href="." >Introduction</a></li>
<li><a href="getting-started" >Getting Started</a></li>
<li><a href="download" >Download</a></li>
<li><a href="custom-builds" >Custom Builds</a></li>
<li><a href="tutorials" >Tutorials</a></li>
<li><a href="made-with-kontra" >Made With Kontra</a></li>
<li>
<span id="api" class="nav-api-heading">API</span>
<ul aria-labelledby="api">
<li><a href="api/animation" >Animation</a></li>
<li><a href="api/assets" >Assets</a></li>
<li><a href="api/collision" >Collision</a></li>
<li><a href="api/core" >Core</a></li>
<li><a href="api/events" >Events</a></li>
<li><a href="api/gameLoop" aria-current="page">GameLoop</a></li>
<li><a href="api/gameobject" >GameObject</a></li>
<li><a href="api/keyboard" >Keyboard</a></li>
<li><a href="api/plugin" >Plugin</a></li>
<li><a href="api/pointer" >Pointer</a></li>
<li><a href="api/pool" >Pool</a></li>
<li><a href="api/quadtree" >Quadtree</a></li>
<li><a href="api/sprite" >Sprite</a></li>
<li><a href="api/spriteSheet" >SpriteSheet</a></li>
<li><a href="api/store" >Store</a></li>
<li><a href="api/tileEngine" >TileEngine</a></li>
<li><a href="api/vector" >Vector</a></li>
</ul>
</li>
</ul>
</nav>
<div class="scroll-indicator" aria-hidden="true"><span>^</span></div>
</header>
<main id="main">
<div>
<a href="https://github.com/straker/kontra" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
<h1>GameLoop(​properties)
</h1>
<p>The game loop updates and renders the game every frame. The game loop is stopped by default and will not start until the loops <code>start()</code> function is called.</p>
<p>The game loop uses a time-based animation with a fixed <code>dt</code> to <a href="http://blog.sklambert.com/using-time-based-animation-implement/">avoid frame rate issues</a>. Each update call is guaranteed to equal 1/60 of a second.</p>
<p>This means that you can avoid having to do time based calculations in your update functions and instead do fixed updates.</p>
<div class="tablist">
<ul role="tablist">
<li role="presentation" data-tab="global">
<button role="tab" id="gameloop-global-tab">Global Object</button>
</li>
<li role="presentation" data-tab="es">
<button role="tab" id="gameloop-es-tab">ES Module Import</button>
</li>
<li role="presentation" data-tab="bundle">
<button role="tab" id="gameloop-bundle-tab">Module Bundler</button>
</li>
<li role="presentation"></li>
</ul>
<section role="tabpanel" aria-labelledby=gameloop-global-tab data-tabpanel="global"><pre><code class="language-js">let { Sprite, GameLoop } = kontra;
let sprite = Sprite({
x: 100,
y: 200,
width: 20,
height: 40,
color: 'red'
});
let loop = GameLoop({
update: function(dt) {
// no need to determine how many pixels you want to
// move every second and multiple by dt
// sprite.x += 180 * dt;
// instead just update by how many pixels you want
// to move every frame and the loop will ensure 60FPS
sprite.x += 3;
},
render: function() {
sprite.render();
}
});
loop.start();</code></pre></section>
<section role="tabpanel" aria-labelledby=gameloop-es-tab data-tabpanel="es"><pre><code class="language-js">import { Sprite, GameLoop } from 'path/to/kontra.mjs';
let sprite = Sprite({
x: 100,
y: 200,
width: 20,
height: 40,
color: 'red'
});
let loop = GameLoop({
update: function(dt) {
// no need to determine how many pixels you want to
// move every second and multiple by dt
// sprite.x += 180 * dt;
// instead just update by how many pixels you want
// to move every frame and the loop will ensure 60FPS
sprite.x += 3;
},
render: function() {
sprite.render();
}
});
loop.start();</code></pre></section>
<section role="tabpanel" aria-labelledby=gameloop-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { Sprite, GameLoop } from 'kontra';
let sprite = Sprite({
x: 100,
y: 200,
width: 20,
height: 40,
color: 'red'
});
let loop = GameLoop({
update: function(dt) {
// no need to determine how many pixels you want to
// move every second and multiple by dt
// sprite.x += 180 * dt;
// instead just update by how many pixels you want
// to move every frame and the loop will ensure 60FPS
sprite.x += 3;
},
render: function() {
sprite.render();
}
});
loop.start();</code></pre></section>
</div>
<h3 id="title-GameLoop"><span class="visually-hidden">GameLoop</span> Parameters</span></h3>
<dl aria-labelledby="title-GameLoop">
<dt>
<code>properties</code>
</dt>
<dd><p>Object. Properties of the game loop.</p>
</dd>
<dt>
<code>properties.update</code>
</dt>
<dd><p>Function. Function called every frame to update the game. Is passed the fixed <code>dt</code> as a parameter.</p>
</dd>
<dt>
<code>properties.render</code>
</dt>
<dd><p>Function. Function called every frame to render the game.</p>
</dd>
<dt>
<code>properties.fps</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Number. Desired frame rate. Defaults to <code>60</code>.</p>
</dd>
<dt>
<code>properties.clearCanvas</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Boolean. Clear the canvas every frame before the <code>render()</code> function is called. Defaults to <code>true</code>.</p>
</dd>
</dl>
<section class="toc">
<h2 id="toc"><a href="#toc" class="section-link">Table of Contents<span aria-hidden="true">#</span></a></h2>
<ul aria-labelledby="toc">
<li>
<h3 id="properties">Properties</h3>
<ul aria-labelledby="properties">
<li>
<a href="api/gameLoop#isStopped">
<span>GameLoop​.isStopped</span>
</a>
</li>
</ul>
</li>
<li>
<h3 id="methods">Methods</h3>
<ul aria-labelledby="methods">
<li>
<a href="api/gameLoop#render">
<span>GameLoop​.render(​)</span>
</a>
</li>
<li>
<a href="api/gameLoop#start">
<span>GameLoop​.start(​)</span>
</a>
</li>
<li>
<a href="api/gameLoop#stop">
<span>GameLoop​.stop(​)</span>
</a>
</li>
<li>
<a href="api/gameLoop#update">
<span>GameLoop​.update(​dt)</span>
</a>
</li>
</ul>
</li>
</ul>
</section>
<section>
<h2 id="isStopped">
<a href="api/gameLoop#isStopped" class="section-link">
<span>GameLoop​.isStopped</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>If the game loop is currently stopped.</p>
<div class="tablist">
<ul role="tablist">
<li role="presentation" data-tab="global">
<button role="tab" id="isstopped-global-tab">Global Object</button>
</li>
<li role="presentation" data-tab="es">
<button role="tab" id="isstopped-es-tab">ES Module Import</button>
</li>
<li role="presentation" data-tab="bundle">
<button role="tab" id="isstopped-bundle-tab">Module Bundler</button>
</li>
<li role="presentation"></li>
</ul>
<section role="tabpanel" aria-labelledby=isstopped-global-tab data-tabpanel="global"><pre><code class="language-js">let { GameLoop } = kontra;
let loop = GameLoop({
// ...
});
console.log(loop.isStopped); //=> true
loop.start();
console.log(loop.isStopped); //=> false
loop.stop();
console.log(loop.isStopped); //=> true</code></pre></section>
<section role="tabpanel" aria-labelledby=isstopped-es-tab data-tabpanel="es"><pre><code class="language-js">import { GameLoop } from 'path/to/kontra.mjs';
let loop = GameLoop({
// ...
});
console.log(loop.isStopped); //=> true
loop.start();
console.log(loop.isStopped); //=> false
loop.stop();
console.log(loop.isStopped); //=> true</code></pre></section>
<section role="tabpanel" aria-labelledby=isstopped-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { GameLoop } from 'kontra';
let loop = GameLoop({
// ...
});
console.log(loop.isStopped); //=> true
loop.start();
console.log(loop.isStopped); //=> false
loop.stop();
console.log(loop.isStopped); //=> true</code></pre></section>
</div>
</section>
<section>
<h2 id="render">
<a href="api/gameLoop#render" class="section-link">
<span>GameLoop​.render(​)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Called every frame to render the game. Put all of your games render logic here.</p>
</section>
<section>
<h2 id="start">
<a href="api/gameLoop#start" class="section-link">
<span>GameLoop​.start(​)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Start the game loop.</p>
</section>
<section>
<h2 id="stop">
<a href="api/gameLoop#stop" class="section-link">
<span>GameLoop​.stop(​)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Stop the game loop.</p>
</section>
<section>
<h2 id="update">
<a href="api/gameLoop#update" class="section-link">
<span>GameLoop​.update(​dt)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Called every frame to update the game. Put all of your games update logic here.</p>
<h3 id="title-update"><span class="visually-hidden">update</span> Parameters</span></h3>
<dl aria-labelledby="title-update">
<dt>
<code>dt</code>
</dt>
<dd><p>Number. The fixed dt time of 1/60 of a frame.</p>
</dd>
</dl>
</section>
</div>
</main>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-javascript.min.js"></script>
<script src="assets/js/navbar.js"></script>
<script src="assets/js/exampleTabList.js"></script>
</body>
</html>