DjalimSimaila/SuperSpaceInvaderTurboApocalypseVsGOD
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
369dc4ecbc
SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/html/dd/d1f/class_game.html
SIMAILA Djalim 1b4d9ac4d7 Doc stuff again
2022-01-10 18:25:13 +01:00

312 lines
18 KiB
HTML
Raw 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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SUPER Space invader : Turbo edition DX - VS GOD: Game 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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../LOGO.png"/></td>
<td id="projectalign">
<div id="projectname">SUPER Space invader : Turbo edition DX - VS GOD<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">A simple space invader ripoff</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search",'Search','.html');
/* @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');
$(document).ready(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 */
$(document).ready(function(){initNavTree('dd/d1f/class_game.html','../../'); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d4/d36/class_game-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Game Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Main game class.
<a href="../../dd/d1f/class_game.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d2/dd5/game_8h_source.html">game.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:ad59df6562a58a614fda24622d3715b65"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1f/class_game.html#ad59df6562a58a614fda24622d3715b65">Game</a> ()</td></tr>
<tr class="memdesc:ad59df6562a58a614fda24622d3715b65"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor for the game class <a href="../../dd/d1f/class_game.html#ad59df6562a58a614fda24622d3715b65">More...</a><br /></td></tr>
<tr class="separator:ad59df6562a58a614fda24622d3715b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a185d2ce9845c75b62064dc6d60f79eab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1f/class_game.html#a185d2ce9845c75b62064dc6d60f79eab">managedGames</a> ()</td></tr>
<tr class="memdesc:a185d2ce9845c75b62064dc6d60f79eab"><td class="mdescLeft">&#160;</td><td class="mdescRight">manages and changes the states of the game <a href="../../dd/d1f/class_game.html#a185d2ce9845c75b62064dc6d60f79eab">More...</a><br /></td></tr>
<tr class="separator:a185d2ce9845c75b62064dc6d60f79eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74570e2b1a4930b1ab1c957b5e60320e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d5/d60/utils_8h.html#acd2eabcda2cfc7902077f1f9a9e318de">WinValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1f/class_game.html#a74570e2b1a4930b1ab1c957b5e60320e">enterGameLoop</a> ()</td></tr>
<tr class="memdesc:a74570e2b1a4930b1ab1c957b5e60320e"><td class="mdescLeft">&#160;</td><td class="mdescRight">enter the main gameplay game loop <a href="../../dd/d1f/class_game.html#a74570e2b1a4930b1ab1c957b5e60320e">More...</a><br /></td></tr>
<tr class="separator:a74570e2b1a4930b1ab1c957b5e60320e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6c18f49964d49c3c5c826ef678f0792"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1f/class_game.html#ac6c18f49964d49c3c5c826ef678f0792">reloadConfig</a> ()</td></tr>
<tr class="memdesc:ac6c18f49964d49c3c5c826ef678f0792"><td class="mdescLeft">&#160;</td><td class="mdescRight">reload the configuration file for a new game <a href="../../dd/d1f/class_game.html#ac6c18f49964d49c3c5c826ef678f0792">More...</a><br /></td></tr>
<tr class="separator:ac6c18f49964d49c3c5c826ef678f0792"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef8202b79983c3b0f8d6db6c01d17fa6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1f/class_game.html#aef8202b79983c3b0f8d6db6c01d17fa6">arePlayersDead</a> ()</td></tr>
<tr class="memdesc:aef8202b79983c3b0f8d6db6c01d17fa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">tells if all players are dead <a href="../../dd/d1f/class_game.html#aef8202b79983c3b0f8d6db6c01d17fa6">More...</a><br /></td></tr>
<tr class="separator:aef8202b79983c3b0f8d6db6c01d17fa6"><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 >Main game class. </p>
<p class="definition">Definition at line <a class="el" href="../../d2/dd5/game_8h_source.html#l00034">34</a> of file <a class="el" href="../../d2/dd5/game_8h_source.html">game.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad59df6562a58a614fda24622d3715b65" name="ad59df6562a58a614fda24622d3715b65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad59df6562a58a614fda24622d3715b65">&#9670;&nbsp;</a></span>Game()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Game::Game </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor for the game class </p>
<p class="definition">Definition at line <a class="el" href="../../de/db0/game_basics_8cpp_source.html#l00021">21</a> of file <a class="el" href="../../de/db0/game_basics_8cpp_source.html">gameBasics.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aef8202b79983c3b0f8d6db6c01d17fa6" name="aef8202b79983c3b0f8d6db6c01d17fa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef8202b79983c3b0f8d6db6c01d17fa6">&#9670;&nbsp;</a></span>arePlayersDead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Game::arePlayersDead </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>tells if all players are dead </p>
<dl class="section return"><dt>Returns</dt><dd>true if all player are dead, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/db0/game_basics_8cpp_source.html#l00176">176</a> of file <a class="el" href="../../de/db0/game_basics_8cpp_source.html">gameBasics.cpp</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_aef8202b79983c3b0f8d6db6c01d17fa6_icgraph.png" border="0" usemap="#add/d1f/class_game_aef8202b79983c3b0f8d6db6c01d17fa6_icgraph" alt=""/></div>
<map name="add/d1f/class_game_aef8202b79983c3b0f8d6db6c01d17fa6_icgraph" id="add/d1f/class_game_aef8202b79983c3b0f8d6db6c01d17fa6_icgraph">
<area shape="rect" title="tells if all players are dead" alt="" coords="515,5,669,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#a74570e2b1a4930b1ab1c957b5e60320e" title="enter the main gameplay game loop" alt="" coords="311,5,467,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#a185d2ce9845c75b62064dc6d60f79eab" title="manages and changes the states of the game" alt="" coords="104,5,263,32"/>
<area shape="rect" href="../../df/d0a/main_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4" title=" " alt="" coords="5,5,56,32"/>
</map>
</div>
</div>
</div>
<a id="a74570e2b1a4930b1ab1c957b5e60320e" name="a74570e2b1a4930b1ab1c957b5e60320e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74570e2b1a4930b1ab1c957b5e60320e">&#9670;&nbsp;</a></span>enterGameLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d5/d60/utils_8h.html#acd2eabcda2cfc7902077f1f9a9e318de">WinValue</a> Game::enterGameLoop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>enter the main gameplay game loop </p>
<dl class="section return"><dt>Returns</dt><dd>the value of the winners can be the players, the invaders or god </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/db0/game_basics_8cpp_source.html#l00116">116</a> of file <a class="el" href="../../de/db0/game_basics_8cpp_source.html">gameBasics.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_cgraph.png" border="0" usemap="#add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_cgraph" alt=""/></div>
<map name="add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_cgraph" id="add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_cgraph">
<area shape="rect" title="enter the main gameplay game loop" alt="" coords="5,5,161,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#aef8202b79983c3b0f8d6db6c01d17fa6" title="tells if all players are dead" alt="" coords="209,5,364,32"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_icgraph.png" border="0" usemap="#add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_icgraph" alt=""/></div>
<map name="add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_icgraph" id="add/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_icgraph">
<area shape="rect" title="enter the main gameplay game loop" alt="" coords="311,5,467,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#a185d2ce9845c75b62064dc6d60f79eab" title="manages and changes the states of the game" alt="" coords="104,5,263,32"/>
<area shape="rect" href="../../df/d0a/main_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4" title=" " alt="" coords="5,5,56,32"/>
</map>
</div>
</div>
</div>
<a id="a185d2ce9845c75b62064dc6d60f79eab" name="a185d2ce9845c75b62064dc6d60f79eab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a185d2ce9845c75b62064dc6d60f79eab">&#9670;&nbsp;</a></span>managedGames()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Game::managedGames </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>manages and changes the states of the game </p>
<p class="definition">Definition at line <a class="el" href="../../de/db0/game_basics_8cpp_source.html#l00064">64</a> of file <a class="el" href="../../de/db0/game_basics_8cpp_source.html">gameBasics.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_cgraph.png" border="0" usemap="#add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_cgraph" alt=""/></div>
<map name="add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_cgraph" id="add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_cgraph">
<area shape="rect" title="manages and changes the states of the game" alt="" coords="5,5,164,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#a74570e2b1a4930b1ab1c957b5e60320e" title="enter the main gameplay game loop" alt="" coords="212,5,368,32"/>
<area shape="rect" href="../../dd/d1f/class_game.html#aef8202b79983c3b0f8d6db6c01d17fa6" title="tells if all players are dead" alt="" coords="416,5,571,32"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_icgraph.png" border="0" usemap="#add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_icgraph" alt=""/></div>
<map name="add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_icgraph" id="add/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_icgraph">
<area shape="rect" title="manages and changes the states of the game" alt="" coords="104,5,263,32"/>
<area shape="rect" href="../../df/d0a/main_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4" title=" " alt="" coords="5,5,56,32"/>
</map>
</div>
</div>
</div>
<a id="ac6c18f49964d49c3c5c826ef678f0792" name="ac6c18f49964d49c3c5c826ef678f0792"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6c18f49964d49c3c5c826ef678f0792">&#9670;&nbsp;</a></span>reloadConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Game::reloadConfig </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>reload the configuration file for a new game </p>
<dl class="section return"><dt>Returns</dt><dd>false if an error occured, true elsewise </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/d65/config_management_8cpp_source.html#l00299">299</a> of file <a class="el" href="../../d0/d65/config_management_8cpp_source.html">configManagement.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/d1f/class_game_ac6c18f49964d49c3c5c826ef678f0792_cgraph.png" border="0" usemap="#add/d1f/class_game_ac6c18f49964d49c3c5c826ef678f0792_cgraph" alt=""/></div>
<map name="add/d1f/class_game_ac6c18f49964d49c3c5c826ef678f0792_cgraph" id="add/d1f/class_game_ac6c18f49964d49c3c5c826ef678f0792_cgraph">
<area shape="rect" title="reload the configuration file for a new game" alt="" coords="5,71,140,98"/>
<area shape="rect" href="../../df/d3c/class_config_builder.html#aab791290aa2d314788fcd9f2c44bf79e" title=" " alt="" coords="188,5,367,47"/>
<area shape="rect" href="../../df/d3c/class_config_builder.html#a408e15906e88336cbc53f19afec65cd6" title=" " alt="" coords="199,71,356,98"/>
<area shape="rect" href="../../df/d3c/class_config_builder.html#acd69e5a0777a3c9339aa96e8ce2e07a9" title=" " alt="" coords="195,122,360,149"/>
<area shape="rect" href="../../d0/d65/config_management_8cpp.html#a3f46c4d5619bf4116121148193c0e34c" title=" " alt="" coords="415,46,513,73"/>
<area shape="rect" href="../../d0/d65/config_management_8cpp.html#a1c7782a08b7ba0d847c257bf3d42bca7" title=" " alt="" coords="561,71,649,98"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>headers/<a class="el" href="../../d2/dd5/game_8h_source.html">game.h</a></li>
<li>src/<a class="el" href="../../d0/d65/config_management_8cpp_source.html">configManagement.cpp</a></li>
<li>src/game/<a class="el" href="../../db/d86/display_8cpp_source.html">display.cpp</a></li>
<li>src/game/<a class="el" href="../../de/db0/game_basics_8cpp_source.html">gameBasics.cpp</a></li>
<li>src/game/<a class="el" href="../../d1/de4/game_managers_8cpp_source.html">gameManagers.cpp</a></li>
<li>src/game/<a class="el" href="../../d9/d15/god_manager_8cpp_source.html">godManager.cpp</a></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="../../dd/d1f/class_game.html">Game</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.9.3 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink