Skip to content

Commit 3d95eb9

Browse files
committed
Updated Docs
1 parent 4a2c672 commit 3d95eb9

File tree

471 files changed

+3285
-2356
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

471 files changed

+3285
-2356
lines changed

CMakeOptions.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include(CMakeDependentOption)
2+
include(EnumOption)
3+
4+
option(TS_BUILD_EXAMPLES "Build Examples For Techstorm" OFF)
5+
option(TS_BUILD_TOOLS "Build Tools For Techstorm" OFF)
6+
option(TS_ENABLE_TESTING "Enable Unit Tests For Techstorm" OFF)

LIBRARIES-LICENSE.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2008-2014 CodePoint Ltd, Shift Technology Ltd, and contributors
4+
Copyright (c) 2019-2024 The RmlUi Team, and contributors
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

LICENSE.txt

+3-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright [2024] [Mute124]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.
@@ -199,3 +199,5 @@
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201201
limitations under the License.
202+
203+

docs/html/annotated.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@
114114
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="de/dc7/class_techstorm_1_1_game_object_registry.html" target="_self">GameObjectRegistry</a></td><td class="desc">Game object registry, it stores all game objects in the world and manages their updating, rendering, destruction, creation, etc </td></tr>
115115
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d6/d46/class_techstorm_1_1_gate.html" target="_self">Gate</a></td><td class="desc">A class that acts as, well, a gate! It is essentially as a piece of machinery on an assembly line. Please do note, that this is a template class and is not meant to be used directly. Please see <a class="el" href="de/dc7/class_techstorm_1_1_game_object_registry.html" title="Game object registry, it stores all game objects in the world and manages their updating,...">GameObjectRegistry</a> for more information and an example </td></tr>
116116
<tr id="row_0_13_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/d44/class_techstorm_1_1_globals_container.html" target="_self">GlobalsContainer</a></td><td class="desc"></td></tr>
117-
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d9/d02/class_techstorm_1_1_input_action.html" target="_self">InputAction</a></td><td class="desc">Serves as a search key/input category for the input system. <b>Please pay attention when using this because any slight change in <a class="el" href="d9/d02/class_techstorm_1_1_input_action.html" title="Serves as a search key/input category for the input system. Please pay attention when using this beca...">InputAction</a> keys will give you entirely different input results.</b> </td></tr>
118-
<tr id="row_0_15_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dc/d16/class_techstorm_1_1_input_registry.html" target="_self">InputRegistry</a></td><td class="desc">The input registry is used to register InputActions (<a class="el" href="d9/d02/class_techstorm_1_1_input_action.html" title="Serves as a search key/input category for the input system. Please pay attention when using this beca...">InputAction</a>) and their callbacks. Remember that this is a singleton, so you may use this statically </td></tr>
117+
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d9/d02/class_techstorm_1_1_input_action.html" target="_self">InputAction</a></td><td class="desc">Serves as a search key/input category for the input system </td></tr>
118+
<tr id="row_0_15_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dc/d16/class_techstorm_1_1_input_registry.html" target="_self">InputRegistry</a></td><td class="desc">The input registry is used to register InputActions (<a class="el" href="d9/d02/class_techstorm_1_1_input_action.html" title="Serves as a search key/input category for the input system.">InputAction</a>) and their callbacks by using a Laissez-faire system </td></tr>
119119
<tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d5d/class_techstorm_1_1_layer_registry.html" target="_self">LayerRegistry</a></td><td class="desc"></td></tr>
120120
<tr id="row_0_17_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/dd3/class_techstorm_1_1_my_body_activation_listener.html" target="_self">MyBodyActivationListener</a></td><td class="desc"></td></tr>
121121
<tr id="row_0_18_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d9/d66/class_techstorm_1_1_object_contact_listener.html" target="_self">ObjectContactListener</a></td><td class="desc"></td></tr>
@@ -161,7 +161,7 @@
161161
<!-- start footer part -->
162162
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
163163
<ul>
164-
<li class="footer">Generated on Thu Nov 28 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
164+
<li class="footer">Generated on Fri Nov 29 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
165165
</ul>
166166
</div>
167167
</body>

docs/html/classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
<!-- start footer part -->
151151
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
152152
<ul>
153-
<li class="footer">Generated on Thu Nov 28 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
153+
<li class="footer">Generated on Fri Nov 29 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
154154
</ul>
155155
</div>
156156
</body>

docs/html/d0/d02/_prototype_physics_terrain_8h.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a56c9c449c6fafd5d0e620f01
302302
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
303303
<ul>
304304
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_844f6ab5c2ae79211596f3dcdd81adb7.html">application</a></li><li class="navelem"><a class="el" href="../../dir_6e82b84377b60bf9f36401da93b614f7.html">prototyping</a></li><li class="navelem"><a class="el" href="../../d0/d02/_prototype_physics_terrain_8h.html">PrototypePhysicsTerrain.h</a></li>
305-
<li class="footer">Generated on Thu Nov 28 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
305+
<li class="footer">Generated on Fri Nov 29 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
306306
</ul>
307307
</div>
308308
</body>

docs/html/d0/d02/_prototype_physics_terrain_8h_source.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1114,7 +1114,7 @@
11141114
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
11151115
<ul>
11161116
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_844f6ab5c2ae79211596f3dcdd81adb7.html">application</a></li><li class="navelem"><a class="el" href="../../dir_6e82b84377b60bf9f36401da93b614f7.html">prototyping</a></li><li class="navelem"><a class="el" href="../../d0/d02/_prototype_physics_terrain_8h.html">PrototypePhysicsTerrain.h</a></li>
1117-
<li class="footer">Generated on Thu Nov 28 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
1117+
<li class="footer">Generated on Fri Nov 29 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
11181118
</ul>
11191119
</div>
11201120
</body>

docs/html/d0/d11/_scripting_a_p_i_8cpp.html

+41-1
Original file line numberDiff line numberDiff line change
@@ -91,19 +91,59 @@
9191
</div>
9292

9393
<div class="header">
94+
<div class="summary">
95+
<a href="#func-members">Functions</a> </div>
9496
<div class="headertitle"><div class="title">ScriptingAPI.cpp File Reference</div></div>
9597
</div><!--header-->
9698
<div class="contents">
9799
<div class="textblock"><code>#include &quot;<a class="el" href="../../dc/d41/_scripting_a_p_i_8h_source.html">ScriptingAPI.h</a>&quot;</code><br />
100+
<code>#include &quot;<a class="el" href="../../d4/d71/_config_8h_source.html">../conf/Config.h</a>&quot;</code><br />
98101
</div>
99102
<p><a href="../../d0/d11/_scripting_a_p_i_8cpp_source.html">Go to the source code of this file.</a></p>
103+
<table class="memberdecls">
104+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
105+
Functions</h2></td></tr>
106+
<tr class="memitem:a4cff30028d3f067aac8f2f5f12892386" id="r_a4cff30028d3f067aac8f2f5f12892386"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d11/_scripting_a_p_i_8cpp.html#a4cff30028d3f067aac8f2f5f12892386">greet</a> (const std::string &amp;name, int age)</td></tr>
107+
<tr class="separator:a4cff30028d3f067aac8f2f5f12892386"><td class="memSeparator" colspan="2">&#160;</td></tr>
108+
</table>
109+
<h2 class="groupheader">Function Documentation</h2>
110+
<a id="a4cff30028d3f067aac8f2f5f12892386" name="a4cff30028d3f067aac8f2f5f12892386"></a>
111+
<h2 class="memtitle"><span class="permalink"><a href="#a4cff30028d3f067aac8f2f5f12892386">&#9670;&#160;</a></span>greet()</h2>
112+
113+
<div class="memitem">
114+
<div class="memproto">
115+
<table class="memname">
116+
<tr>
117+
<td class="memname">void greet </td>
118+
<td>(</td>
119+
<td class="paramtype">const std::string &amp;&#160;</td>
120+
<td class="paramname"><em>name</em>, </td>
121+
</tr>
122+
<tr>
123+
<td class="paramkey"></td>
124+
<td></td>
125+
<td class="paramtype">int&#160;</td>
126+
<td class="paramname"><em>age</em>&#160;</td>
127+
</tr>
128+
<tr>
129+
<td></td>
130+
<td>)</td>
131+
<td></td><td></td>
132+
</tr>
133+
</table>
134+
</div><div class="memdoc">
135+
136+
<p class="definition">Definition at line <a class="el" href="../../d0/d11/_scripting_a_p_i_8cpp_source.html#l00013">13</a> of file <a class="el" href="../../d0/d11/_scripting_a_p_i_8cpp_source.html">ScriptingAPI.cpp</a>.</p>
137+
138+
</div>
139+
</div>
100140
</div><!-- contents -->
101141
</div><!-- doc-content -->
102142
<!-- start footer part -->
103143
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
104144
<ul>
105145
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_2052808828190f934b76e979ee65af8a.html">engine</a></li><li class="navelem"><a class="el" href="../../dir_467a9c807a42c7b02e78d7a930074fcd.html">modding</a></li><li class="navelem"><a class="el" href="../../d0/d11/_scripting_a_p_i_8cpp.html">ScriptingAPI.cpp</a></li>
106-
<li class="footer">Generated on Thu Nov 28 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
146+
<li class="footer">Generated on Fri Nov 29 2024 for Techstorm by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
107147
</ul>
108148
</div>
109149
</body>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
var _scripting_a_p_i_8cpp =
2+
[
3+
[ "greet", "d0/d11/_scripting_a_p_i_8cpp.html#a4cff30028d3f067aac8f2f5f12892386", null ]
4+
];

0 commit comments

Comments
 (0)