0
0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 09:03:42 +00:00
SDL_Minigame/classManager.html

275 lines
13 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: Manager 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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('classManager.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-methods">Public Member Functions</a> &#124;
<a href="classManager-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Manager Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Is responsible for managing all entities.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Manager_8h_source.html">Manager.h</a>&gt;</code></p>
<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:ab76ac7deabcf2a203a227c228c27c02b" id="r_ab76ac7deabcf2a203a227c228c27c02b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab76ac7deabcf2a203a227c228c27c02b">update</a> (uint_fast16_t diffTime)</td></tr>
<tr class="separator:ab76ac7deabcf2a203a227c228c27c02b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc5c66704fd1b0a9b9d38de8fdcb3748" id="r_adc5c66704fd1b0a9b9d38de8fdcb3748"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adc5c66704fd1b0a9b9d38de8fdcb3748">refresh</a> ()</td></tr>
<tr class="separator:adc5c66704fd1b0a9b9d38de8fdcb3748"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae16a3d76e450281012c526541ebeb5b" id="r_aae16a3d76e450281012c526541ebeb5b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classEntity.html">Entity</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae16a3d76e450281012c526541ebeb5b">getAll</a> ()</td></tr>
<tr class="memdesc:aae16a3d76e450281012c526541ebeb5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all entities currently loaded in the game. <br /></td></tr>
<tr class="separator:aae16a3d76e450281012c526541ebeb5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6be095e14d18da37fdb2f8bdb4b48b5a" id="r_a6be095e14d18da37fdb2f8bdb4b48b5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classEntity.html">Entity</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6be095e14d18da37fdb2f8bdb4b48b5a">addEntity</a> ()</td></tr>
<tr class="memdesc:a6be095e14d18da37fdb2f8bdb4b48b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new entity to the game. <br /></td></tr>
<tr class="separator:a6be095e14d18da37fdb2f8bdb4b48b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe31f4dc1f7d613cf0ca9cafc2bb90a" id="r_a4fe31f4dc1f7d613cf0ca9cafc2bb90a"><td class="memItemLeft" align="right" valign="top">GameInternal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4fe31f4dc1f7d613cf0ca9cafc2bb90a">getGame</a> ()</td></tr>
<tr class="separator:a4fe31f4dc1f7d613cf0ca9cafc2bb90a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Is responsible for managing all entities. </p>
<p>The manager class handles update and draw calls collectively for all entities, and provides functionality to get all or a subset of all entities </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classEntity.html" title="Main class for any object in game, stores associations, labeling and components.">Entity</a> </dd>
<dd>
<a class="el" href="classEntity.html#a9449a7a0ad2c9ae5ee85ef2401382f2b" title="Some premade Entity groups used to avoid checking all entities for everything all of the time.">Entity::GroupLabel</a> </dd>
<dd>
Entity::TeamLabel </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6be095e14d18da37fdb2f8bdb4b48b5a" name="a6be095e14d18da37fdb2f8bdb4b48b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6be095e14d18da37fdb2f8bdb4b48b5a">&#9670;&#160;</a></span>addEntity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEntity.html">Entity</a> &amp; Manager::addEntity </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new entity to the game. </p>
<p>Creates and returns a new, empty entity </p>
</div>
</div>
<a id="aae16a3d76e450281012c526541ebeb5b" name="aae16a3d76e450281012c526541ebeb5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae16a3d76e450281012c526541ebeb5b">&#9670;&#160;</a></span>getAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="classEntity.html">Entity</a> * &gt; Manager::getAll </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns all entities currently loaded in the game. </p>
<dl class="section return"><dt>Returns</dt><dd>std::vector containing all entities </dd></dl>
</div>
</div>
<a id="a4fe31f4dc1f7d613cf0ca9cafc2bb90a" name="a4fe31f4dc1f7d613cf0ca9cafc2bb90a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fe31f4dc1f7d613cf0ca9cafc2bb90a">&#9670;&#160;</a></span>getGame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GameInternal * Manager::getGame </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="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated</a></b></dt><dd>Use VEGO_Game() instead </dd></dl>
</div>
</div>
<a id="adc5c66704fd1b0a9b9d38de8fdcb3748" name="adc5c66704fd1b0a9b9d38de8fdcb3748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc5c66704fd1b0a9b9d38de8fdcb3748">&#9670;&#160;</a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Manager::refresh </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disables all functionality of entities marked for destruction <br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classEntity.html#a691dbe5f9ec930c27af2af0b97907a9e">Entity::destroy()</a> </dd></dl>
</div>
</div>
<a id="ab76ac7deabcf2a203a227c228c27c02b" name="ab76ac7deabcf2a203a227c228c27c02b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab76ac7deabcf2a203a227c228c27c02b">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Manager::update </td>
<td>(</td>
<td class="paramtype">uint_fast16_t</td> <td class="paramname"><span class="paramname"><em>diffTime</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classEntity.html#af4415c165338eed191ee0cddf550732b" title="Call each frame to update all components.">Entity::update()</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="Manager_8h_source.html">Manager.h</a></li>
<li>src/<b>Manager.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="classManager.html">Manager</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>