-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
251 lines (231 loc) · 17 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UPBGE Manual — UPBGE Manual</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme_overrides.css?v=b4c3fc50" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=f4332903"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script 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">
UPBGE Manual
<img src="_static/upbge_logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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/logic_bricks/index.html">Logic Bricks</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/logic_nodes/index.html">Logic Nodes</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/python_scripting/index.html">Python Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/python_components/index.html">Python Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/physics/index.html">Physics</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/datablocks/index.html">Data-Blocks</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/deployment/index.html">Deployment</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/tools/index.html">Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/glossary/index.html">Glossary</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contribute</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/contribute/index.html">Contribute</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">UPBGE Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">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">
<section id="upbge-manual">
<h1>UPBGE Manual<a class="headerlink" href="#upbge-manual" title="Link to this heading"></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 a lot of examples for game logic programming with detailed information.</p>
<p>Visit the <a class="reference external" href="https://upbge.org/">UPBGE’s website</a> or <a class="reference external" href="https://github.com/UPBGE/UPBGE-Docs">contribute</a> to this manual. Contribution guidelines are in the <a class="reference internal" href="manual/contribute/index.html#contribute-index"><span class="std std-ref">Contribute</span></a> chapter.</p>
<p>Also, if you want to read the whole manual offline you can download it from <a class="reference external" href="https://upbge.org/docs/latest/manual/UPBGE_Manual.zip">this link</a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Site Navigation</p>
<p>Keyboard navigation is supported - use arrow keys <kbd class="kbd docutils literal notranslate">left/right</kbd> for previous/next page, and <kbd class="kbd docutils literal notranslate">up/down</kbd> to scroll the page up/down.
Press <kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>-<kbd class="kbd docutils literal notranslate">left/right</kbd></kbd> to go back/forward by browser history. To focus the <em>Search</em> field, press <kbd class="kbd docutils literal notranslate">/</kbd> (slash) key, <kbd class="kbd docutils literal notranslate">Enter</kbd> to search, <kbd class="kbd docutils literal notranslate">Tab</kbd> to unfocus.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>See <a class="reference internal" href="manual/contribute/about.html#contribute-about"><span class="std std-ref">About the UPBGE Manual</span></a> for a cheatsheet of most common abbreviations used in this manual.</p>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><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_logic_bricks/index.html">Introducing Logic Bricks</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tutorials/introducing_logic_nodes/index.html">Introducing Logic Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tutorials/introducing_python_scripting/index.html">Introducing Python Scripting</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tutorials/introducing_python_components/index.html">Introducing Python Components</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_bricks/index.html">Logic Bricks Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editors/logic_nodes/index.html">Logic Node Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editors/text/index.html">Text Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/logic_bricks/index.html">Logic Bricks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/sensors/index.html">Sensors</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/controllers/index.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/actuators/index.html">Actuators</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/properties.html">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_bricks/states.html">States</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/logic_nodes/index.html">Logic Nodes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/events/index.html">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/game/index.html">Game</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/input/index.html">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/values/index.html">Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/animation/index.html">Animation</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/lights/index.html">Lights</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/nodes/index.html">Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/objects/index.html">Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/scene/index.html">Scene</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/sound/index.html">Sound</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/logic/index.html">Logic</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/math/index.html">Math</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/physics/index.html">Physics</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/python/index.html">Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/raycasts/index.html">Raycasts</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/time/index.html">Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/data/index.html">Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/file/index.html">File</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/network/index.html">Network</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/render/index.html">Render</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/ui/index.html">UI</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/logic_nodes/utility/index.html">Utility</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/python_scripting/index.html">Python Scripting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/python_scripting/introduction.html">Introduction to Scripting</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/python_scripting/python_game_engine.html">Python and the Game Engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/python_scripting/understanding_inheritance.html">Inheritance And Composition</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/python_components/index.html">Python Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/python_components/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/python_components/getting_started/index.html">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/physics/index.html">Physics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/physics/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/physics/world.html">World Physics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/datablocks/index.html">Data-Blocks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/index.html#data-block-types">Data-Block Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/index.html#life-time">Life Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/index.html#sharing">Sharing</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/index.html#making-single-user">Making Single User</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/datablocks/index.html#removing-data-blocks">Removing Data-Blocks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/deployment/index.html">Deployment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/deployment/licensing.html">Licensing of Games</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/deployment/performance.html">Performance Considerations</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/deployment/blender_player.html">Standalone Player</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/deployment/release_procedure.html">Deployment Procedure</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/tools/index.html">Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tools/api_stubs.html">API Stubs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/glossary/index.html">Glossary</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contribute</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/contribute/index.html">Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/about.html">About the UPBGE Manual</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/contribute.html">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/guidelines.html">Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/writing_style.html">Writing Style Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/markup_style.html">Markup Style Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/commit.html">Commit Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/maintenance.html">Maintenance</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/templates.html">Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/license.html">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/contribute/whats_new.html">What’s New</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<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" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright : This page is licensed under a CC-BY-SA 4.0 Int. License.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>