Skip to content

Commit

Permalink
Deploy preview for PR 954 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
diogomsmiranda committed Feb 11, 2024
1 parent e1faa9f commit 7cdced4
Show file tree
Hide file tree
Showing 45 changed files with 1,254 additions and 395 deletions.
2 changes: 2 additions & 0 deletions docs-preview/pr-954/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ <h1>Classes</h1>
<li>struct <a href="structcubos_1_1core_1_1io_1_1GamepadConnectionEvent.html" class="m-doc">GamepadConnectionEvent</a> <span class="m-doc">Event sent when a gamepad is connected or disconnected.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1GamepadState.html" class="m-doc">GamepadState</a> <span class="m-doc">Holds the state of a gamepad.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1KeyEvent.html" class="m-doc">KeyEvent</a> <span class="m-doc">Event sent when a key is pressed or released.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1KeyWithModifiers.html" class="m-doc">KeyWithModifiers</a> <span class="m-doc">Keyboard key code and modifier flags.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1ModifiersEvent.html" class="m-doc">ModifiersEvent</a> <span class="m-doc">Event sent when the modifiers change.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1MouseButtonEvent.html" class="m-doc">MouseButtonEvent</a> <span class="m-doc">Event sent when a mouse button state changes.</span></li>
<li>struct <a href="structcubos_1_1core_1_1io_1_1MouseMoveEvent.html" class="m-doc">MouseMoveEvent</a> <span class="m-doc">Event sent when the mouse cursor moves.</span></li>
Expand Down Expand Up @@ -343,6 +344,7 @@ <h1>Classes</h1>
<li>class <a href="classcubos_1_1core_1_1reflection_1_1FieldsTrait_1_1AddressOfImpl.html" class="m-doc">AddressOfImpl</a> <span class="m-doc">Implementation of <a href="classcubos_1_1core_1_1reflection_1_1FieldsTrait_1_1AddressOf.html" class="m-doc">AddressOf</a> for a pointer to member.</span></li>
</ul>
</li>
<li>class <a href="classcubos_1_1core_1_1reflection_1_1MaskTrait.html" class="m-doc">MaskTrait</a> <span class="m-doc">Provides mask functionality to an enum mask type.</span></li>
<li>class <a href="classcubos_1_1core_1_1reflection_1_1NullableTrait.html" class="m-doc">NullableTrait</a> <span class="m-doc">Used to manipulate values of null-representable types.</span></li>
<li>struct <a href="structcubos_1_1core_1_1reflection_1_1Reflect.html" class="m-doc">Reflect</a> <span class="m-doc">Defines the reflection function for the given type <code>T</code>.</span></li>
<li>class <a href="classcubos_1_1core_1_1reflection_1_1StringConversionTrait.html" class="m-doc">StringConversionTrait</a> <span class="m-doc">Stores functions for converting a type to and from a string.</span></li>
Expand Down
18 changes: 6 additions & 12 deletions docs-preview/pr-954/classcubos_1_1core_1_1ecs_1_1Blueprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,8 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Adds a relation between two entities. Overwrites the existing relation, if there&#x27;s any.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#a8ac9595b66215c5e889f69fd3f7b2f97" class="m-doc">merge</a>(</span><span class="m-doc-wrap">const std::string&amp; prefix,
const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; other,
bool withName)</span>
<span class="m-doc-wrap-bumper">void <a href="#ae30d4f27b1469007d621cc339e379c2b" class="m-doc">merge</a>(</span><span class="m-doc-wrap">const std::string&amp; prefix,
const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; other)</span>
</dt>
<dd>Merges another blueprint into this one.</dd>
<dt id="a98b440b50553018db544d6ce8c7bea6a">
Expand Down Expand Up @@ -328,11 +327,10 @@ <h3>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a8ac9595b66215c5e889f69fd3f7b2f97"><div>
<section class="m-doc-details" id="ae30d4f27b1469007d621cc339e379c2b"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Blueprint::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8ac9595b66215c5e889f69fd3f7b2f97" class="m-doc-self">merge</a>(</span><span class="m-doc-wrap">const std::string&amp; prefix,
const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; other,
bool withName)</span></span>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Blueprint::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae30d4f27b1469007d621cc339e379c2b" class="m-doc-self">merge</a>(</span><span class="m-doc-wrap">const std::string&amp; prefix,
const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; other)</span></span>
</h3>
<p>Merges another blueprint into this one.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -348,10 +346,6 @@ <h3>
<td>other</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a> to merge.</td>
</tr>
<tr>
<td>withName</td>
<td>Whether to use the entity names from the other blueprint.</td>
</tr>
</tbody>
</table>
<p>Entities in the other blueprint will have their names prefixed with the specified string.</p>
Expand Down Expand Up @@ -402,7 +396,7 @@ <h3>
</tr>
<tr>
<td>withName</td>
<td>Whether to use the entity names from the blueprint.</td>
<td>Whether to add the &#x27;<a href="structcubos_1_1core_1_1ecs_1_1Name.html" class="m-doc">Name</a>&#x27; component to instantiated entities.</td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Destroys an entity.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a94a2ba67ea7d13c1eb5c36770c45c39d" class="m-doc">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint,
bool withName) -&gt; std::unordered_map&lt;std::string, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>&gt;</span>
<span class="m-doc-wrap-bumper">auto <a href="#ab007fa3430e28a20f5cd9975d2aa4c26" class="m-doc">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint) -&gt; std::unordered_map&lt;std::string, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>&gt;</span>
</dt>
<dd>Spawns a blueprint into the world.</dd>
<dt>
Expand Down Expand Up @@ -171,10 +170,9 @@ <h3>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a94a2ba67ea7d13c1eb5c36770c45c39d"><div>
<section class="m-doc-details" id="ab007fa3430e28a20f5cd9975d2aa4c26"><div>
<h3>
<span class="m-doc-wrap-bumper">std::unordered_map&lt;std::string, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>&gt; cubos::<wbr />core::<wbr />ecs::<wbr />CommandBuffer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a94a2ba67ea7d13c1eb5c36770c45c39d" class="m-doc-self">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint,
bool withName)</span></span>
<span class="m-doc-wrap-bumper">std::unordered_map&lt;std::string, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>&gt; cubos::<wbr />core::<wbr />ecs::<wbr />CommandBuffer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab007fa3430e28a20f5cd9975d2aa4c26" class="m-doc-self">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint)</span></span>
</h3>
<p>Spawns a blueprint into the world.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -186,10 +184,6 @@ <h3>
<td style="width: 1%">blueprint</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a> to spawn.</td>
</tr>
<tr>
<td>withName</td>
<td>Whether to use the entity names from the blueprint.</td>
</tr>
</tbody>
<tfoot>
<tr>
Expand Down
12 changes: 3 additions & 9 deletions docs-preview/pr-954/classcubos_1_1core_1_1ecs_1_1Commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Destroys an entity.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a95e87b7f1102f203269d0e1243bfdb0b" class="m-doc">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint,
bool withName) -&gt; <a href="classcubos_1_1core_1_1ecs_1_1Commands_1_1BlueprintBuilder.html" class="m-doc">BlueprintBuilder</a></span>
<span class="m-doc-wrap-bumper">auto <a href="#a0c75cfde6373904798ba117b9627cd5f" class="m-doc">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint) -&gt; <a href="classcubos_1_1core_1_1ecs_1_1Commands_1_1BlueprintBuilder.html" class="m-doc">BlueprintBuilder</a></span>
</dt>
<dd>Spawns a blueprint into the world.</dd>
<dt>
Expand Down Expand Up @@ -192,10 +191,9 @@ <h3>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a95e87b7f1102f203269d0e1243bfdb0b"><div>
<section class="m-doc-details" id="a0c75cfde6373904798ba117b9627cd5f"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="classcubos_1_1core_1_1ecs_1_1Commands_1_1BlueprintBuilder.html" class="m-doc">BlueprintBuilder</a> cubos::<wbr />core::<wbr />ecs::<wbr />Commands::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a95e87b7f1102f203269d0e1243bfdb0b" class="m-doc-self">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint,
bool withName)</span></span>
<span class="m-doc-wrap-bumper"><a href="classcubos_1_1core_1_1ecs_1_1Commands_1_1BlueprintBuilder.html" class="m-doc">BlueprintBuilder</a> cubos::<wbr />core::<wbr />ecs::<wbr />Commands::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0c75cfde6373904798ba117b9627cd5f" class="m-doc-self">spawn</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a>&amp; blueprint)</span></span>
</h3>
<p>Spawns a blueprint into the world.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -207,10 +205,6 @@ <h3>
<td style="width: 1%">blueprint</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a> to spawn.</td>
</tr>
<tr>
<td>withName</td>
<td>Whether to use the entity names from the blueprint.</td>
</tr>
</tbody>
<tfoot>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="namespacecubos.html">cubos</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core.html">core</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core_1_1reflection.html">reflection</a>::<wbr/></span>EnumTrait <span class="m-thin">class</span>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="enum_8hpp.html">&lt;core/reflection/traits/enum.hpp&gt;</a></div>
</h1>
<p>Provides enumeration functionality to an enumerated type.</p>
<nav class="m-block m-default">
Expand Down
Loading

0 comments on commit 7cdced4

Please sign in to comment.