docs/classDirectory.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<!-- 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: Directory 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('classDirectory.html','','classDirectory-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">Directory Class Reference<div class="ingroups"><a class="el" href="group__hsl.html">HSL</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Filesystem directory manipulation.
 <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:a98b55c6785abb240e0a595ff71cc7d1a" id="r_a98b55c6785abb240e0a595ff71cc7d1a"><td class="memItemLeft">boolean&#160;</td><td class="memItemRight"><a class="el" href="#a98b55c6785abb240e0a595ff71cc7d1a">Create</a> (string path)</td></tr>
<tr class="memdesc:a98b55c6785abb240e0a595ff71cc7d1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a folder at the path.  <br /></td></tr>
<tr class="memitem:aec0bb6df8e7a347795a690f76129bb9a" id="r_aec0bb6df8e7a347795a690f76129bb9a"><td class="memItemLeft">boolean&#160;</td><td class="memItemRight"><a class="el" href="#aec0bb6df8e7a347795a690f76129bb9a">Exists</a> (string path)</td></tr>
<tr class="memdesc:aec0bb6df8e7a347795a690f76129bb9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the folder at the path exists.  <br /></td></tr>
<tr class="memitem:a2c36c93b8221ddcf80c455e22c888f2d" id="r_a2c36c93b8221ddcf80c455e22c888f2d"><td class="memItemLeft">array&#160;</td><td class="memItemRight"><a class="el" href="#a2c36c93b8221ddcf80c455e22c888f2d">GetFiles</a> (string directory, string pattern, boolean allDirs)</td></tr>
<tr class="memdesc:a2c36c93b8221ddcf80c455e22c888f2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the paths of all the files in the directory.  <br /></td></tr>
<tr class="memitem:ab417dca256865899bb3e1075862cc4bf" id="r_ab417dca256865899bb3e1075862cc4bf"><td class="memItemLeft">array&#160;</td><td class="memItemRight"><a class="el" href="#ab417dca256865899bb3e1075862cc4bf">GetDirectories</a> (string directory, string pattern, boolean allDirs)</td></tr>
<tr class="memdesc:ab417dca256865899bb3e1075862cc4bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the paths of all the folders in the directory.  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Filesystem directory manipulation. </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="a98b55c6785abb240e0a595ff71cc7d1a" name="a98b55c6785abb240e0a595ff71cc7d1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98b55c6785abb240e0a595ff71cc7d1a">&#9670;&#160;</a></span>Create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean Directory.Create </td>
          <td>(</td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a folder at the path. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>The path of the folder to create. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns whether folder creation was successful. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean Directory.Exists </td>
          <td>(</td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Determines if the folder at the path exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>The path of the folder to check for existence. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns whether the folder exists. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">array Directory.GetDirectories </td>
          <td>(</td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>directory</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>pattern</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">boolean</td>          <td class="paramname"><span class="paramname"><em>allDirs</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the paths of all the folders in the directory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">directory</td><td>The path of the folder to find folders in. </td></tr>
    <tr><td class="paramname">pattern</td><td>The search pattern for the folders. (ex: "*" for any folder, "image*" any folder that starts with "image") </td></tr>
    <tr><td class="paramname">allDirs</td><td>Whether to search into all folders in the directory. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an array containing the filepaths as strings. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">array Directory.GetFiles </td>
          <td>(</td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>directory</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string</td>          <td class="paramname"><span class="paramname"><em>pattern</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">boolean</td>          <td class="paramname"><span class="paramname"><em>allDirs</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the paths of all the files in the directory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">directory</td><td>The path of the folder to find files in. </td></tr>
    <tr><td class="paramname">pattern</td><td>The search pattern for the files. (ex: "*" for any file, "*.*" any file name with any file type, "*.png" any PNG file) </td></tr>
    <tr><td class="paramname">allDirs</td><td>Whether to search into all folders in the directory. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an array containing the filepaths as strings. </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="classDirectory.html">Directory</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>