LP_DevOps/Tetris
Archived
1
0
Fork 0
Code Activity
This repository has been archived on 2024-02-17. You can view files and clone it, but cannot push or open issues or pull requests.
Tetris/doc/html/class_tetrominoe_parser.html
flifloo e39dc47b26 Add documentation
2022-06-08 09:14:30 +02:00

216 lines
9.4 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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Tetris: TetrominoeParser 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="projectalign">
<div id="projectname">Tetris
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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('class_tetrominoe_parser.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-static-methods">Static Public Member Functions</a> &#124;
<a href="class_tetrominoe_parser-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">TetrominoeParser Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5103848368ef223d832d5b6f0917975c"><td class="memItemLeft" align="right" valign="top">static bool[,]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tetrominoe_parser.html#a5103848368ef223d832d5b6f0917975c">GetShape</a> (String name)</td></tr>
<tr class="memdesc:a5103848368ef223d832d5b6f0917975c"><td class="mdescLeft">&#160;</td><td class="mdescRight">It takes a name, and returns a tetrominoe shape <a href="class_tetrominoe_parser.html#a5103848368ef223d832d5b6f0917975c">More...</a><br /></td></tr>
<tr class="separator:a5103848368ef223d832d5b6f0917975c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc77ba92d23ca625f6d1c9786c45c8ed"><td class="memItemLeft" align="right" valign="top">static Color&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tetrominoe_parser.html#adc77ba92d23ca625f6d1c9786c45c8ed">GetColor</a> (String name)</td></tr>
<tr class="memdesc:adc77ba92d23ca625f6d1c9786c45c8ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">It takes a name, checks if it's in the dictionary, and if it is, it returns the color <a href="class_tetrominoe_parser.html#adc77ba92d23ca625f6d1c9786c45c8ed">More...</a><br /></td></tr>
<tr class="separator:adc77ba92d23ca625f6d1c9786c45c8ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5360fdd343863f5684d3f7fedd3be064"><td class="memItemLeft" align="right" valign="top">static List&lt; String &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tetrominoe_parser.html#a5360fdd343863f5684d3f7fedd3be064">List</a> ()</td></tr>
<tr class="memdesc:a5360fdd343863f5684d3f7fedd3be064"><td class="mdescLeft">&#160;</td><td class="mdescRight">It returns a list of all the properties in the content object <a href="class_tetrominoe_parser.html#a5360fdd343863f5684d3f7fedd3be064">More...</a><br /></td></tr>
<tr class="separator:a5360fdd343863f5684d3f7fedd3be064"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adc77ba92d23ca625f6d1c9786c45c8ed" name="adc77ba92d23ca625f6d1c9786c45c8ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc77ba92d23ca625f6d1c9786c45c8ed">&#9670;&nbsp;</a></span>GetColor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Color TetrominoeParser.GetColor </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>It takes a name, checks if it's in the dictionary, and if it is, it returns the color </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">String</td><td>The name of the color you want to get.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A color object </dd></dl>
</div>
</div>
<a id="a5103848368ef223d832d5b6f0917975c" name="a5103848368ef223d832d5b6f0917975c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5103848368ef223d832d5b6f0917975c">&#9670;&nbsp;</a></span>GetShape()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool[,] TetrominoeParser.GetShape </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>It takes a name, and returns a tetrominoe shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">String</td><td>name - The name of the shape to get.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The shape of the tetrominoe as an 2D array of booleans. </dd></dl>
</div>
</div>
<a id="a5360fdd343863f5684d3f7fedd3be064" name="a5360fdd343863f5684d3f7fedd3be064"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5360fdd343863f5684d3f7fedd3be064">&#9670;&nbsp;</a></span>List()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static List&lt; String &gt; TetrominoeParser.List </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>It returns a list of all the properties in the content object </p>
<dl class="section return"><dt>Returns</dt><dd>A list of all the property names in the content object. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Tetris/Models/TetrominoeParser.cs</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="class_tetrominoe_parser.html">TetrominoeParser</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.4 </li>
</ul>
</div>
</body>
</html>
View git blame Copy permalink