diff options
Diffstat (limited to 'doc/html/classWorld.html')
| -rw-r--r-- | doc/html/classWorld.html | 115 |
1 files changed, 102 insertions, 13 deletions
diff --git a/doc/html/classWorld.html b/doc/html/classWorld.html index 6071450..54103c3 100644 --- a/doc/html/classWorld.html +++ b/doc/html/classWorld.html @@ -3,7 +3,7 @@ <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.10"/> +<meta name="generator" content="Doxygen 1.8.9.1"/> <title>gamedev: World Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> @@ -22,7 +22,7 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td id="projectalign" style="padding-left: 0.5em;"> + <td style="padding-left: 0.5em;"> <div id="projectname">gamedev </div> </td> @@ -31,7 +31,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.10 --> +<!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> @@ -213,11 +213,9 @@ std::vector< <a class="el" href="classObject.html">Object</a> * > </t </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> -<tr class="memitem:a0af69654347b29787877b77020fa0a5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0af69654347b29787877b77020fa0a5a"></a> -void </td><td class="memItemRight" valign="bottom"><b>singleDetect</b> (<a class="el" href="classEntity.html">Entity</a> *e)</td></tr> +<tr class="memitem:a0af69654347b29787877b77020fa0a5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a0af69654347b29787877b77020fa0a5a">singleDetect</a> (<a class="el" href="classEntity.html">Entity</a> *e)</td></tr> <tr class="separator:a0af69654347b29787877b77020fa0a5a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1c1e6ea7fd0d84660d2791a256aba382"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c1e6ea7fd0d84660d2791a256aba382"></a> -void </td><td class="memItemRight" valign="bottom"><b>deleteEntities</b> (void)</td></tr> +<tr class="memitem:a1c1e6ea7fd0d84660d2791a256aba382"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a1c1e6ea7fd0d84660d2791a256aba382">deleteEntities</a> (void)</td></tr> <tr class="separator:a1c1e6ea7fd0d84660d2791a256aba382"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> @@ -226,11 +224,9 @@ Protected Attributes</h2></td></tr> <tr class="separator:afd9945f6ede5eabc3ff9243ce2b31247"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a645767ccf316a9b4469db773ac111ae4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a645767ccf316a9b4469db773ac111ae4">x_start</a></td></tr> <tr class="separator:a645767ccf316a9b4469db773ac111ae4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a432e07fd7f7504aaa6ff29408afe0678"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a432e07fd7f7504aaa6ff29408afe0678"></a> -unsigned int </td><td class="memItemRight" valign="bottom"><b>lineCount</b></td></tr> +<tr class="memitem:a432e07fd7f7504aaa6ff29408afe0678"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a432e07fd7f7504aaa6ff29408afe0678">lineCount</a></td></tr> <tr class="separator:a432e07fd7f7504aaa6ff29408afe0678"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a4f8b12f8eda220060ec01c0e9a6b9325"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f8b12f8eda220060ec01c0e9a6b9325"></a> -<a class="el" href="structvec2.html">vec2</a> * </td><td class="memItemRight" valign="bottom"><b>star</b></td></tr> +<tr class="memitem:a4f8b12f8eda220060ec01c0e9a6b9325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvec2.html">vec2</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a4f8b12f8eda220060ec01c0e9a6b9325">star</a></td></tr> <tr class="separator:a4f8b12f8eda220060ec01c0e9a6b9325"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:accebca6a747c3db27916770507aee04c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accebca6a747c3db27916770507aee04c"></a> <a class="el" href="classTexturec.html">Texturec</a> * </td><td class="memItemRight" valign="bottom"><b>bgTex</b></td></tr> @@ -244,7 +240,58 @@ char * </td><td class="memItemRight" valign="bottom"><b>bgm</b></td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The world class. This class does everything a world should do. </p> -</div><h2 class="groupheader">Member Data Documentation</h2> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a1c1e6ea7fd0d84660d2791a256aba382"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void World::deleteEntities </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Empties all entity vectors. Each entity vector is iterated through, calling delete for each entry. Once all specific vectors are cleared, the general entity vector is emptied of the pointers to those other vectors. This function should only be called in <a class="el" href="classWorld.html">World</a>'s destructor, as there shouldn't be another reason to call this function. </p> + +</div> +</div> +<a class="anchor" id="a0af69654347b29787877b77020fa0a5a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void World::singleDetect </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classEntity.html">Entity</a> * </td> + <td class="paramname"><em>e</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Handle physics for a single entity. This function handles gravity and death for an entity. The public version of this, World::detect(), handles all entities in the world as well as the player. <a class="el" href="classWorld.html#a0af69654347b29787877b77020fa0a5a">World::singleDetect()</a> should never be used outside of World::detect(), which is why it is declared private. </p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="afd9945f6ede5eabc3ff9243ce2b31247"></a> <div class="memitem"> <div class="memproto"> @@ -266,6 +313,48 @@ char * </td><td class="memItemRight" valign="bottom"><b>bgm</b></td></tr> </div> </div> +<a class="anchor" id="a432e07fd7f7504aaa6ff29408afe0678"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">unsigned int World::lineCount</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Number of lines in the world. While this number is helpful for knowing the world's width, it is kept private for security reasons. To compensate for this, World::getTheWidth() is provided (see below). </p> + +</div> +</div> +<a class="anchor" id="a4f8b12f8eda220060ec01c0e9a6b9325"></a> +<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="structvec2.html">vec2</a>* World::star</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>An array of star coordinates. </p> + +</div> +</div> <a class="anchor" id="a645767ccf316a9b4469db773ac111ae4"></a> <div class="memitem"> <div class="memproto"> @@ -296,7 +385,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>bgm</b></td></tr> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.10 +</a> 1.8.9.1 </small></address> </body> </html> |