elB4RTO/LogDoctor
elB4RTO/LogDoctor
2
2
Fork 0
Code Issues 6 Pull requests Projects 1 Releases 8 Wiki Activity
LogDoctor/docs/html/classSnakeGame.html

252 lines
15 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" 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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LogDoctor: SnakeGame 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="dox_logo.png"/></td>
<td id="projectalign">
<div id="projectname">LogDoctor<span id="projectnumber">&#160;2.04</span>
</div>
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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" 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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-slots">Private Slots</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classSnakeGame-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SnakeGame Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classSnake.html">Snake</a>.
<a href="classSnakeGame.html#details">More...</a></p>
<p><code>#include &lt;game.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SnakeGame:</div>
<div class="dyncontent">
<div class="center">
<img src="classSnakeGame.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a146a1430f1f32269ad0ad4df759e6a2e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2e">GameMode</a> { <a class="el" href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2ea7fbcdf670873949c8c960b892a303e59">Classic</a>
, <a class="el" href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2ea3bc7db4877c4b58e8b8f5ed74ffc1abb">Hunt</a>
, <a class="el" href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2ea33f4c7667fa1a7bf17dee0b0cade1f7b">Battle</a>
}</td></tr>
<tr class="memdesc:a146a1430f1f32269ad0ad4df759e6a2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumerates the available game modes. <a href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2e">More...</a><br /></td></tr>
<tr class="separator:a146a1430f1f32269ad0ad4df759e6a2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-slots" name="pri-slots"></a>
Private Slots</h2></td></tr>
<tr class="memitem:aeaa13da59d09abc40e25fd769fb96963"><td class="memItemLeft" align="right" valign="top"><a id="aeaa13da59d09abc40e25fd769fb96963" name="aeaa13da59d09abc40e25fd769fb96963"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>processGameLogic</b> ()</td></tr>
<tr class="memdesc:aeaa13da59d09abc40e25fd769fb96963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes the logic of the game. <br /></td></tr>
<tr class="separator:aeaa13da59d09abc40e25fd769fb96963"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a407dd2bae84d0f6572b94bb37feb87bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSnakeGame.html#a407dd2bae84d0f6572b94bb37feb87bc">keyPressEvent</a> (QKeyEvent *event) override</td></tr>
<tr class="memdesc:a407dd2bae84d0f6572b94bb37feb87bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the valid key events in a queue. <br /></td></tr>
<tr class="separator:a407dd2bae84d0f6572b94bb37feb87bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b0c9d7567a8e352449ddc7b31e09851"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSnakeGame.html#a0b0c9d7567a8e352449ddc7b31e09851">processNextKeyEvent</a> ()</td></tr>
<tr class="memdesc:a0b0c9d7567a8e352449ddc7b31e09851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes the key events in the queue. <br /></td></tr>
<tr class="separator:a0b0c9d7567a8e352449ddc7b31e09851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a937f69388e5c1dbf9d5f65ef7bf3b0d5"><td class="memItemLeft" align="right" valign="top"><a id="a937f69388e5c1dbf9d5f65ef7bf3b0d5" name="a937f69388e5c1dbf9d5f65ef7bf3b0d5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>checkCollision</b> (<a class="el" href="classSnake.html">Snake</a> &amp;<a class="el" href="classSnakeGame.html#a7448c2b54b8bc6e7b3d1d4aee12fbad7">snake</a>, <a class="el" href="classSnake.html">Snake</a> &amp;adv_snake, const bool is_adv)</td></tr>
<tr class="memdesc:a937f69388e5c1dbf9d5f65ef7bf3b0d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a snake will collide with another entity. <br /></td></tr>
<tr class="separator:a937f69388e5c1dbf9d5f65ef7bf3b0d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a420f3980fab86475ea4788a2e971597b"><td class="memItemLeft" align="right" valign="top"><a id="a420f3980fab86475ea4788a2e971597b" name="a420f3980fab86475ea4788a2e971597b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>updateGameScore</b> ()</td></tr>
<tr class="memdesc:a420f3980fab86475ea4788a2e971597b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases/Decreases the player's score by one. <br /></td></tr>
<tr class="separator:a420f3980fab86475ea4788a2e971597b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a8be52d5a2a611f246af8631243d88663"><td class="memItemLeft" align="right" valign="top"><a id="a8be52d5a2a611f246af8631243d88663" name="a8be52d5a2a611f246af8631243d88663"></a>
std::queue&lt; unsigned short &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>key_events</b></td></tr>
<tr class="memdesc:a8be52d5a2a611f246af8631243d88663"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the key events. <br /></td></tr>
<tr class="separator:a8be52d5a2a611f246af8631243d88663"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab359f92ba6a02621b131f3cdacd1260b"><td class="memItemLeft" align="right" valign="top"><a id="ab359f92ba6a02621b131f3cdacd1260b" name="ab359f92ba6a02621b131f3cdacd1260b"></a>
const size_t&#160;</td><td class="memItemRight" valign="bottom"><b>MAX_SNAKE_LENGTH</b> { 64 }</td></tr>
<tr class="memdesc:ab359f92ba6a02621b131f3cdacd1260b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum length of the snake. <br /></td></tr>
<tr class="separator:ab359f92ba6a02621b131f3cdacd1260b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7448c2b54b8bc6e7b3d1d4aee12fbad7"><td class="memItemLeft" align="right" valign="top"><a id="a7448c2b54b8bc6e7b3d1d4aee12fbad7" name="a7448c2b54b8bc6e7b3d1d4aee12fbad7"></a>
<a class="el" href="classSnake.html">Snake</a>&#160;</td><td class="memItemRight" valign="bottom"><b>snake</b></td></tr>
<tr class="memdesc:a7448c2b54b8bc6e7b3d1d4aee12fbad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The snake. <br /></td></tr>
<tr class="separator:a7448c2b54b8bc6e7b3d1d4aee12fbad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24bb09f513593f8c816b41134f8684c3"><td class="memItemLeft" align="right" valign="top"><a id="a24bb09f513593f8c816b41134f8684c3" name="a24bb09f513593f8c816b41134f8684c3"></a>
<a class="el" href="classFood.html">Food</a>&#160;</td><td class="memItemRight" valign="bottom"><b>food</b></td></tr>
<tr class="memdesc:a24bb09f513593f8c816b41134f8684c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of the egg/rat which will be eat by the snake. <br /></td></tr>
<tr class="separator:a24bb09f513593f8c816b41134f8684c3"><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="el" href="classSnake.html">Snake</a>. </p>
<p>A reproduction of the timeless classic game </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a146a1430f1f32269ad0ad4df759e6a2e" name="a146a1430f1f32269ad0ad4df759e6a2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a146a1430f1f32269ad0ad4df759e6a2e">&#9670;&#160;</a></span>GameMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classSnakeGame.html#a146a1430f1f32269ad0ad4df759e6a2e">SnakeGame::GameMode</a></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>Enumerates the available game modes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a146a1430f1f32269ad0ad4df759e6a2ea7fbcdf670873949c8c960b892a303e59" name="a146a1430f1f32269ad0ad4df759e6a2ea7fbcdf670873949c8c960b892a303e59"></a>Classic&#160;</td><td class="fielddoc"><p>Classic snake game. </p>
</td></tr>
<tr><td class="fieldname"><a id="a146a1430f1f32269ad0ad4df759e6a2ea3bc7db4877c4b58e8b8f5ed74ffc1abb" name="a146a1430f1f32269ad0ad4df759e6a2ea3bc7db4877c4b58e8b8f5ed74ffc1abb"></a>Hunt&#160;</td><td class="fielddoc"><p>Game variant in which the food moves too. </p>
</td></tr>
<tr><td class="fieldname"><a id="a146a1430f1f32269ad0ad4df759e6a2ea33f4c7667fa1a7bf17dee0b0cade1f7b" name="a146a1430f1f32269ad0ad4df759e6a2ea33f4c7667fa1a7bf17dee0b0cade1f7b"></a>Battle&#160;</td><td class="fielddoc"><p>Game variant in which you play against another snake. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a407dd2bae84d0f6572b94bb37feb87bc" name="a407dd2bae84d0f6572b94bb37feb87bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a407dd2bae84d0f6572b94bb37feb87bc">&#9670;&#160;</a></span>keyPressEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SnakeGame::keyPressEvent </td>
<td>(</td>
<td class="paramtype">QKeyEvent *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores the valid key events in a queue. </p>
<p>Valid keys are UP/DOWN/LEFT/RIGHT arrows and W/S/A/D letters </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classSnakeGame.html#a8be52d5a2a611f246af8631243d88663" title="Stores the key events.">key_events</a>, <a class="el" href="classSnakeGame.html#a0b0c9d7567a8e352449ddc7b31e09851" title="Processes the key events in the queue.">processNextKeyEvent()</a> </dd></dl>
</div>
</div>
<a id="a0b0c9d7567a8e352449ddc7b31e09851" name="a0b0c9d7567a8e352449ddc7b31e09851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b0c9d7567a8e352449ddc7b31e09851">&#9670;&#160;</a></span>processNextKeyEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SnakeGame::processNextKeyEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Processes the key events in the queue. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSnakeGame.html#a8be52d5a2a611f246af8631243d88663" title="Stores the key events.">key_events</a>, <a class="el" href="classSnakeGame.html#a407dd2bae84d0f6572b94bb37feb87bc" title="Stores the valid key events in a queue.">keyPressEvent()</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>logdoctor/games/snake/game.h</li>
<li>logdoctor/games/snake/game.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink