Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
terminal_gui/docs/html/classWorld.html
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
218 lines (210 sloc)
9.77 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> | |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
| <title>Terminal Gui: World 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">Terminal Gui | |
| </div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <!-- end header part --> | |
| <!-- Generated by Doxygen 1.8.13 --> | |
| <script type="text/javascript"> | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | |
| </script> | |
| <script type="text/javascript" src="menudata.js"></script> | |
| <script type="text/javascript" src="menu.js"></script> | |
| <script type="text/javascript"> | |
| $(function() { | |
| initMenu('',true,false,'search.php','Search'); | |
| $(document).ready(function() { init_search(); }); | |
| }); | |
| </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><!-- top --> | |
| <div class="header"> | |
| <div class="summary"> | |
| <a href="#pub-methods">Public Member Functions</a> | | |
| <a href="#pub-attribs">Public Attributes</a> | | |
| <a href="#friends">Friends</a> | | |
| <a href="classWorld-members.html">List of all members</a> </div> | |
| <div class="headertitle"> | |
| <div class="title">World Class Reference</div> </div> | |
| </div><!--header--> | |
| <div class="contents"> | |
| <table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> | |
| Public Member Functions</h2></td></tr> | |
| <tr class="memitem:aecef883ed3a1b5e0bb5ed487d7bf170c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#aecef883ed3a1b5e0bb5ed487d7bf170c">World</a> (int _width, int _height)</td></tr> | |
| <tr class="separator:aecef883ed3a1b5e0bb5ed487d7bf170c"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:a43f13ba2ee14266c8e501ace20bcf73a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a43f13ba2ee14266c8e501ace20bcf73a">fill</a> (<a class="el" href="classTile.html">Tile</a> t)</td></tr> | |
| <tr class="separator:a43f13ba2ee14266c8e501ace20bcf73a"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ab31fd9ea02926eeb977edcd1674fda85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTile.html">Tile</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#ab31fd9ea02926eeb977edcd1674fda85">get</a> (int x, int y)</td></tr> | |
| <tr class="separator:ab31fd9ea02926eeb977edcd1674fda85"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:a4fade9613dc55cf575e0e813e94268f4"><td class="memItemLeft" align="right" valign="top"><a id="a4fade9613dc55cf575e0e813e94268f4"></a> | |
| void </td><td class="memItemRight" valign="bottom"><b>add</b> (<a class="el" href="classEntity.html">Entity</a> &entity)</td></tr> | |
| <tr class="separator:a4fade9613dc55cf575e0e813e94268f4"><td class="memSeparator" colspan="2"> </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:a46f82c970a92a26821fb675c3535cd75"><td class="memItemLeft" align="right" valign="top"><a id="a46f82c970a92a26821fb675c3535cd75"></a> | |
| const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a46f82c970a92a26821fb675c3535cd75">width</a></td></tr> | |
| <tr class="memdesc:a46f82c970a92a26821fb675c3535cd75"><td class="mdescLeft"> </td><td class="mdescRight">Map width. <br /></td></tr> | |
| <tr class="separator:a46f82c970a92a26821fb675c3535cd75"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:a4d497bd139e23841af319542f3ee22d7"><td class="memItemLeft" align="right" valign="top"><a id="a4d497bd139e23841af319542f3ee22d7"></a> | |
| const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorld.html#a4d497bd139e23841af319542f3ee22d7">height</a></td></tr> | |
| <tr class="memdesc:a4d497bd139e23841af319542f3ee22d7"><td class="mdescLeft"> </td><td class="mdescRight">Map height. <br /></td></tr> | |
| <tr class="separator:a4d497bd139e23841af319542f3ee22d7"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table><table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> | |
| Friends</h2></td></tr> | |
| <tr class="memitem:a018ff8a950133459fda57a235706a80b"><td class="memItemLeft" align="right" valign="top"><a id="a018ff8a950133459fda57a235706a80b"></a> | |
| class </td><td class="memItemRight" valign="bottom"><b>View</b></td></tr> | |
| <tr class="separator:a018ff8a950133459fda57a235706a80b"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table> | |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> | |
| <a id="aecef883ed3a1b5e0bb5ed487d7bf170c"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#aecef883ed3a1b5e0bb5ed487d7bf170c">◆ </a></span>World()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">World::World </td> | |
| <td>(</td> | |
| <td class="paramtype">int </td> | |
| <td class="paramname"><em>_width</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">int </td> | |
| <td class="paramname"><em>_height</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Initialise world map</p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramname">_width</td><td>width of map to create </td></tr> | |
| <tr><td class="paramname">_height</td><td>height of map to create </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <h2 class="groupheader">Member Function Documentation</h2> | |
| <a id="a43f13ba2ee14266c8e501ace20bcf73a"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#a43f13ba2ee14266c8e501ace20bcf73a">◆ </a></span>fill()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">void World::fill </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="classTile.html">Tile</a> </td> | |
| <td class="paramname"><em>t</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Fill world map with a tile</p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramname">t</td><td><a class="el" href="classTile.html">Tile</a> to use when filling the map </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ab31fd9ea02926eeb977edcd1674fda85"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ab31fd9ea02926eeb977edcd1674fda85">◆ </a></span>get()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname"><a class="el" href="classTile.html">Tile</a> & World::get </td> | |
| <td>(</td> | |
| <td class="paramtype">int </td> | |
| <td class="paramname"><em>x</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">int </td> | |
| <td class="paramname"><em>y</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Get map contents at given position</p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramname">x</td><td>X coordinate </td></tr> | |
| <tr><td class="paramname">y</td><td>Y coordinate </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="section return"><dt>Returns</dt><dd>Reference to <a class="el" href="classTile.html">Tile</a> at given co-ordinates </dd></dl> | |
| <dl class="exception"><dt>Exceptions</dt><dd> | |
| <table class="exception"> | |
| <tr><td class="paramname">std::out_of_range</td><td>if coordinates are not on map </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <hr/>The documentation for this class was generated from the following files:<ul> | |
| <li>include/<a class="el" href="world_8h_source.html">world.h</a></li> | |
| <li>src/world.cpp</li> | |
| </ul> | |
| </div><!-- contents --> | |
| <!-- start footer part --> | |
| <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.13 | |
| </small></address> | |
| </body> | |
| </html> |