-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassu_lua_1_1_packages_1_1_script_package.html
More file actions
186 lines (180 loc) · 15 KB
/
Copy pathclassu_lua_1_1_packages_1_1_script_package.html
File metadata and controls
186 lines (180 loc) · 15 KB
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
<!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>uLua: uLua.Packages.ScriptPackage 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">uLua<span id="projectnumber"> v3.1.0</span>
</div>
<div id="projectbrief">A Lua Modding Framework for Unity.</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&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&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&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classu_lua_1_1_packages_1_1_script_package.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="#properties">Properties</a> |
<a href="classu_lua_1_1_packages_1_1_script_package-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uLua.Packages.ScriptPackage Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A class to describe Lua script packages.
<a href="classu_lua_1_1_packages_1_1_script_package.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0272f4a35ca15a5a05817d7c1c4fafc2"><td class="memItemLeft" align="right" valign="top"><a id="a0272f4a35ca15a5a05817d7c1c4fafc2" name="a0272f4a35ca15a5a05817d7c1c4fafc2"></a>
bool </td><td class="memItemRight" valign="bottom"><b>AllowExternalOverride</b><code> [get]</code></td></tr>
<tr class="memdesc:a0272f4a35ca15a5a05817d7c1c4fafc2"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> defined in resources can be overriden by an external definition.<br /></td></tr>
<tr class="separator:a0272f4a35ca15a5a05817d7c1c4fafc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03458c485e43a017626b47bdcc960607"><td class="memItemLeft" align="right" valign="top"><a id="a03458c485e43a017626b47bdcc960607" name="a03458c485e43a017626b47bdcc960607"></a>
bool </td><td class="memItemRight" valign="bottom"><b>LoadAllFiles</b><code> [get]</code></td></tr>
<tr class="memdesc:a03458c485e43a017626b47bdcc960607"><td class="mdescLeft"> </td><td class="mdescRight">Determines which scripts of a <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> will be executed. If true, all scripts found under the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> folder will be executed. Otherwise, only scripts specified in the Contents list will be executed.<br /></td></tr>
<tr class="separator:a03458c485e43a017626b47bdcc960607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affe249017fdf7223afb821c17120458b"><td class="memItemLeft" align="right" valign="top"><a id="affe249017fdf7223afb821c17120458b" name="affe249017fdf7223afb821c17120458b"></a>
bool </td><td class="memItemRight" valign="bottom"><b>LoadOnDemand</b><code> [get]</code></td></tr>
<tr class="memdesc:affe249017fdf7223afb821c17120458b"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> will be loaded on demand or on load. If true, the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> will not be loaded until explicitly requested. Otherwise, it will be loaded during on scene initialisation.<br /></td></tr>
<tr class="separator:affe249017fdf7223afb821c17120458b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2887dc5b9ce0d6b1d4de01616acaf7c"><td class="memItemLeft" align="right" valign="top">string[] </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_packages_1_1_script_package.html#aa2887dc5b9ce0d6b1d4de01616acaf7c">Assets</a><code> [get]</code></td></tr>
<tr class="memdesc:aa2887dc5b9ce0d6b1d4de01616acaf7c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the array of assets specified for the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>. <a href="classu_lua_1_1_packages_1_1_script_package.html#aa2887dc5b9ce0d6b1d4de01616acaf7c">More...</a><br /></td></tr>
<tr class="separator:aa2887dc5b9ce0d6b1d4de01616acaf7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05dfafb589195a7c304e2861eb08fb37"><td class="memItemLeft" align="right" valign="top"><a id="a05dfafb589195a7c304e2861eb08fb37" name="a05dfafb589195a7c304e2861eb08fb37"></a>
string[] </td><td class="memItemRight" valign="bottom"><b>Contents</b><code> [get]</code></td></tr>
<tr class="memdesc:a05dfafb589195a7c304e2861eb08fb37"><td class="mdescLeft"> </td><td class="mdescRight">Gets the array of script names specified as contents of the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:a05dfafb589195a7c304e2861eb08fb37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7e25622267493eeae1abde0fa350ad8"><td class="memItemLeft" align="right" valign="top"><a id="ac7e25622267493eeae1abde0fa350ad8" name="ac7e25622267493eeae1abde0fa350ad8"></a>
string[] </td><td class="memItemRight" valign="bottom"><b>Dependencies</b><code> [get]</code></td></tr>
<tr class="memdesc:ac7e25622267493eeae1abde0fa350ad8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the array of dependencies specified for the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:ac7e25622267493eeae1abde0fa350ad8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9665880e328e75dfc62b3f7050427a73"><td class="memItemLeft" align="right" valign="top"><a id="a9665880e328e75dfc62b3f7050427a73" name="a9665880e328e75dfc62b3f7050427a73"></a>
string </td><td class="memItemRight" valign="bottom"><b>Description</b><code> [get]</code></td></tr>
<tr class="memdesc:a9665880e328e75dfc62b3f7050427a73"><td class="mdescLeft"> </td><td class="mdescRight">Gets the description of the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:a9665880e328e75dfc62b3f7050427a73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f0f96954daed4f9ed560f2a9575c0eb"><td class="memItemLeft" align="right" valign="top"><a id="a2f0f96954daed4f9ed560f2a9575c0eb" name="a2f0f96954daed4f9ed560f2a9575c0eb"></a>
string </td><td class="memItemRight" valign="bottom"><b>FolderName</b><code> [get]</code></td></tr>
<tr class="memdesc:a2f0f96954daed4f9ed560f2a9575c0eb"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the folder in which the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> is contained (i.e. if it differs from the index name of the Lua package).<br /></td></tr>
<tr class="separator:a2f0f96954daed4f9ed560f2a9575c0eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad976113951876b0788983dc041d127f6"><td class="memItemLeft" align="right" valign="top"><a id="ad976113951876b0788983dc041d127f6" name="ad976113951876b0788983dc041d127f6"></a>
bool </td><td class="memItemRight" valign="bottom"><b>IsExternal</b><code> [get, set]</code></td></tr>
<tr class="memdesc:ad976113951876b0788983dc041d127f6"><td class="mdescLeft"> </td><td class="mdescRight">Specifies if the script package was defined as an external package.<br /></td></tr>
<tr class="separator:ad976113951876b0788983dc041d127f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62c88eb8b1e1bfa065d74409a320f8c3"><td class="memItemLeft" align="right" valign="top"><a id="a62c88eb8b1e1bfa065d74409a320f8c3" name="a62c88eb8b1e1bfa065d74409a320f8c3"></a>
string </td><td class="memItemRight" valign="bottom"><b>Name</b><code> [get]</code></td></tr>
<tr class="memdesc:a62c88eb8b1e1bfa065d74409a320f8c3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the index name of the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:a62c88eb8b1e1bfa065d74409a320f8c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f35234e599c08b5105b652830f8a206"><td class="memItemLeft" align="right" valign="top"><a id="a9f35234e599c08b5105b652830f8a206" name="a9f35234e599c08b5105b652830f8a206"></a>
string </td><td class="memItemRight" valign="bottom"><b>Title</b><code> [get]</code></td></tr>
<tr class="memdesc:a9f35234e599c08b5105b652830f8a206"><td class="mdescLeft"> </td><td class="mdescRight">Gets the title of the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a> for display purposes.<br /></td></tr>
<tr class="separator:a9f35234e599c08b5105b652830f8a206"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64d40753d5deb021eafe2661337fd6be"><td class="memItemLeft" align="right" valign="top"><a id="a64d40753d5deb021eafe2661337fd6be" name="a64d40753d5deb021eafe2661337fd6be"></a>
string </td><td class="memItemRight" valign="bottom"><b>Version</b><code> [get]</code></td></tr>
<tr class="memdesc:a64d40753d5deb021eafe2661337fd6be"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version string of the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:a64d40753d5deb021eafe2661337fd6be"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A class to describe Lua script packages.</p>
<p >Script packages are collections of Lua scripts and their associated assets. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="aa2887dc5b9ce0d6b1d4de01616acaf7c" name="aa2887dc5b9ce0d6b1d4de01616acaf7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2887dc5b9ce0d6b1d4de01616acaf7c">◆ </a></span>Assets</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string [] uLua.Packages.ScriptPackage.Assets</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the array of assets specified for the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>.</p>
<p >Assets are files that will be loaded by the <a class="el" href="classu_lua_1_1_packages_1_1_script_package.html" title="A class to describe Lua script packages.">ScriptPackage</a>, such as textures, audio clips, etc. This does not include Lua scripts.</p>
<dl class="section return"><dt>Returns</dt><dd>An array of strings representing the paths of the assets. Paths are relative to the package folder.</dd></dl>
</div>
</div>
</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="namespaceu_lua.html">uLua</a></li><li class="navelem"><a class="el" href="namespaceu_lua_1_1_packages.html">Packages</a></li><li class="navelem"><a class="el" href="classu_lua_1_1_packages_1_1_script_package.html">ScriptPackage</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>