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

233 lines
15 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: BBM::GameState 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="namespaceBBM.html">BBM</a></li><li class="navelem"><a class="el" href="classBBM_1_1GameState.html">GameState</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classBBM_1_1GameState-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BBM::GameState Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class representing the current game state. This allow one to retain information between update calls.
<a href="classBBM_1_1GameState.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="GameState_8hpp_source.html">GameState.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for BBM::GameState:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1GameState__coll__graph.svg" width="144" height="132"><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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a64335f0af42a70823a830e51bbdecb28"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a> { <br />
&#160;&#160;<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a5f66b510d6f02fdda3619f1680e42fd0">MainMenuScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28af7ae93606114da6460fe08f015b7b469">GameScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a3b41e40fee40729830680210c41de19a">SettingsScene</a>,
<br />
&#160;&#160;<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ac2aa7b52305fc6f8caf072011516841d">PauseMenuScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a0b5df90907709f429c69de14d43a01dd">LobbyScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a4b7319d9537455ecd196dcc8f66a42ee">ResumeLobbyScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28aa35a071454dd66638e69981bd94b7b1c">TitleScreenScene</a>,
<br />
&#160;&#160;<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ad739846ff1d7422cdad4ea186c3a0720">CreditScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a6c5e9d1f03cdd583e56fafc3c9c7f002">HowToPlayScene</a>,
<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28a13dd26451a5eef9002b2b770030a3ac8">ScoreScene</a>
<br />
}</td></tr>
<tr class="memdesc:a64335f0af42a70823a830e51bbdecb28"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of scenes available. <a href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">More...</a><br /></td></tr>
<tr class="separator:a64335f0af42a70823a830e51bbdecb28"><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:a8eebd79febb715bd7ff70ccb7aa41878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1GameState.html#a8eebd79febb715bd7ff70ccb7aa41878">previousScene</a> = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td></tr>
<tr class="memdesc:a8eebd79febb715bd7ff70ccb7aa41878"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene before the actual one. Used for back buttons. <a href="classBBM_1_1GameState.html#a8eebd79febb715bd7ff70ccb7aa41878">More...</a><br /></td></tr>
<tr class="separator:a8eebd79febb715bd7ff70ccb7aa41878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7025911c13d343ff05be6b1f7e65ba8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1GameState.html#a7025911c13d343ff05be6b1f7e65ba8a">currentScene</a> = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td></tr>
<tr class="memdesc:a7025911c13d343ff05be6b1f7e65ba8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The currently loaded scene. <a href="classBBM_1_1GameState.html#a7025911c13d343ff05be6b1f7e65ba8a">More...</a><br /></td></tr>
<tr class="separator:a7025911c13d343ff05be6b1f7e65ba8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8769f856b80581ff13c325892035e809"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1GameState.html#a8769f856b80581ff13c325892035e809">nextScene</a> = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td></tr>
<tr class="memdesc:a8769f856b80581ff13c325892035e809"><td class="mdescLeft">&#160;</td><td class="mdescRight">The next scene to load (if smae as currentScene, nothing to do) <a href="classBBM_1_1GameState.html#a8769f856b80581ff13c325892035e809">More...</a><br /></td></tr>
<tr class="separator:a8769f856b80581ff13c325892035e809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56853be347229f66fa2b7d80cbf8a2b1"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a>, std::shared_ptr&lt; <a class="el" href="classWAL_1_1Scene.html">WAL::Scene</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1GameState.html#a56853be347229f66fa2b7d80cbf8a2b1">loadedScenes</a> = {}</td></tr>
<tr class="memdesc:a56853be347229f66fa2b7d80cbf8a2b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of loaded scenes. <a href="classBBM_1_1GameState.html#a56853be347229f66fa2b7d80cbf8a2b1">More...</a><br /></td></tr>
<tr class="separator:a56853be347229f66fa2b7d80cbf8a2b1"><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>A class representing the current game state. This allow one to retain information between update calls. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a64335f0af42a70823a830e51bbdecb28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64335f0af42a70823a830e51bbdecb28">&#9670;&nbsp;</a></span>SceneID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">BBM::GameState::SceneID</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of scenes available. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341"></a>SplashScreen&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a5f66b510d6f02fdda3619f1680e42fd0"></a>MainMenuScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28af7ae93606114da6460fe08f015b7b469"></a>GameScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a3b41e40fee40729830680210c41de19a"></a>SettingsScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28ac2aa7b52305fc6f8caf072011516841d"></a>PauseMenuScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a0b5df90907709f429c69de14d43a01dd"></a>LobbyScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a4b7319d9537455ecd196dcc8f66a42ee"></a>ResumeLobbyScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28aa35a071454dd66638e69981bd94b7b1c"></a>TitleScreenScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28ad739846ff1d7422cdad4ea186c3a0720"></a>CreditScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a6c5e9d1f03cdd583e56fafc3c9c7f002"></a>HowToPlayScene&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a64335f0af42a70823a830e51bbdecb28a13dd26451a5eef9002b2b770030a3ac8"></a>ScoreScene&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7025911c13d343ff05be6b1f7e65ba8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7025911c13d343ff05be6b1f7e65ba8a">&#9670;&nbsp;</a></span>currentScene</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a> BBM::GameState::currentScene = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The currently loaded scene. </p>
</div>
</div>
<a id="a56853be347229f66fa2b7d80cbf8a2b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56853be347229f66fa2b7d80cbf8a2b1">&#9670;&nbsp;</a></span>loadedScenes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;<a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a>, std::shared_ptr&lt;<a class="el" href="classWAL_1_1Scene.html">WAL::Scene</a>&gt; &gt; BBM::GameState::loadedScenes = {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of loaded scenes. </p>
</div>
</div>
<a id="a8769f856b80581ff13c325892035e809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8769f856b80581ff13c325892035e809">&#9670;&nbsp;</a></span>nextScene</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a> BBM::GameState::nextScene = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The next scene to load (if smae as currentScene, nothing to do) </p>
</div>
</div>
<a id="a8eebd79febb715bd7ff70ccb7aa41878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8eebd79febb715bd7ff70ccb7aa41878">&#9670;&nbsp;</a></span>previousScene</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28">SceneID</a> BBM::GameState::previousScene = <a class="el" href="classBBM_1_1GameState.html#a64335f0af42a70823a830e51bbdecb28ae84caa63e6386f111d98661ec2374341">SplashScreen</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The scene before the actual one. Used for back buttons. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sources/Models/<a class="el" href="GameState_8hpp_source.html">GameState.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