A lightweight JavaScript game engine
git clone git://soophie.de/game-engine
blob: b41be572607b38c133e887315507250728e2d7ca (7955 bytes)[doc][blame][raw]
1
<!DOCTYPE html>2
<html lang="en" dir="ltr">3
<head>4
<meta charset="utf-8">5
<meta name="viewport" content="width=device-width, initial-scale=1.0">6
<meta name="author" content="typable">7
<meta name="keywords" content="">8
<meta name="description" content="">9
<meta name="robots" content="noindex, nofollow">10
<meta name="google" content="notranslate">11
<title>git.typable</title>12
<link href="/asset/img/favicon.png" rel="shortcut icon" type="image/png">13
<link href="/asset/css/style.css" rel="stylesheet">14
<script src="/asset/js/index.js" type="module"></script>15
</head>16
<body>17
<main class="container-fluid">18
<div class="row">19
<div class="container">20
<aside>21
<h4 data-rel="top">API</h4>22
<ul>23
<li data-rel="game">Game</li>24
<li data-rel="group">Group</li>25
<li data-rel="surface">Surface</li>26
<li data-rel="shape">Shape</li>27
<li data-rel="collision">Collision</li>28
</ul>29
</aside>30
<ul class="breadcrumb">31
<li><a href="/">Home</a></li>32
<li><a href="/game-engine">Game Engine</a></li>33
<li>API</li>34
</ul>35
<h1>API</h1>36
<p class="subline">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>37
<h2 data-ref="game">Game</h2>38
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>39
<code><pre><span class="c">import</span> { <span class="n">Game</span> } <span class="c">from</span> <span class="s">'<span class="ref ref-link">https://git.typable.dev/std/js/game.js</span>'</span>;</pre></code>40
<div class="space-2"></div>41
<h4>constructor(width, height)</h4>42
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>43
<h4>update()</h4>44
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>45
<h4>render(g)</h4>46
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>47
<h4>start()</h4>48
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>49
<h4>bindEvent(element, event)</h4>50
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>51
<h4>populateEvent(event)</h4>52
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>53
<h4>resize(width, height)</h4>54
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>55
<h2 data-ref="group">Group</h2>56
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>57
<code><pre><span class="c">import</span> { <span class="n">Group</span> } <span class="c">from</span> <span class="s">'<span class="ref ref-link">https://git.typable.dev/std/js/game.js</span>'</span>;</pre></code>58
<div class="space-2"></div>59
<h4>constructor()</h4>60
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>61
<h4>update()</h4>62
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>63
<h4>render(g)</h4>64
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>65
<h4>collide()</h4>66
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>67
<h4>add(surface)</h4>68
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>69
<h4>remove(surface)</h4>70
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>71
<h4>[Symbol.iterator]</h4>72
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>73
<h2 data-ref="surface">Surface</h2>74
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>75
<code><pre><span class="c">import</span> { <span class="n">Surface</span> } <span class="c">from</span> <span class="s">'<span class="ref ref-link">https://git.typable.dev/std/js/game.js</span>'</span>;</pre></code>76
<div class="space-2"></div>77
<h4>constructor(x, y, shape)</h4>78
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>79
<h4>update()</h4>80
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>81
<h4>render(g)</h4>82
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>83
<h4>causeEvent(event)</h4>84
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>85
<h2 data-ref="shape">Shape</h2>86
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>87
<code><pre><span class="c">import</span> { <span class="n">Shape</span> } <span class="c">from</span> <span class="s">'<span class="ref ref-link">https://git.typable.dev/std/js/game.js</span>'</span>;</pre></code>88
<div class="space-2"></div>89
<h3>Rect</h3>90
<h4>constructor(width, height)</h4>91
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>92
<div class="space-1"></div>93
<h3>Circle</h3>94
<h4>constructor(radius)</h4>95
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>96
<h2 data-ref="collision">Collision</h2>97
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>98
<code><pre><span class="c">import</span> <span class="n">*</span> <span class="c">as</span> <span class="n">Collision</span> <span class="c">from</span> <span class="s">'<span class="ref ref-link">https://git.typable.dev/std/js/collision.js</span>'</span>;</pre></code>99
<div class="space-2"></div>100
<h4>collideRect(rect, rect)</h4>101
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>102
<h4>collideCircle(circle, circle)</h4>103
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>104
<h4>collideRectAndCircle(rect, circle)</h4>105
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>106
<h4>collidePoint(shape, point)</h4>107
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>108
</div>109
</div>110
</main>111
<footer class="container-fluid">112
<div class="row">113
<div class="container">114
<p>© typable 2021</p>115
<a href="https://www.buymeacoffee.com/typable">Donate</a>116
<a href="https://typable.dev/imprint">Imprint</a>117
<a href="https://typable.dev/terms">Terms</a>118
</div>119
</div>120
</footer>121
</body>122
</html>