Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5bad99476dc36272c2e9983b90ca647fc2297b65
entt/structentt_1_1Actor.html
Michele Caini 5bad99476d API reference v2.3.0
2017-12-14 23:18:50 +01:00

582 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>entt: entt::Actor&lt; Entity, Delta &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">entt
&#160;<span id="projectnumber">2.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1Actor.html">Actor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1Actor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::Actor&lt; Entity, Delta &gt; Struct Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Dedicated to those who aren't confident with entity-component systems.
<a href="structentt_1_1Actor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="actor_8hpp_source.html">actor.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>
<tr class="memitem:a985b72f734944acd3691a8f22da886e4"><td class="memItemLeft" align="right" valign="top"><a id="a985b72f734944acd3691a8f22da886e4"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4">registry_type</a> = <a class="el" href="classentt_1_1Registry.html">Registry</a>&lt; Entity &gt;</td></tr>
<tr class="memdesc:a985b72f734944acd3691a8f22da886e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of registry used internally. <br /></td></tr>
<tr class="separator:a985b72f734944acd3691a8f22da886e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a681204f0400537f8ca6b0ad0cfcdaa52"><td class="memItemLeft" align="right" valign="top"><a id="a681204f0400537f8ca6b0ad0cfcdaa52"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">delta_type</a> = Delta</td></tr>
<tr class="memdesc:a681204f0400537f8ca6b0ad0cfcdaa52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
<tr class="separator:a681204f0400537f8ca6b0ad0cfcdaa52"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa55414e7e6ad064d9f72d391d3a0884b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b">Actor</a> (<a class="el" href="classentt_1_1Registry.html">Registry</a>&lt; Entity &gt; &amp;reg)</td></tr>
<tr class="memdesc:aa55414e7e6ad064d9f72d391d3a0884b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an actor by using the given registry. <a href="#aa55414e7e6ad064d9f72d391d3a0884b">More...</a><br /></td></tr>
<tr class="separator:aa55414e7e6ad064d9f72d391d3a0884b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbc1727eba50bf378bca0a8d50fcf779"><td class="memItemLeft" align="right" valign="top"><a id="abbc1727eba50bf378bca0a8d50fcf779"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#abbc1727eba50bf378bca0a8d50fcf779">~Actor</a> ()</td></tr>
<tr class="memdesc:abbc1727eba50bf378bca0a8d50fcf779"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:abbc1727eba50bf378bca0a8d50fcf779"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d1037c1560e61445a34ba948d249b03"><td class="memItemLeft" align="right" valign="top"><a id="a6d1037c1560e61445a34ba948d249b03"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a6d1037c1560e61445a34ba948d249b03">Actor</a> (const <a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;)=default</td></tr>
<tr class="memdesc:a6d1037c1560e61445a34ba948d249b03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy constructor. <br /></td></tr>
<tr class="separator:a6d1037c1560e61445a34ba948d249b03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd6eea6ee3fa37462bd0ce132a167e6c"><td class="memItemLeft" align="right" valign="top"><a id="afd6eea6ee3fa37462bd0ce132a167e6c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#afd6eea6ee3fa37462bd0ce132a167e6c">Actor</a> (<a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:afd6eea6ee3fa37462bd0ce132a167e6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:afd6eea6ee3fa37462bd0ce132a167e6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a834298175f56e310cf6de3215fe41bdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a834298175f56e310cf6de3215fe41bdc">operator=</a> (const <a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;)=default</td></tr>
<tr class="memdesc:a834298175f56e310cf6de3215fe41bdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator. <a href="#a834298175f56e310cf6de3215fe41bdc">More...</a><br /></td></tr>
<tr class="separator:a834298175f56e310cf6de3215fe41bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0125d561621c4b40440f70ace640c3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#ab0125d561621c4b40440f70ace640c3f">operator=</a> (<a class="el" href="structentt_1_1Actor.html">Actor</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ab0125d561621c4b40440f70ace640c3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <a href="#ab0125d561621c4b40440f70ace640c3f">More...</a><br /></td></tr>
<tr class="separator:ab0125d561621c4b40440f70ace640c3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1055479e21732516c67615e906c76bc3"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a1055479e21732516c67615e906c76bc3"><td class="memTemplItemLeft" align="right" valign="top">Component &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a1055479e21732516c67615e906c76bc3">set</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:a1055479e21732516c67615e906c76bc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the given component to an actor. <a href="#a1055479e21732516c67615e906c76bc3">More...</a><br /></td></tr>
<tr class="separator:a1055479e21732516c67615e906c76bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d655b4e1afe76293b4ef7524f51d81a"><td class="memTemplParams" colspan="2">template&lt;typename Component &gt; </td></tr>
<tr class="memitem:a8d655b4e1afe76293b4ef7524f51d81a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a8d655b4e1afe76293b4ef7524f51d81a">unset</a> ()</td></tr>
<tr class="memdesc:a8d655b4e1afe76293b4ef7524f51d81a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given component from an actor. <a href="#a8d655b4e1afe76293b4ef7524f51d81a">More...</a><br /></td></tr>
<tr class="separator:a8d655b4e1afe76293b4ef7524f51d81a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec49ed1965b977a9b9b1169cc6596f48"><td class="memTemplParams" colspan="2">template&lt;typename Component &gt; </td></tr>
<tr class="memitem:aec49ed1965b977a9b9b1169cc6596f48"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#aec49ed1965b977a9b9b1169cc6596f48">has</a> () const noexcept</td></tr>
<tr class="memdesc:aec49ed1965b977a9b9b1169cc6596f48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if an actor has the given component. <a href="#aec49ed1965b977a9b9b1169cc6596f48">More...</a><br /></td></tr>
<tr class="separator:aec49ed1965b977a9b9b1169cc6596f48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a995069fd7c86bd152e1eaac811fb56dd"><td class="memTemplParams" colspan="2">template&lt;typename Component &gt; </td></tr>
<tr class="memitem:a995069fd7c86bd152e1eaac811fb56dd"><td class="memTemplItemLeft" align="right" valign="top">const Component &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a995069fd7c86bd152e1eaac811fb56dd">get</a> () const noexcept</td></tr>
<tr class="memdesc:a995069fd7c86bd152e1eaac811fb56dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the given component for an actor. <a href="#a995069fd7c86bd152e1eaac811fb56dd">More...</a><br /></td></tr>
<tr class="separator:a995069fd7c86bd152e1eaac811fb56dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5f572a978820e9055a9778774221104"><td class="memTemplParams" colspan="2">template&lt;typename Component &gt; </td></tr>
<tr class="memitem:ae5f572a978820e9055a9778774221104"><td class="memTemplItemLeft" align="right" valign="top">Component &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#ae5f572a978820e9055a9778774221104">get</a> () noexcept</td></tr>
<tr class="memdesc:ae5f572a978820e9055a9778774221104"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the given component for an actor. <a href="#ae5f572a978820e9055a9778774221104">More...</a><br /></td></tr>
<tr class="separator:ae5f572a978820e9055a9778774221104"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fe052f3501732231e6ae3e02f57f68b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4">registry_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a3fe052f3501732231e6ae3e02f57f68b">registry</a> () const noexcept</td></tr>
<tr class="memdesc:a3fe052f3501732231e6ae3e02f57f68b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the underlying registry. <a href="#a3fe052f3501732231e6ae3e02f57f68b">More...</a><br /></td></tr>
<tr class="separator:a3fe052f3501732231e6ae3e02f57f68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15b718300c2868451394a9af0f7cc254"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4">registry_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#a15b718300c2868451394a9af0f7cc254">registry</a> () noexcept</td></tr>
<tr class="memdesc:a15b718300c2868451394a9af0f7cc254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the underlying registry. <a href="#a15b718300c2868451394a9af0f7cc254">More...</a><br /></td></tr>
<tr class="separator:a15b718300c2868451394a9af0f7cc254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac83169b04dcdb12d8c3288eb48261ac6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1Actor.html#ac83169b04dcdb12d8c3288eb48261ac6">update</a> (<a class="el" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">delta_type</a> delta)=0</td></tr>
<tr class="memdesc:ac83169b04dcdb12d8c3288eb48261ac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates an actor, whatever it means to update it. <a href="#ac83169b04dcdb12d8c3288eb48261ac6">More...</a><br /></td></tr>
<tr class="separator:ac83169b04dcdb12d8c3288eb48261ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Entity, typename Delta&gt;<br />
struct entt::Actor&lt; Entity, Delta &gt;</h3>
<p>Dedicated to those who aren't confident with entity-component systems. </p>
<p>Tiny wrapper around a registry, for all those users that aren't confident with entity-component systems and prefer to iterate objects directly.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>A valid entity type (see <a class="el" href="structentt_1_1entt__traits.html" title="Entity traits. ">entt_traits</a> for more details). </td></tr>
<tr><td class="paramname">Delta</td><td>Type to use to provide elapsed time. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00022">22</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa55414e7e6ad064d9f72d391d3a0884b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa55414e7e6ad064d9f72d391d3a0884b">&#9670;&nbsp;</a></span>Actor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::<a class="el" href="structentt_1_1Actor.html">Actor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1Registry.html">Registry</a>&lt; Entity &gt; &amp;&#160;</td>
<td class="paramname"><em>reg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an actor by using the given registry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reg</td><td>An entity-component system properly initialized. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00032">32</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a995069fd7c86bd152e1eaac811fb56dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a995069fd7c86bd152e1eaac811fb56dd">&#9670;&nbsp;</a></span>get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Component &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Component&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the given component for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the instance of the component owned by the entity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00095">95</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ae5f572a978820e9055a9778774221104"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5f572a978820e9055a9778774221104">&#9670;&nbsp;</a></span>get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Component &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Component&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the given component for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the instance of the component owned by the entity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00105">105</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="aec49ed1965b977a9b9b1169cc6596f48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec49ed1965b977a9b9b1169cc6596f48">&#9670;&nbsp;</a></span>has()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Component &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::has </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if an actor has the given component. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component for which to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the actor has the component, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00085">85</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a834298175f56e310cf6de3215fe41bdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a834298175f56e310cf6de3215fe41bdc">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1Actor.html">Actor</a>&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1Actor.html">Actor</a>&lt; Entity, Delta &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default copy assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This actor. </dd></dl>
</div>
</div>
<a id="ab0125d561621c4b40440f70ace640c3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0125d561621c4b40440f70ace640c3f">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1Actor.html">Actor</a>&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1Actor.html">Actor</a>&lt; Entity, Delta &gt; &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This actor. </dd></dl>
</div>
</div>
<a id="a3fe052f3501732231e6ae3e02f57f68b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fe052f3501732231e6ae3e02f57f68b">&#9670;&nbsp;</a></span>registry() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4">registry_type</a>&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::registry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the underlying registry. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the underlying registry </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00113">113</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a15b718300c2868451394a9af0f7cc254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b718300c2868451394a9af0f7cc254">&#9670;&nbsp;</a></span>registry() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4">registry_type</a>&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::registry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the underlying registry. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the underlying registry </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00121">121</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a1055479e21732516c67615e906c76bc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1055479e21732516c67615e906c76bc3">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Component&amp; <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::set </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns the given component to an actor. </p>
<p>A new instance of the given component is created and initialized with the arguments provided (the component must have a proper constructor or be of aggregate type). Then the component is assigned to the actor.<br />
In case the actor already has a component of the given type, it's replaced with the new one.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to create. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</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="actor_8hpp_source.html#l00066">66</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a8d655b4e1afe76293b4ef7524f51d81a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d655b4e1afe76293b4ef7524f51d81a">&#9670;&nbsp;</a></span>unset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<div class="memtemplate">
template&lt;typename Component &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::unset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the given component from an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to remove. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00075">75</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ac83169b04dcdb12d8c3288eb48261ac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac83169b04dcdb12d8c3288eb48261ac6">&#9670;&nbsp;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity , typename Delta &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="structentt_1_1Actor.html">entt::Actor</a>&lt; Entity, Delta &gt;::update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">delta_type</a>&#160;</td>
<td class="paramname"><em>delta</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates an actor, whatever it means to update it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>Elapsed time. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/entity/<a class="el" href="actor_8hpp_source.html">actor.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink