Files
Bomberman/LobbyComponent_8hpp_source.html
2021-06-26 11:31:13 +00:00

136 lines
18 KiB
HTML

<!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: sources/Component/Lobby/LobbyComponent.hpp Source File</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="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_1625c0207da71ef5bcc742f7d87fc397.html">Component</a></li><li class="navelem"><a class="el" href="dir_b799cec58f0d6b5386b88836ab4bc115.html">Lobby</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LobbyComponent.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="LobbyComponent_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by Zoe Roux on 6/11/21.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Component_8hpp.html">Component/Component.hpp</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Entity_8hpp.html">Entity/Entity.hpp</a>&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Color_8hpp.html">Color.hpp</a>&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="ControllableComponent_8hpp.html">Component/Controllable/ControllableComponent.hpp</a>&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceBBM.html">BBM</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html"> 15</a></span>&#160; <span class="keyword">class </span><a class="code" href="classBBM_1_1LobbyComponent.html">LobbyComponent</a> : <span class="keyword">public</span> <a class="code" href="classWAL_1_1Component.html">WAL::Component</a></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#a17f0bce1b453a2823928126f86fe26f8"> 19</a></span>&#160; <a class="code" href="classBBM_1_1ControllableComponent.html#a050e4c8ed1f2ad177ee73b92ea7662e0">ControllableComponent::Layout</a> <a class="code" href="classBBM_1_1LobbyComponent.html#a17f0bce1b453a2823928126f86fe26f8">layout</a> = <a class="code" href="classBBM_1_1ControllableComponent.html#a050e4c8ed1f2ad177ee73b92ea7662e0a72e98a6e6a29ffb8f0bff508c9bbb2f5">ControllableComponent::NONE</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#abf13d11f5583ef5777d7e1d8096e6535"> 21</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classBBM_1_1LobbyComponent.html#abf13d11f5583ef5777d7e1d8096e6535">playerID</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#a4d10d26dd2de38c286b761604855d6b9"> 23</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classBBM_1_1LobbyComponent.html#a4d10d26dd2de38c286b761604855d6b9">color</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#a7b7b24a3373d0f5375c5f8be24d453ba"> 25</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBBM_1_1LobbyComponent.html#a7b7b24a3373d0f5375c5f8be24d453ba">ready</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#a1afb665c96905a6e440db3b8f5c10920"> 27</a></span>&#160; <a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;<a class="code" href="classBBM_1_1LobbyComponent.html#a1afb665c96905a6e440db3b8f5c10920">readyButton</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#a44cbeb4ff46fd5feabdf8587b7cd739e"> 29</a></span>&#160; <a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;<a class="code" href="classBBM_1_1LobbyComponent.html#a44cbeb4ff46fd5feabdf8587b7cd739e">coloredTile</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classBBM_1_1LobbyComponent.html#ae29a8fb4d64a70540d56f850cb2452e3"> 31</a></span>&#160; std::chrono::time_point&lt;std::chrono::steady_clock&gt; <a class="code" href="classBBM_1_1LobbyComponent.html#ae29a8fb4d64a70540d56f850cb2452e3">lastInput</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a> *<a class="code" href="classBBM_1_1LobbyComponent.html#a5f2bdd2ceadd856a92222390af7909dd">clone</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classBBM_1_1LobbyComponent.html#afa0a964565bc77c74c6ff117e80a085d">LobbyComponent</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, <span class="keywordtype">int</span> playerNumber, <a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;button, <a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;tile);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classBBM_1_1LobbyComponent.html#afa0a964565bc77c74c6ff117e80a085d">LobbyComponent</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1LobbyComponent.html">LobbyComponent</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classBBM_1_1LobbyComponent.html#a2f1984d195117bbc1a5b64f85c73049f">~LobbyComponent</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classBBM_1_1LobbyComponent.html">LobbyComponent</a> &amp;<a class="code" href="classBBM_1_1LobbyComponent.html#adeda82edd38b76befc9c94de363ab3a8">operator=</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1LobbyComponent.html">LobbyComponent</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; };</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a7b7b24a3373d0f5375c5f8be24d453ba"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a7b7b24a3373d0f5375c5f8be24d453ba">BBM::LobbyComponent::ready</a></div><div class="ttdeci">bool ready</div><div class="ttdoc">Is this player ready.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:25</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a5f2bdd2ceadd856a92222390af7909dd"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a5f2bdd2ceadd856a92222390af7909dd">BBM::LobbyComponent::clone</a></div><div class="ttdeci">Component * clone(WAL::Entity &amp;entity) const override</div><div class="ttdoc">Clone a component for another or the same entity.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.cpp:16</div></div>
<div class="ttc" id="aclassBBM_1_1ControllableComponent_html_a050e4c8ed1f2ad177ee73b92ea7662e0"><div class="ttname"><a href="classBBM_1_1ControllableComponent.html#a050e4c8ed1f2ad177ee73b92ea7662e0">BBM::ControllableComponent::Layout</a></div><div class="ttdeci">Layout</div><div class="ttdef"><b>Definition:</b> ControllableComponent.hpp:20</div></div>
<div class="ttc" id="aclassWAL_1_1Component_html"><div class="ttname"><a href="classWAL_1_1Component.html">WAL::Component</a></div><div class="ttdoc">Represent a single component of WAL.</div><div class="ttdef"><b>Definition:</b> Component.hpp:17</div></div>
<div class="ttc" id="anamespaceBBM_html"><div class="ttname"><a href="namespaceBBM.html">BBM</a></div><div class="ttdef"><b>Definition:</b> AnimationsComponent.cpp:9</div></div>
<div class="ttc" id="aEntity_8hpp_html"><div class="ttname"><a href="Entity_8hpp.html">Entity.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1Entity_html"><div class="ttname"><a href="classWAL_1_1Entity.html">WAL::Entity</a></div><div class="ttdoc">An entity of the WAL's ECS.</div><div class="ttdef"><b>Definition:</b> Entity.hpp:20</div></div>
<div class="ttc" id="aControllableComponent_8hpp_html"><div class="ttname"><a href="ControllableComponent_8hpp.html">ControllableComponent.hpp</a></div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_afa0a964565bc77c74c6ff117e80a085d"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#afa0a964565bc77c74c6ff117e80a085d">BBM::LobbyComponent::LobbyComponent</a></div><div class="ttdeci">LobbyComponent(WAL::Entity &amp;entity, int playerNumber, WAL::Entity &amp;button, WAL::Entity &amp;tile)</div><div class="ttdoc">Create a new lobby component.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.cpp:9</div></div>
<div class="ttc" id="aComponent_8hpp_html"><div class="ttname"><a href="Component_8hpp.html">Component.hpp</a></div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_adeda82edd38b76befc9c94de363ab3a8"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#adeda82edd38b76befc9c94de363ab3a8">BBM::LobbyComponent::operator=</a></div><div class="ttdeci">LobbyComponent &amp; operator=(const LobbyComponent &amp;)=delete</div><div class="ttdoc">A lobby component is not assignable.</div></div>
<div class="ttc" id="aclassWAL_1_1Component_html_ad27cb4b0bdc95b6245f6b5a8c56cc78a"><div class="ttname"><a href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">WAL::Component::Component</a></div><div class="ttdeci">Component(Entity &amp;entity)</div><div class="ttdoc">A component can't be instantiated, it should be derived.</div><div class="ttdef"><b>Definition:</b> Component.cpp:9</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a2f1984d195117bbc1a5b64f85c73049f"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a2f1984d195117bbc1a5b64f85c73049f">BBM::LobbyComponent::~LobbyComponent</a></div><div class="ttdeci">~LobbyComponent() override=default</div><div class="ttdoc">A default destructor.</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a17f0bce1b453a2823928126f86fe26f8"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a17f0bce1b453a2823928126f86fe26f8">BBM::LobbyComponent::layout</a></div><div class="ttdeci">ControllableComponent::Layout layout</div><div class="ttdoc">The layout used for this player.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:19</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a4d10d26dd2de38c286b761604855d6b9"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a4d10d26dd2de38c286b761604855d6b9">BBM::LobbyComponent::color</a></div><div class="ttdeci">int color</div><div class="ttdoc">The color of the player (as an index)</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:23</div></div>
<div class="ttc" id="aclassBBM_1_1ControllableComponent_html_a050e4c8ed1f2ad177ee73b92ea7662e0a72e98a6e6a29ffb8f0bff508c9bbb2f5"><div class="ttname"><a href="classBBM_1_1ControllableComponent.html#a050e4c8ed1f2ad177ee73b92ea7662e0a72e98a6e6a29ffb8f0bff508c9bbb2f5">BBM::ControllableComponent::NONE</a></div><div class="ttdeci">@ NONE</div><div class="ttdef"><b>Definition:</b> ControllableComponent.hpp:22</div></div>
<div class="ttc" id="aColor_8hpp_html"><div class="ttname"><a href="Color_8hpp.html">Color.hpp</a></div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_abf13d11f5583ef5777d7e1d8096e6535"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#abf13d11f5583ef5777d7e1d8096e6535">BBM::LobbyComponent::playerID</a></div><div class="ttdeci">int playerID</div><div class="ttdoc">The ID of the lobby player (from 0 to 3)</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:21</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a1afb665c96905a6e440db3b8f5c10920"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a1afb665c96905a6e440db3b8f5c10920">BBM::LobbyComponent::readyButton</a></div><div class="ttdeci">WAL::Entity &amp; readyButton</div><div class="ttdoc">The entity containing the ready display.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:27</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html">BBM::LobbyComponent</a></div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:15</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_ae29a8fb4d64a70540d56f850cb2452e3"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#ae29a8fb4d64a70540d56f850cb2452e3">BBM::LobbyComponent::lastInput</a></div><div class="ttdeci">std::chrono::time_point&lt; std::chrono::steady_clock &gt; lastInput</div><div class="ttdoc">The time of last input that this lobby player has made.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:31</div></div>
<div class="ttc" id="aclassBBM_1_1LobbyComponent_html_a44cbeb4ff46fd5feabdf8587b7cd739e"><div class="ttname"><a href="classBBM_1_1LobbyComponent.html#a44cbeb4ff46fd5feabdf8587b7cd739e">BBM::LobbyComponent::coloredTile</a></div><div class="ttdeci">WAL::Entity &amp; coloredTile</div><div class="ttdoc">The colored rectangle behind the player.</div><div class="ttdef"><b>Definition:</b> LobbyComponent.hpp:29</div></div>
<!-- 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>