mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 09:03:42 +00:00
483 lines
25 KiB
HTML
483 lines
25 KiB
HTML
<!-- HTML header for doxygen 1.10.0-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11" />
|
|
<meta name="generator" content="Doxygen 1.13.2" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>VEGO-Engine: Entity Class 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeDarkModeToggle.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeParagraphLink.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
</script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
|
<link href="custom.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VEGO-Engine
|
|
<span id="projectnumber"> 0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classEntity.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classEntity-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">Entity Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Main class for any object in game, stores associations, labeling and components.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Entity_8h_source.html">Entity.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a9449a7a0ad2c9ae5ee85ef2401382f2b" id="r_a9449a7a0ad2c9ae5ee85ef2401382f2b"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2b">GroupLabel</a> { <br />
|
|
  <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2ba924bf7180d60940e428a9166b51ce0f4">MAPTILES</a>
|
|
, <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2bae334ea4bb6fd38968f6809b091120ad8">PLAYERS</a>
|
|
, <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2badffa23e89f914b343e7811b01a8f756c">COLLIDERS</a>
|
|
, <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2ba46dccab75ce652352e52086601fdc294">PROJECTILE</a>
|
|
, <br />
|
|
  <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2bad52d2d4c0b7218c48897d2e69e156ba4">HEARTS</a>
|
|
, <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2ba5262638eb9e1d1af560f3d0f9ad133e4">POWERUPS</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a9449a7a0ad2c9ae5ee85ef2401382f2b"><td class="mdescLeft"> </td><td class="mdescRight">Some premade <a class="el" href="classEntity.html" title="Main class for any object in game, stores associations, labeling and components.">Entity</a> groups used to avoid checking all entities for everything all of the time. <a href="#a9449a7a0ad2c9ae5ee85ef2401382f2b">More...</a><br /></td></tr>
|
|
<tr class="separator:a9449a7a0ad2c9ae5ee85ef2401382f2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aad34087e815ec2da644b86ae2357039b" id="r_aad34087e815ec2da644b86ae2357039b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aad34087e815ec2da644b86ae2357039b">Entity</a> (<a class="el" href="classManager.html">Manager</a> &mManager)</td></tr>
|
|
<tr class="separator:aad34087e815ec2da644b86ae2357039b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4415c165338eed191ee0cddf550732b" id="r_af4415c165338eed191ee0cddf550732b"><td class="memItemLeft" align="right" valign="top"><a id="af4415c165338eed191ee0cddf550732b" name="af4415c165338eed191ee0cddf550732b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>update</b> (uint_fast16_t diffTime) const</td></tr>
|
|
<tr class="memdesc:af4415c165338eed191ee0cddf550732b"><td class="mdescLeft"> </td><td class="mdescRight">Call each frame to update all components. <br /></td></tr>
|
|
<tr class="separator:af4415c165338eed191ee0cddf550732b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea1c1568b4123d989c5310697030ad77" id="r_aea1c1568b4123d989c5310697030ad77"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea1c1568b4123d989c5310697030ad77">isActive</a> () const</td></tr>
|
|
<tr class="separator:aea1c1568b4123d989c5310697030ad77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a691dbe5f9ec930c27af2af0b97907a9e" id="r_a691dbe5f9ec930c27af2af0b97907a9e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a691dbe5f9ec930c27af2af0b97907a9e">destroy</a> ()</td></tr>
|
|
<tr class="separator:a691dbe5f9ec930c27af2af0b97907a9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdf7c696ee39da0d8ebddb1976ea0abe" id="r_acdf7c696ee39da0d8ebddb1976ea0abe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classManager.html">Manager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#acdf7c696ee39da0d8ebddb1976ea0abe">getManager</a> ()</td></tr>
|
|
<tr class="separator:acdf7c696ee39da0d8ebddb1976ea0abe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa622a8d79153a90d0e3b9b992ca2d38b" id="r_aa622a8d79153a90d0e3b9b992ca2d38b"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:aa622a8d79153a90d0e3b9b992ca2d38b"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa622a8d79153a90d0e3b9b992ca2d38b">hasComponent</a> () const</td></tr>
|
|
<tr class="separator:aa622a8d79153a90d0e3b9b992ca2d38b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae587a44fd803d7918a45dbfe531c962d" id="r_ae587a44fd803d7918a45dbfe531c962d"><td class="memTemplParams" colspan="2">template<typename T, typename... TArgs> </td></tr>
|
|
<tr class="memitem:ae587a44fd803d7918a45dbfe531c962d"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae587a44fd803d7918a45dbfe531c962d">addComponent</a> (TArgs &&...mArgs)</td></tr>
|
|
<tr class="memdesc:ae587a44fd803d7918a45dbfe531c962d"><td class="mdescLeft"> </td><td class="mdescRight">Adds specified type as component and calls Component::init() <br /></td></tr>
|
|
<tr class="separator:ae587a44fd803d7918a45dbfe531c962d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5ce9d4246498a5a2ffd163a2d38c98f" id="r_ad5ce9d4246498a5a2ffd163a2d38c98f"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ad5ce9d4246498a5a2ffd163a2d38c98f"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad5ce9d4246498a5a2ffd163a2d38c98f">getComponent</a> () const</td></tr>
|
|
<tr class="memdesc:ad5ce9d4246498a5a2ffd163a2d38c98f"><td class="mdescLeft"> </td><td class="mdescRight">Access a specific component of an entity. <br /></td></tr>
|
|
<tr class="separator:ad5ce9d4246498a5a2ffd163a2d38c98f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af153779f4ae16c3aa4d67a52f61333b7" id="r_af153779f4ae16c3aa4d67a52f61333b7"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:af153779f4ae16c3aa4d67a52f61333b7"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af153779f4ae16c3aa4d67a52f61333b7">getComponentAsPointer</a> () const</td></tr>
|
|
<tr class="memdesc:af153779f4ae16c3aa4d67a52f61333b7"><td class="mdescLeft"> </td><td class="mdescRight">Access a specific component of an entity as a pointer. <br /></td></tr>
|
|
<tr class="separator:af153779f4ae16c3aa4d67a52f61333b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Main class for any object in game, stores associations, labeling and components. </p>
|
|
<p>The entity class is the primary class each object in the game needs to use. Add components to assign functionality.</p>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo</a></b></dt><dd><p class="startdd">More detailed description </p>
|
|
<p class="enddd">Some functions in entity class are only supposed to be called in specific context, which might be valid uses for <code>friend</code> keyword. Example: <a class="el" href="#aad34087e815ec2da644b86ae2357039b">Entity()</a> should only be called from <a class="el" href="classManager.html#a6be095e14d18da37fdb2f8bdb4b48b5a" title="Add a new entity to the game.">Manager::addEntity()</a>. Verify each functions intended use/scope.</p>
|
|
</dd></dl>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a9449a7a0ad2c9ae5ee85ef2401382f2b" name="a9449a7a0ad2c9ae5ee85ef2401382f2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9449a7a0ad2c9ae5ee85ef2401382f2b">◆ </a></span>GroupLabel</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum class <a class="el" href="#a9449a7a0ad2c9ae5ee85ef2401382f2b">Entity::GroupLabel</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Some premade <a class="el" href="classEntity.html" title="Main class for any object in game, stores associations, labeling and components.">Entity</a> groups used to avoid checking all entities for everything all of the time. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2ba924bf7180d60940e428a9166b51ce0f4" name="a9449a7a0ad2c9ae5ee85ef2401382f2ba924bf7180d60940e428a9166b51ce0f4"></a>MAPTILES </td><td class="fielddoc"><p><a class="el" href="classEntity.html" title="Main class for any object in game, stores associations, labeling and components.">Entity</a> using TileComponent, internal use. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2bae334ea4bb6fd38968f6809b091120ad8" name="a9449a7a0ad2c9ae5ee85ef2401382f2bae334ea4bb6fd38968f6809b091120ad8"></a>PLAYERS </td><td class="fielddoc"><p>Primary entity in player control, used to be able to interact with pickupables. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2badffa23e89f914b343e7811b01a8f756c" name="a9449a7a0ad2c9ae5ee85ef2401382f2badffa23e89f914b343e7811b01a8f756c"></a>COLLIDERS </td><td class="fielddoc"><p>Fixed collider entity, e.g. a wall. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2ba46dccab75ce652352e52086601fdc294" name="a9449a7a0ad2c9ae5ee85ef2401382f2ba46dccab75ce652352e52086601fdc294"></a>PROJECTILE </td><td class="fielddoc"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo</a></b></dt><dd>Document </dd></dl>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2bad52d2d4c0b7218c48897d2e69e156ba4" name="a9449a7a0ad2c9ae5ee85ef2401382f2bad52d2d4c0b7218c48897d2e69e156ba4"></a>HEARTS </td><td class="fielddoc"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo</a></b></dt><dd>Document </dd></dl>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9449a7a0ad2c9ae5ee85ef2401382f2ba5262638eb9e1d1af560f3d0f9ad133e4" name="a9449a7a0ad2c9ae5ee85ef2401382f2ba5262638eb9e1d1af560f3d0f9ad133e4"></a>POWERUPS </td><td class="fielddoc"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo</a></b></dt><dd>Document <br />
|
|
</dd></dl>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aad34087e815ec2da644b86ae2357039b" name="aad34087e815ec2da644b86ae2357039b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad34087e815ec2da644b86ae2357039b">◆ </a></span>Entity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Entity::Entity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classManager.html">Manager</a> &</td> <td class="paramname"><span class="paramname"><em>mManager</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo</a></b></dt><dd>Document </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae587a44fd803d7918a45dbfe531c962d" name="ae587a44fd803d7918a45dbfe531c962d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae587a44fd803d7918a45dbfe531c962d">◆ </a></span>addComponent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, typename... TArgs> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T & Entity::addComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">TArgs &&...</td> <td class="paramname"><span class="paramname"><em>mArgs</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds specified type as component and calls Component::init() </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mArgs</td><td>Constructor arguments of component </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a691dbe5f9ec930c27af2af0b97907a9e" name="a691dbe5f9ec930c27af2af0b97907a9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a691dbe5f9ec930c27af2af0b97907a9e">◆ </a></span>destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::destroy </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Mark for destruction for <a class="el" href="classManager.html#adc5c66704fd1b0a9b9d38de8fdcb3748">Manager::refresh()</a> and disables collision </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classColliderComponent.html" title="Adds a collision box to an entity when added via entity.addComponent()">ColliderComponent</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5ce9d4246498a5a2ffd163a2d38c98f" name="ad5ce9d4246498a5a2ffd163a2d38c98f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5ce9d4246498a5a2ffd163a2d38c98f">◆ </a></span>getComponent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T & Entity::getComponent </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access a specific component of an entity. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Type of component to access </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to component of type T < </dd></dl>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo</a></b></dt><dd>: rewrite to use optionals </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af153779f4ae16c3aa4d67a52f61333b7" name="af153779f4ae16c3aa4d67a52f61333b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af153779f4ae16c3aa4d67a52f61333b7">◆ </a></span>getComponentAsPointer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr< T > Entity::getComponentAsPointer </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access a specific component of an entity as a pointer. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Type of component to access </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to component of type T </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acdf7c696ee39da0d8ebddb1976ea0abe" name="acdf7c696ee39da0d8ebddb1976ea0abe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acdf7c696ee39da0d8ebddb1976ea0abe">◆ </a></span>getManager()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classManager.html">Manager</a> & Entity::getManager </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classManager.html" title="Is responsible for managing all entities.">Manager</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa622a8d79153a90d0e3b9b992ca2d38b" name="aa622a8d79153a90d0e3b9b992ca2d38b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa622a8d79153a90d0e3b9b992ca2d38b">◆ </a></span>hasComponent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Entity::hasComponent </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section see"><dt>See also</dt><dd>Component </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea1c1568b4123d989c5310697030ad77" name="aea1c1568b4123d989c5310697030ad77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea1c1568b4123d989c5310697030ad77">◆ </a></span>isActive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Entity::isActive </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a691dbe5f9ec930c27af2af0b97907a9e">destroy()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>include/<a class="el" href="Entity_8h_source.html">Entity.h</a></li>
|
|
<li>src/<b>Entity.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classEntity.html">Entity</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|