-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
354 lines (234 loc) · 15.8 KB
/
index.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>UPBGE Manual — UPBGE 0.2.5 Manual/API latest documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="manual/introduction/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home" alt="Documentation Home"> UPBGE 0.2.5 Manual/API
<img src="_static/upbge_logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.2.5b
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Manual</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/tutorials/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/editors/index.html">Editors</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/datablocks/index.html">Datablocks</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/logic/index.html">Logic</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/release/index.html">Release</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/about/index.html">About</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/bge.html">Game Engine Modules (bge)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/aud.html">Audio System (aud)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/mathutils.html">Math Types & Utilities (mathutils)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/bgl.html">OpenGL Wrapper (bgl)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/blf.html">Font Drawing (blf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/gpu.html">GPU functions (gpu)</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">UPBGE 0.2.5 Manual/API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> »</li>
<li>UPBGE Manual</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="upbge-manual">
<h1>UPBGE Manual<a class="headerlink" href="#upbge-manual" title="Permalink to this headline">¶</a></h1>
<p>Welcome to UPBGE’s Documentation! Here you will
find definitions of the available tools and features in UPBGE, step-by-step
tutorials to certain tasks and the Python API for game logic programming
with detailed information (and examples in some cases).</p>
<p><a class="reference external" href="https://upbge.org/">Visit the UPBGE’s website</a> or <a class="reference external" href="https://github.com/UPBGE/UPBGE-Docs-0.2.5-build">contribute to this manual</a>.</p>
<p>Also, if you want to read the whole manual offline <a class="reference external" href="https://upbge.org/docs/v0.2.5/UPBGE_manual_api_0.2.5.zip">you can download from this link</a>.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Manual</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/introduction/index.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction/briefing.html">Briefing</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction/deeper_look.html">A Deeper Look</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction/compatibility_notes.html">Compatibility Notes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/tutorials/index.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tutorials/getting_started/index.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tutorials/introducing_python/index.html">Introducing Python</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editors/index.html">Editors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editors/properties/index.html">Properties Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editors/logic/index.html">Logic Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/datablocks/index.html">Datablocks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/armature.html">Armature</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/camera.html">Camera</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/empty.html">Empty</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/group.html">Group</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/lamp.html">Lamp</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/mesh.html">Mesh</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/object.html">Object</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/text.html">Text</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/image.html">Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/library.html">Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/sound.html">Sound</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/action.html">Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/material.html">Material</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/scene.html">Scene</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/texture.html">Texture</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/world.html">World</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/logic/index.html">Logic</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/sensors/index.html">Sensors</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/controllers/index.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/actuators/index.html">Actuators</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/properties.html">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic/states.html">States</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/release/index.html">Release</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/release/licensing.html">Licensing of Games</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/release/performance.html">Performance Considerations</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/release/blender_player.html">Standalone Player</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/release/release_procedure.html">Release Procedure</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/about/index.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/about/introduction.html">Introduction to the UPBGE Manual</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/about/license.html">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/about/whats_new.html">What’s New</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/bge.html">Game Engine Modules (bge)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/bge.types.html">Game Types (bge.types)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.logic.html">Game Logic (bge.logic)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.render.html">Rasterizer (bge.render)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.texture.html">Video Texture (bge.texture)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.events.html">Game Keys (bge.events)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.constraints.html">Physics Constraints (bge.constraints)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/bge.app.html">Application Data (bge.app)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/aud.html">Audio System (aud)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#basic-sound-playback">Basic Sound Playback</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#device">Device</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#factory">Factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#handle">Handle</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/aud.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/mathutils.html">Math Types & Utilities (mathutils)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.bvhtree.html">BVHTree Utilities (mathutils.bvhtree)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.geometry.html">Geometry Utilities (mathutils.geometry)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.interpolate.html">Interpolation Utilities (mathutils.interpolate)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.kdtree.html">KDTree Utilities (mathutils.kdtree)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.noise.html">Noise Utilities (mathutils.noise)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.html#color">Color</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.html#euler">Euler</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.html#matrix">Matrix</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.html#quaternion">Quaternion</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mathutils.html#vector">Vector</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/bgl.html">OpenGL Wrapper (bgl)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/blf.html">Font Drawing (blf)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/blf.html#text-example">Text Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/blf.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/blf.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/gpu.html">GPU functions (gpu)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/gpu.offscreen.html">GPU Off-Screen Buffer (gpu.offscreen)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/gpu.html#intro">Intro</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/gpu.html#constants">Constants</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/gpu.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/gpu.html#notes">Notes</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="manual/introduction/index.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright This page is licensed under a CC-BY-SA 4.0 Int. License.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>