Deploy preview for PR 913 🛫

GameDevTecnico · Feb 12, 2024 · daba6f9 · daba6f9
1 parent 2bdd4a6
commit daba6f9
Show file tree

Hide file tree

Showing 13 changed files with 323 additions and 22 deletions.
diff --git a/docs-preview/pr-913/annotated.html b/docs-preview/pr-913/annotated.html
@@ -150,6 +150,7 @@ <h1>Classes</h1>
                         </ul>
                       </li>
                       <li>class <a href="classcubos_1_1core_1_1ecs_1_1EventWriter.html" class="m-doc">EventWriter</a> <span class="m-doc"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> argument which allows the system to send events of type <code>T</code> to other systems.</span></li>
+                      <li>struct <a href="structcubos_1_1core_1_1ecs_1_1Name.html" class="m-doc">Name</a> <span class="m-doc">Component which stores the name of an entity.</span></li>
                       <li>class <a href="classcubos_1_1core_1_1ecs_1_1Opt.html" class="m-doc">Opt</a> <span class="m-doc">Wrapper for reference types to indicate that the given argument type is optional in a query.</span></li>
                       <li>class <a href="classcubos_1_1core_1_1ecs_1_1Query.html" class="m-doc">Query</a> <span class="m-doc"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> argument which holds the result of a query over all entities in world which match the given arguments.</span></li>
                       <li>class <a href="classcubos_1_1core_1_1ecs_1_1QueryData.html" class="m-doc">QueryData</a> <span class="m-doc">Holds the data necessary to execute a query.</span></li>

diff --git a/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1Blueprint.html b/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1Blueprint.html
@@ -70,15 +70,15 @@ <h2><a href="#pub-types">Public types</a></h2>
             <dt id="ad100889252360195106e54fed87f2d54">
               using <a href="#ad100889252360195106e54fed87f2d54" class="m-doc-self">Create</a> = <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>(*)(void*userData, std::string name)
             </dt>
-            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a9ac7013f69b00ac8a60414c1061c44d6" class="m-doc">instantiate</a> to create entities.</dd>
+            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a92bb828165bf177727a266567862742a" class="m-doc">instantiate</a> to create entities.</dd>
             <dt id="a7bfe09653c7ea84456cb20bc5a9eff41">
               using <a href="#a7bfe09653c7ea84456cb20bc5a9eff41" class="m-doc-self">Add</a> = void(*)(void*userData, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a> entity, <a href="classcubos_1_1core_1_1memory_1_1AnyValue.html" class="m-doc">memory::<wbr />AnyValue</a> component)
             </dt>
-            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a9ac7013f69b00ac8a60414c1061c44d6" class="m-doc">instantiate</a> to add components to entities.</dd>
+            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a92bb828165bf177727a266567862742a" class="m-doc">instantiate</a> to add components to entities.</dd>
             <dt id="af489f8de9153de1bdb1e80b4f3bc15fa">
               using <a href="#af489f8de9153de1bdb1e80b4f3bc15fa" class="m-doc-self">Relate</a> = void(*)(void*userData, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a> fromEntity, <a href="structcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a> toEntity, <a href="classcubos_1_1core_1_1memory_1_1AnyValue.html" class="m-doc">memory::<wbr />AnyValue</a> relation)
             </dt>
-            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a9ac7013f69b00ac8a60414c1061c44d6" class="m-doc">instantiate</a> to add relations to entities.</dd>
+            <dd>Function used by <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a92bb828165bf177727a266567862742a" class="m-doc">instantiate</a> to add relations to entities.</dd>
           </dl>
         </section>
         <section id="pub-static-methods">
@@ -135,17 +135,19 @@ <h2><a href="#pub-methods">Public functions</a></h2>
             </dt>
             <dd>Returns a bimap which maps entities to their names.</dd>
             <dt>
-              <span class="m-doc-wrap-bumper">void <a href="#a9ac7013f69b00ac8a60414c1061c44d6" class="m-doc">instantiate</a>(</span><span class="m-doc-wrap">void* userData,
+              <span class="m-doc-wrap-bumper">void <a href="#a92bb828165bf177727a266567862742a" class="m-doc">instantiate</a>(</span><span class="m-doc-wrap">void* userData,
               <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#ad100889252360195106e54fed87f2d54" class="m-doc">Create</a> create,
               <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a7bfe09653c7ea84456cb20bc5a9eff41" class="m-doc">Add</a> add,
-              <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#af489f8de9153de1bdb1e80b4f3bc15fa" class="m-doc">Relate</a> relate) const</span>
+              <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#af489f8de9153de1bdb1e80b4f3bc15fa" class="m-doc">Relate</a> relate,
+              bool withName) const</span>
             </dt>
             <dd>Instantiates the blueprint by calling the given functions.</dd>
             <dt>
               <div class="m-doc-template">template&lt;typename C, typename A, typename R&gt;</div>
-              <span class="m-doc-wrap-bumper">void <a href="#a1b382dfc2eb8c5e30f4d7d99637e7259" class="m-doc">instantiate</a>(</span><span class="m-doc-wrap">C create,
+              <span class="m-doc-wrap-bumper">void <a href="#a051c0ccbaafb5771789bb3b11352d5c4" class="m-doc">instantiate</a>(</span><span class="m-doc-wrap">C create,
               A add,
-              R relate) const</span>
+              R relate,
+              bool withName) const</span>
             </dt>
             <dd>Instantiates the blueprint by calling the given functors.</dd>
             <dt>
@@ -338,7 +340,7 @@ <h3>
               <tbody>
                 <tr>
                   <td style="width: 1%">prefix</td>
-                  <td>Name to prefix with the merged blueprint.</td>
+                  <td><a href="structcubos_1_1core_1_1ecs_1_1Name.html" class="m-doc">Name</a> to prefix with the merged blueprint.</td>
                 </tr>
                 <tr>
                   <td>other</td>
@@ -362,12 +364,13 @@ <h3>
               </tfoot>
             </table>
           </div></section>
-          <section class="m-doc-details" id="a9ac7013f69b00ac8a60414c1061c44d6"><div>
+          <section class="m-doc-details" id="a92bb828165bf177727a266567862742a"><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="#a9ac7013f69b00ac8a60414c1061c44d6" class="m-doc-self">instantiate</a>(</span><span class="m-doc-wrap">void* userData,
+              <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="#a92bb828165bf177727a266567862742a" class="m-doc-self">instantiate</a>(</span><span class="m-doc-wrap">void* userData,
               <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#ad100889252360195106e54fed87f2d54" class="m-doc">Create</a> create,
               <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#a7bfe09653c7ea84456cb20bc5a9eff41" class="m-doc">Add</a> add,
-              <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#af489f8de9153de1bdb1e80b4f3bc15fa" class="m-doc">Relate</a> relate) const</span></span>
+              <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html#af489f8de9153de1bdb1e80b4f3bc15fa" class="m-doc">Relate</a> relate,
+              bool withName) const</span></span>
             </h3>
             <p>Instantiates the blueprint by calling the given functions.</p>
             <table class="m-table m-fullwidth m-flat">
@@ -391,17 +394,22 @@ <h3>
                   <td>relate</td>
                   <td>Function used to add relations to entities.</td>
                 </tr>
+                <tr>
+                  <td>withName</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>
           </div></section>
-          <section class="m-doc-details" id="a1b382dfc2eb8c5e30f4d7d99637e7259"><div>
+          <section class="m-doc-details" id="a051c0ccbaafb5771789bb3b11352d5c4"><div>
             <h3>
               <div class="m-doc-template">
                 template&lt;typename C, typename A, typename R&gt;
               </div>
-              <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="#a1b382dfc2eb8c5e30f4d7d99637e7259" class="m-doc-self">instantiate</a>(</span><span class="m-doc-wrap">C create,
+              <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="#a051c0ccbaafb5771789bb3b11352d5c4" class="m-doc-self">instantiate</a>(</span><span class="m-doc-wrap">C create,
               A add,
-              R relate) const</span></span>
+              R relate,
+              bool withName) const</span></span>
             </h3>
             <p>Instantiates the blueprint by calling the given functors.</p>
             <table class="m-table m-fullwidth m-flat">
@@ -438,6 +446,10 @@ <h3>
                   <td>relate</td>
                   <td>Functor used to add relations to entities.</td>
                 </tr>
+                <tr>
+                  <td>withName</td>
+                  <td>Whether to use the entity names from the blueprint.</td>
+                </tr>
               </tbody>
             </table>
           </div></section>

diff --git a/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1CommandBuffer.html b/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1CommandBuffer.html
@@ -83,7 +83,8 @@ <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="#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>
+              <span class="m-doc-wrap-bumper">auto <a href="#a00bfe2a41883e8af1d2987f667a20e22" 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 = true) -&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>
@@ -170,9 +171,10 @@ <h3>
               </tbody>
             </table>
           </div></section>
-          <section class="m-doc-details" id="ab007fa3430e28a20f5cd9975d2aa4c26"><div>
+          <section class="m-doc-details" id="a00bfe2a41883e8af1d2987f667a20e22"><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="#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>
+              <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="#a00bfe2a41883e8af1d2987f667a20e22" 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 = true)</span></span>
             </h3>
             <p>Spawns a blueprint into the world.</p>
             <table class="m-table m-fullwidth m-flat">
@@ -184,6 +186,10 @@ <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>

diff --git a/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1Commands.html b/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1Commands.html
@@ -88,7 +88,8 @@ <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="#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>
+              <span class="m-doc-wrap-bumper">auto <a href="#ab21595883fc5237b145b2503f940fc09" 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 = true) -&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>
@@ -191,9 +192,10 @@ <h3>
               </tbody>
             </table>
           </div></section>
-          <section class="m-doc-details" id="a0c75cfde6373904798ba117b9627cd5f"><div>
+          <section class="m-doc-details" id="ab21595883fc5237b145b2503f940fc09"><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="#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>
+              <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="#ab21595883fc5237b145b2503f940fc09" 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 = true)</span></span>
             </h3>
             <p>Spawns a blueprint into the world.</p>
             <table class="m-table m-fullwidth m-flat">
@@ -205,6 +207,10 @@ <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>

diff --git a/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1World.html b/docs-preview/pr-913/classcubos_1_1core_1_1ecs_1_1World.html
@@ -56,12 +56,22 @@ <h3>Contents</h3>
             <li>
               Reference
               <ul>
+                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                 <li><a href="#pub-methods">Public functions</a></li>
               </ul>
             </li>
           </ul>
         </nav>
 <aside class="m-note m-default"><h4>See also</h4><p>Internally, <a href="classcubos_1_1core_1_1ecs_1_1World.html#a23d21a46e982a60f3ac0f875abccb0d8" class="m-doc">components</a> are stored in abstract containers called Storage&#x27;s.</p></aside>
+        <section id="typeless-methods">
+          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
+          <dl class="m-doc">
+            <dt id="a696d78e6cd6320af4c517121a03b6ec7">
+              <span class="m-doc-wrap-bumper"><a href="#a696d78e6cd6320af4c517121a03b6ec7" class="m-doc-self">World</a>(</span><span class="m-doc-wrap">)</span>
+            </dt>
+            <dd><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a> constructor.</dd>
+          </dl>
+        </section>
         <section id="pub-methods">
           <h2><a href="#pub-methods">Public functions</a></h2>
           <dl class="m-doc">

diff --git a/docs-preview/pr-913/dir_b6daa990b896c2c0c53126427e4d978d.html b/docs-preview/pr-913/dir_b6daa990b896c2c0c53126427e4d978d.html
@@ -85,6 +85,8 @@ <h2><a href="#files">Files</a></h2>
             <dd>Class <a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">cubos::<wbr />core::<wbr />ecs::<wbr />CommandBuffer</a>.</dd>
             <dt>file <a href="cubos_8hpp.html" class="m-doc">cubos.hpp</a></dt>
             <dd>Class <a href="namespacecubos_1_1engine.html#afa0b202a1b9f7ddf7c42db16c8dbb7ba" class="m-doc">cubos::<wbr />engine::<wbr />Cubos</a>.</dd>
+            <dt>file <a href="name_8hpp.html" class="m-doc">name.hpp</a></dt>
+            <dd>Class <a href="structcubos_1_1core_1_1ecs_1_1Name.html" class="m-doc">cubos::<wbr />core::<wbr />ecs::<wbr />Name</a>.</dd>
             <dt>file <a href="reflection_8hpp.html" class="m-doc">reflection.hpp</a></dt>
             <dd>Class <a href="classcubos_1_1core_1_1ecs_1_1TypeBuilder.html" class="m-doc">cubos::<wbr />core::<wbr />ecs::<wbr />TypeBuilder</a>.</dd>
             <dt>file <a href="types_8hpp.html" class="m-doc">types.hpp</a></dt>