docs/classMap.html at main · HatchGameEngine/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!-- HTML header for doxygen 1.15.0-->
<!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.16.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hatch Game Engine Documentation: Map Class Reference</title>
<link rel="icon" href="favicon.ico" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="text/javascript">
  $(function() { init_search(); });
</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.svg" width="55" height="55"/></td>
  <td id="projectalign">
   <div id="projectname">Hatch Game Engine Documentation<span id="projectnumber">&#160;v1.4.0</span>
   </div>
   <div id="projectbrief">The documentation for the Hatch Game Engine</div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)"
               onblur="searchBox.OnSearchFieldFocus(false)"
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
</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">
$(function(){initNavTree('classMap.html','','classMap-members'); });
</script>
<div id="container">
<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">
<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 class="header">
  <div class="headertitle"><div class="title">Map Class Reference<div class="ingroups"><a class="el" href="group__hsl.html">HSL</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>An associative array, also known as a dictionary, or a map.
 <a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8c157e3445aca9410471927b6643310a" id="r_a8c157e3445aca9410471927b6643310a"><td class="memItemLeft">integer&#160;</td><td class="memItemRight"><a class="el" href="#a8c157e3445aca9410471927b6643310a">Length</a> ()</td></tr>
<tr class="memdesc:a8c157e3445aca9410471927b6643310a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of items in the map.  <br /></td></tr>
<tr class="memitem:a0ef6a2398e27efe8b46810f27f236e4d" id="r_a0ef6a2398e27efe8b46810f27f236e4d"><td class="memItemLeft">array&#160;</td><td class="memItemRight"><a class="el" href="#a0ef6a2398e27efe8b46810f27f236e4d">GetKeys</a> ()</td></tr>
<tr class="memdesc:a0ef6a2398e27efe8b46810f27f236e4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a list of all keys in the map.  <br /></td></tr>
<tr class="memitem:a963b49a855c7e63ef543bfe2c97b10eb" id="r_a963b49a855c7e63ef543bfe2c97b10eb"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a963b49a855c7e63ef543bfe2c97b10eb">Remove</a> (string key)</td></tr>
<tr class="memdesc:a963b49a855c7e63ef543bfe2c97b10eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a key from the map.  <br /></td></tr>
<tr class="memitem:af020476bbce3b6eb3e74621d8503a957" id="r_af020476bbce3b6eb3e74621d8503a957"><td class="memItemLeft"><a id="af020476bbce3b6eb3e74621d8503a957" name="af020476bbce3b6eb3e74621d8503a957"></a>
&#160;</td><td class="memItemRight"><b>Map</b> ()</td></tr>
<tr class="memdesc:af020476bbce3b6eb3e74621d8503a957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a map. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An associative array, also known as a dictionary, or a map. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a0ef6a2398e27efe8b46810f27f236e4d" name="a0ef6a2398e27efe8b46810f27f236e4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ef6a2398e27efe8b46810f27f236e4d">&#9670;&#160;</a></span>GetKeys()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">array Map.GetKeys </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets a list of all keys in the map. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an array of strings. </dd></dl>

</div>
</div>
<a id="a8c157e3445aca9410471927b6643310a" name="a8c157e3445aca9410471927b6643310a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c157e3445aca9410471927b6643310a">&#9670;&#160;</a></span>Length()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">integer Map.Length </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the number of items in the map. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value. </dd></dl>

</div>
</div>
<a id="a963b49a855c7e63ef543bfe2c97b10eb" name="a963b49a855c7e63ef543bfe2c97b10eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a963b49a855c7e63ef543bfe2c97b10eb">&#9670;&#160;</a></span>Remove()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Map.Remove </td>
          <td>(</td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>key</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Removes a key from the map. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The key to remove. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="classMap.html">Map</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.16.0 </li>
  </ul>
</div>
</body>
</html>