Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API reference v3.10.0

Browse Source
This commit is contained in:
Michele Caini
2022-04-18 19:54:29 +02:00
parent 6fdc43199c
commit 378182736c
1056 changed files with 21834 additions and 21924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
structentt_1_1basic__handle.html
View File

@@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.9.0</span>
&#160;<span id="projectnumber">3.10.0</span>
</div>
</td>
</tr>
@@ -78,7 +78,7 @@ $(function() {
<p>Non-owning handle to an entity.
<a href="structentt_1_1basic__handle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>&gt;</code></p>
<p><code>#include &lt;<a class="el" href="handle_8hpp_source.html">handle.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
@@ -199,7 +199,7 @@ struct entt::basic_handle&lt; Entity, Type &gt;</h3>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00023">23</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00023">23</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9f88bf2f8fcb94b5ffe0f1290500004a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f88bf2f8fcb94b5ffe0f1290500004a">&#9670;&nbsp;</a></span>basic_handle()</h2>
@@ -246,7 +246,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00043">43</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00043">43</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -288,7 +288,7 @@ template&lt;typename... Component&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has all the components, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00205">205</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00205">205</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -329,7 +329,7 @@ template&lt;typename... Component&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has at least one of the given components, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00217">217</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00217">217</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -361,7 +361,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Destroys the entity associated with a handle. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a7b2c0368d508a6af2d094a9fc592a4a0" title="Destroys an entity and releases its identifier.">basic_registry::destroy</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00106">106</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00106">106</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -400,7 +400,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00115">115</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00115">115</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -449,7 +449,7 @@ template&lt;typename Component , typename... Args&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00128">128</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00128">128</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -498,7 +498,7 @@ template&lt;typename Component , typename... Args&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00142">142</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00142">142</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -530,7 +530,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Returns the entity associated with a handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The entity associated with the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00098">98</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00098">98</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -570,7 +570,7 @@ template&lt;typename... Component&gt; </div>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00193">193</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00193">193</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -611,7 +611,7 @@ template&lt;typename... Component&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>References to the components owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00228">228</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00228">228</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -660,7 +660,7 @@ template&lt;typename Component , typename... Args&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to the component owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00242">242</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00242">242</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -701,7 +701,7 @@ template&lt;typename Other , typename... Args&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A const handle referring to the same registry and the same entity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00055">55</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00055">55</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -733,7 +733,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Checks if a handle refers to non-null registry pointer and entity. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle refers to non-null registry and entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00074">74</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00074">74</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -765,7 +765,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Converts a handle to its underlying entity. </p>
<dl class="section return"><dt>Returns</dt><dd>The contained identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00066">66</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00066">66</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -797,7 +797,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Checks if a handle has components assigned. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has no components assigned, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00263">263</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00263">263</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -846,7 +846,7 @@ template&lt;typename Component , typename... Func&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the patched component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00156">156</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00156">156</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -878,7 +878,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Returns a pointer to the underlying registry, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the underlying registry, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00090">90</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00090">90</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -919,7 +919,7 @@ template&lt;typename... Component&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of components actually removed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00182">182</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00182">182</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -968,7 +968,7 @@ template&lt;typename Component , typename... Args&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the component being replaced. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00170">170</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00170">170</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -1009,7 +1009,7 @@ template&lt;typename... Component&gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointers to the components owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00254">254</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00254">254</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -1041,7 +1041,7 @@ template&lt;typename Entity , typename... Type&gt; </div>
<p>Checks if a handle refers to a valid entity or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle refers to a valid entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00082">82</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00082">82</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
@@ -1076,7 +1076,7 @@ template&lt;typename Func &gt; </div>
<p>Visits a handle and returns the pools for its components. </p>
<p>The signature of the function should be equivalent to the following:</p>
<div class="fragment"><div class="line">void(<a class="code" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>, <span class="keyword">const</span> basic_sparse_set&lt;entity_type&gt; &amp;);</div>
<div class="ttc" id="anamespaceentt_html_a13e040e7b38a8f86d1ab2f096f37b627"><div class="ttname"><a href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">entt::id_type</a></div><div class="ttdeci">std::uint32_t id_type</div><div class="ttdoc">Alias declaration for type identifiers.</div><div class="ttdef"><b>Definition:</b> <a href="core_2fwd_8hpp_source.html#l00013">fwd.hpp:13</a></div></div>
<div class="ttc" id="anamespaceentt_html_a13e040e7b38a8f86d1ab2f096f37b627"><div class="ttname"><a href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">entt::id_type</a></div><div class="ttdeci">std::uint32_t id_type</div><div class="ttdoc">Alias declaration for type identifiers.</div><div class="ttdef"><b>Definition:</b> <a href="core_2fwd_8hpp_source.html#l00014">fwd.hpp:14</a></div></div>
</div><!-- fragment --><p>Returned pools are those that contain the entity associated with the handle.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
@@ -1091,13 +1091,13 @@ template&lt;typename Func &gt; </div>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00283">283</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00283">283</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
<li>src/entt/entity/<a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a></li>
<li>src/entt/entity/<a class="el" href="handle_8hpp_source.html">handle.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->