zoriya/Bomberman
1
0
Fork 0
mirror of https://github.com/zoriya/Bomberman.git synced 2026-06-03 18:31:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
Bomberman/classWAL_1_1Wal.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

662 lines
32 KiB
HTML
Raw Permalink Blame History

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: WAL::Wal 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>
<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">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="namespaceWAL.html">WAL</a></li><li class="navelem"><a class="el" href="classWAL_1_1Wal.html">Wal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classWAL_1_1Wal-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">WAL::Wal Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The main <a class="el" href="namespaceWAL.html">WAL</a> class, it is used to setup and run the ECS.
<a href="classWAL_1_1Wal.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Wal_8hpp_source.html">Wal.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for WAL::Wal:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classWAL_1_1Wal__coll__graph.svg" width="158" height="294"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<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:afcee9d67a8530cc86d40b2de999f91bf"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classWAL_1_1Scene.html">Scene</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#afcee9d67a8530cc86d40b2de999f91bf">getScene</a> () const</td></tr>
<tr class="memdesc:afcee9d67a8530cc86d40b2de999f91bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the current scene. <a href="classWAL_1_1Wal.html#afcee9d67a8530cc86d40b2de999f91bf">More...</a><br /></td></tr>
<tr class="separator:afcee9d67a8530cc86d40b2de999f91bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4d0cfe9ad33241cb9eb4c9e5c8112fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#ad4d0cfe9ad33241cb9eb4c9e5c8112fa">changeScene</a> (std::shared_ptr&lt; <a class="el" href="classWAL_1_1Scene.html">Scene</a> &gt; newScene)</td></tr>
<tr class="memdesc:ad4d0cfe9ad33241cb9eb4c9e5c8112fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the current scene. <a href="classWAL_1_1Wal.html#ad4d0cfe9ad33241cb9eb4c9e5c8112fa">More...</a><br /></td></tr>
<tr class="separator:ad4d0cfe9ad33241cb9eb4c9e5c8112fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea455d51b82283da1885e67c2aeea861"><td class="memTemplParams" colspan="2">template&lt;typename T , class ... Types&gt; </td></tr>
<tr class="memitem:aea455d51b82283da1885e67c2aeea861"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#aea455d51b82283da1885e67c2aeea861">addSystem</a> (Types &amp;&amp;...params)</td></tr>
<tr class="memdesc:aea455d51b82283da1885e67c2aeea861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new system in place. <a href="classWAL_1_1Wal.html#aea455d51b82283da1885e67c2aeea861">More...</a><br /></td></tr>
<tr class="separator:aea455d51b82283da1885e67c2aeea861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c111817ce73593786509e1c30e5461a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a0c111817ce73593786509e1c30e5461a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a0c111817ce73593786509e1c30e5461a">addSystem</a> (const T &amp;system)</td></tr>
<tr class="memdesc:a0c111817ce73593786509e1c30e5461a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a system by copy. <a href="classWAL_1_1Wal.html#a0c111817ce73593786509e1c30e5461a">More...</a><br /></td></tr>
<tr class="separator:a0c111817ce73593786509e1c30e5461a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec9044ef7e8a200bd1e0334d1c192ec"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a6ec9044ef7e8a200bd1e0334d1c192ec"><td class="memTemplItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a6ec9044ef7e8a200bd1e0334d1c192ec">getSystem</a> ()</td></tr>
<tr class="memdesc:a6ec9044ef7e8a200bd1e0334d1c192ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a system of a specific type. <a href="classWAL_1_1Wal.html#a6ec9044ef7e8a200bd1e0334d1c192ec">More...</a><br /></td></tr>
<tr class="separator:a6ec9044ef7e8a200bd1e0334d1c192ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ba20195595548cefcd928e58e20dddc"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a8ba20195595548cefcd928e58e20dddc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a8ba20195595548cefcd928e58e20dddc">removeSystem</a> ()</td></tr>
<tr class="memdesc:a8ba20195595548cefcd928e58e20dddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a system using it's type. <a href="classWAL_1_1Wal.html#a8ba20195595548cefcd928e58e20dddc">More...</a><br /></td></tr>
<tr class="separator:a8ba20195595548cefcd928e58e20dddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a353969c3c8f5d630ec3944bfa9d36c6d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a353969c3c8f5d630ec3944bfa9d36c6d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a353969c3c8f5d630ec3944bfa9d36c6d">run</a> (const <a class="el" href="classWAL_1_1Callback.html">Callback</a>&lt; <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;, T &amp; &gt; &amp;callback, T state=T())</td></tr>
<tr class="memdesc:a353969c3c8f5d630ec3944bfa9d36c6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the game loop. <a href="classWAL_1_1Wal.html#a353969c3c8f5d630ec3944bfa9d36c6d">More...</a><br /></td></tr>
<tr class="separator:a353969c3c8f5d630ec3944bfa9d36c6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf404c6d2ff9bc7432a056af949355cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#adf404c6d2ff9bc7432a056af949355cd">Wal</a> ()=default</td></tr>
<tr class="memdesc:adf404c6d2ff9bc7432a056af949355cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default constructor. <a href="classWAL_1_1Wal.html#adf404c6d2ff9bc7432a056af949355cd">More...</a><br /></td></tr>
<tr class="separator:adf404c6d2ff9bc7432a056af949355cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a87d5cdd918258d0294e2ba0f244f3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a9a87d5cdd918258d0294e2ba0f244f3a">Wal</a> (const <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;)=delete</td></tr>
<tr class="memdesc:a9a87d5cdd918258d0294e2ba0f244f3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="namespaceWAL.html">WAL</a> can't be copy constructed. <a href="classWAL_1_1Wal.html#a9a87d5cdd918258d0294e2ba0f244f3a">More...</a><br /></td></tr>
<tr class="separator:a9a87d5cdd918258d0294e2ba0f244f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ab87bee9d53b34a9156c832af10e377"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a3ab87bee9d53b34a9156c832af10e377">~Wal</a> ()=default</td></tr>
<tr class="memdesc:a3ab87bee9d53b34a9156c832af10e377"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classWAL_1_1Wal.html#a3ab87bee9d53b34a9156c832af10e377">More...</a><br /></td></tr>
<tr class="separator:a3ab87bee9d53b34a9156c832af10e377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae636444e8f9051232e17e1456c9c4a7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#ae636444e8f9051232e17e1456c9c4a7d">operator=</a> (const <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;)=delete</td></tr>
<tr class="memdesc:ae636444e8f9051232e17e1456c9c4a7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="namespaceWAL.html">WAL</a> can't be assigned. <a href="classWAL_1_1Wal.html#ae636444e8f9051232e17e1456c9c4a7d">More...</a><br /></td></tr>
<tr class="separator:ae636444e8f9051232e17e1456c9c4a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a45a63cfffeb01e0bc978be48b8054478"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a45a63cfffeb01e0bc978be48b8054478">shouldClose</a> = false</td></tr>
<tr class="memdesc:a45a63cfffeb01e0bc978be48b8054478"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the engine should close after the end of the current tick. <a href="classWAL_1_1Wal.html#a45a63cfffeb01e0bc978be48b8054478">More...</a><br /></td></tr>
<tr class="separator:a45a63cfffeb01e0bc978be48b8054478"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a8e77e2c54f418a597f63620b9020d729"><td class="memItemLeft" align="right" valign="top">static constexpr std::chrono::nanoseconds&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a8e77e2c54f418a597f63620b9020d729">timestep</a> = std::chrono::milliseconds(32)</td></tr>
<tr class="memdesc:a8e77e2c54f418a597f63620b9020d729"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time between each fixed update. <a href="classWAL_1_1Wal.html#a8e77e2c54f418a597f63620b9020d729">More...</a><br /></td></tr>
<tr class="separator:a8e77e2c54f418a597f63620b9020d729"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a505b43e4b974a9e3a82898307362ebe4"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a505b43e4b974a9e3a82898307362ebe4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#a505b43e4b974a9e3a82898307362ebe4">_run</a> (const <a class="el" href="classWAL_1_1Callback.html">Callback</a>&lt; <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;, T &amp; &gt; &amp;callback, T state=T())</td></tr>
<tr class="memdesc:a505b43e4b974a9e3a82898307362ebe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the game loop. <a href="classWAL_1_1Wal.html#a505b43e4b974a9e3a82898307362ebe4">More...</a><br /></td></tr>
<tr class="separator:a505b43e4b974a9e3a82898307362ebe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aacca786a5a42626d1648d890acc0dc46"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classWAL_1_1ISystem.html">ISystem</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#aacca786a5a42626d1648d890acc0dc46">_systems</a> = {}</td></tr>
<tr class="memdesc:aacca786a5a42626d1648d890acc0dc46"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of registered systems. <a href="classWAL_1_1Wal.html#aacca786a5a42626d1648d890acc0dc46">More...</a><br /></td></tr>
<tr class="separator:aacca786a5a42626d1648d890acc0dc46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc8802299052ca2a9158c4a284382fea"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classWAL_1_1Scene.html">Scene</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Wal.html#acc8802299052ca2a9158c4a284382fea">_scene</a></td></tr>
<tr class="memdesc:acc8802299052ca2a9158c4a284382fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene that contains entities. <a href="classWAL_1_1Wal.html#acc8802299052ca2a9158c4a284382fea">More...</a><br /></td></tr>
<tr class="separator:acc8802299052ca2a9158c4a284382fea"><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>The main <a class="el" href="namespaceWAL.html">WAL</a> class, it is used to setup and run the ECS. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adf404c6d2ff9bc7432a056af949355cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf404c6d2ff9bc7432a056af949355cd">&#9670;&nbsp;</a></span>Wal() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">WAL::Wal::Wal </td>
<td>(</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>A default constructor. </p>
</div>
</div>
<a id="a9a87d5cdd918258d0294e2ba0f244f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a87d5cdd918258d0294e2ba0f244f3a">&#9670;&nbsp;</a></span>Wal() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">WAL::Wal::Wal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="namespaceWAL.html">WAL</a> can't be copy constructed. </p>
</div>
</div>
<a id="a3ab87bee9d53b34a9156c832af10e377"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ab87bee9d53b34a9156c832af10e377">&#9670;&nbsp;</a></span>~Wal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">WAL::Wal::~Wal </td>
<td>(</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>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a505b43e4b974a9e3a82898307362ebe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a505b43e4b974a9e3a82898307362ebe4">&#9670;&nbsp;</a></span>_run()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void WAL::Wal::_run </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWAL_1_1Callback.html">Callback</a>&lt; <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;, T &amp; &gt; &amp;&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>state</em> = <code>T()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the game loop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>A callback called after each update of the game. It allow you to update the engine based on a specific game state. (you can also update the game state here) </td></tr>
<tr><td class="paramname">state</td><td>An initial game state. If not specified, it will be defaulted. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>A type used to track your game state. It must be default constructable. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0c111817ce73593786509e1c30e5461a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c111817ce73593786509e1c30e5461a">&#9670;&nbsp;</a></span>addSystem() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Wal.html">Wal</a>&amp; WAL::Wal::addSystem </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>system</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>Add a system by copy. </p>
<dl class="section return"><dt>Returns</dt><dd>The wal instance used to call this function is returned. This allow method chaining. </dd></dl>
</div>
</div>
<a id="aea455d51b82283da1885e67c2aeea861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea455d51b82283da1885e67c2aeea861">&#9670;&nbsp;</a></span>addSystem() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , class ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Wal.html">Wal</a>&amp; WAL::Wal::addSystem </td>
<td>(</td>
<td class="paramtype">Types &amp;&amp;...&#160;</td>
<td class="paramname"><em>params</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>Create a new system in place. </p>
<dl class="section return"><dt>Returns</dt><dd>The wal instance used to call this function is returned. This allow method chaining. </dd></dl>
</div>
</div>
<a id="ad4d0cfe9ad33241cb9eb4c9e5c8112fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4d0cfe9ad33241cb9eb4c9e5c8112fa">&#9670;&nbsp;</a></span>changeScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void WAL::Wal::changeScene </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classWAL_1_1Scene.html">Scene</a> &gt;&#160;</td>
<td class="paramname"><em>newScene</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>Change the current scene. </p>
</div>
</div>
<a id="afcee9d67a8530cc86d40b2de999f91bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcee9d67a8530cc86d40b2de999f91bf">&#9670;&nbsp;</a></span>getScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classWAL_1_1Scene.html">Scene</a>&gt; WAL::Wal::getScene </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current scene. </p>
</div>
</div>
<a id="a6ec9044ef7e8a200bd1e0334d1c192ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ec9044ef7e8a200bd1e0334d1c192ec">&#9670;&nbsp;</a></span>getSystem()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T&amp; WAL::Wal::getSystem </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>Get a system of a specific type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the type of the system. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae636444e8f9051232e17e1456c9c4a7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae636444e8f9051232e17e1456c9c4a7d">&#9670;&nbsp;</a></span>operator=()</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="classWAL_1_1Wal.html">Wal</a>&amp; WAL::Wal::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="namespaceWAL.html">WAL</a> can't be assigned. </p>
</div>
</div>
<a id="a8ba20195595548cefcd928e58e20dddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ba20195595548cefcd928e58e20dddc">&#9670;&nbsp;</a></span>removeSystem()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Wal.html">Wal</a>&amp; WAL::Wal::removeSystem </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>Remove a system using it's type. </p>
</div>
</div>
<a id="a353969c3c8f5d630ec3944bfa9d36c6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a353969c3c8f5d630ec3944bfa9d36c6d">&#9670;&nbsp;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void WAL::Wal::run </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWAL_1_1Callback.html">Callback</a>&lt; <a class="el" href="classWAL_1_1Wal.html">Wal</a> &amp;, T &amp; &gt; &amp;&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>state</em> = <code>T()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Start the game loop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>A callback called after each update of the game. It allow you to update the engine based on a specific game state. (you can also update the game state here) </td></tr>
<tr><td class="paramname">state</td><td>An initial game state. If not specified, it will be defaulted. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>A type used to track your game state. It must be default constructable. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acc8802299052ca2a9158c4a284382fea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc8802299052ca2a9158c4a284382fea">&#9670;&nbsp;</a></span>_scene</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classWAL_1_1Scene.html">Scene</a>&gt; WAL::Wal::_scene</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The scene that contains entities. </p>
</div>
</div>
<a id="aacca786a5a42626d1648d890acc0dc46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacca786a5a42626d1648d890acc0dc46">&#9670;&nbsp;</a></span>_systems</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::unique_ptr&lt;<a class="el" href="classWAL_1_1ISystem.html">ISystem</a>&gt; &gt; WAL::Wal::_systems = {}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of registered systems. </p>
</div>
</div>
<a id="a45a63cfffeb01e0bc978be48b8054478"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a63cfffeb01e0bc978be48b8054478">&#9670;&nbsp;</a></span>shouldClose</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool WAL::Wal::shouldClose = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the engine should close after the end of the current tick. </p>
</div>
</div>
<a id="a8e77e2c54f418a597f63620b9020d729"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e77e2c54f418a597f63620b9020d729">&#9670;&nbsp;</a></span>timestep</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::chrono::nanoseconds WAL::Wal::timestep = std::chrono::milliseconds(32)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The time between each fixed update. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lib/wal/sources/<a class="el" href="Wal_8hpp_source.html">Wal.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.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink