-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassu_lua_1_1_script_package.html
227 lines (221 loc) · 17.7 KB
/
classu_lua_1_1_script_package.html
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
<!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.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="projectlogo"><img alt="Logo" src="uLua2-160x160-Light.png"/></td>
<td id="projectalign">
<div id="projectname">uLua<span id="projectnumber"> v2.2.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_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="#pub-methods">Public Member Functions</a> |
<a href="#properties">Properties</a> |
<a href="classu_lua_1_1_script_package-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uLua.ScriptPackage Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A class to describe <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> packages.
<a href="classu_lua_1_1_script_package.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a723a9cac45f2c5883d2a829ffad14f89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_script_package.html#a723a9cac45f2c5883d2a829ffad14f89">ScriptPackage</a> (string <a class="el" href="classu_lua_1_1_script_package.html#ab420a02ce82b8080b445b28dc0b1c6c7">Name</a>, string <a class="el" href="classu_lua_1_1_script_package.html#a253ebfce6391d6105c9a9145e73c0e4d">FolderName</a>, <a class="el" href="classu_lua_1_1_script_package_json.html">ScriptPackageJson</a> PackageJson, bool <a class="el" href="classu_lua_1_1_script_package.html#a254b49a46a81c339d4503c3e7cfbcff1">IsExternal</a>)</td></tr>
<tr class="memdesc:a723a9cac45f2c5883d2a829ffad14f89"><td class="mdescLeft"> </td><td class="mdescRight">Public constructor. This is the main way to initialise a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> object. <a href="classu_lua_1_1_script_package.html#a723a9cac45f2c5883d2a829ffad14f89">More...</a><br /></td></tr>
<tr class="separator:a723a9cac45f2c5883d2a829ffad14f89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56fba80af87933287d7328149b390fa6"><td class="memItemLeft" align="right" valign="top"><a id="a56fba80af87933287d7328149b390fa6" name="a56fba80af87933287d7328149b390fa6"></a>
void </td><td class="memItemRight" valign="bottom"><b>SwitchToExternal</b> ()</td></tr>
<tr class="memdesc:a56fba80af87933287d7328149b390fa6"><td class="mdescLeft"> </td><td class="mdescRight">This method is used to switch the package definition to external. Using this method instead of a public property protects the accessibility of IsExternal.<br /></td></tr>
<tr class="separator:a56fba80af87933287d7328149b390fa6"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a57ed6fa50574354c0428c65b8e3b29df"><td class="memItemLeft" align="right" valign="top"><a id="a57ed6fa50574354c0428c65b8e3b29df" name="a57ed6fa50574354c0428c65b8e3b29df"></a>
bool </td><td class="memItemRight" valign="bottom"><b>AllowExternalOverride</b><code> [get]</code></td></tr>
<tr class="memdesc:a57ed6fa50574354c0428c65b8e3b29df"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> defined in resources can be overriden by an external definition.<br /></td></tr>
<tr class="separator:a57ed6fa50574354c0428c65b8e3b29df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a621ae3eeff90d4fa9dd4aec975fc2b72"><td class="memItemLeft" align="right" valign="top"><a id="a621ae3eeff90d4fa9dd4aec975fc2b72" name="a621ae3eeff90d4fa9dd4aec975fc2b72"></a>
bool </td><td class="memItemRight" valign="bottom"><b>LoadAllFiles</b><code> [get]</code></td></tr>
<tr class="memdesc:a621ae3eeff90d4fa9dd4aec975fc2b72"><td class="mdescLeft"> </td><td class="mdescRight">Determines which scripts of a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> will be executed. If true, all scripts found under the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> folder will be executed. Otherwise, only scripts specified in the Contents list will be executed.<br /></td></tr>
<tr class="separator:a621ae3eeff90d4fa9dd4aec975fc2b72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a225de9865031842afea7db2c583c05a6"><td class="memItemLeft" align="right" valign="top"><a id="a225de9865031842afea7db2c583c05a6" name="a225de9865031842afea7db2c583c05a6"></a>
bool </td><td class="memItemRight" valign="bottom"><b>LoadOnDemand</b><code> [get]</code></td></tr>
<tr class="memdesc:a225de9865031842afea7db2c583c05a6"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> will be loaded on demand or on load. If true, the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua 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:a225de9865031842afea7db2c583c05a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac51be6d5ee361232694ab0a5532ac49c"><td class="memItemLeft" align="right" valign="top"><a id="ac51be6d5ee361232694ab0a5532ac49c" name="ac51be6d5ee361232694ab0a5532ac49c"></a>
string[] </td><td class="memItemRight" valign="bottom"><b>Contents</b><code> [get]</code></td></tr>
<tr class="memdesc:ac51be6d5ee361232694ab0a5532ac49c"><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_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:ac51be6d5ee361232694ab0a5532ac49c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa81790855b856ac4670cfe64ce4c5a81"><td class="memItemLeft" align="right" valign="top"><a id="aa81790855b856ac4670cfe64ce4c5a81" name="aa81790855b856ac4670cfe64ce4c5a81"></a>
string[] </td><td class="memItemRight" valign="bottom"><b>Dependencies</b><code> [get]</code></td></tr>
<tr class="memdesc:aa81790855b856ac4670cfe64ce4c5a81"><td class="mdescLeft"> </td><td class="mdescRight">Gets the array of dependencies specified for the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:aa81790855b856ac4670cfe64ce4c5a81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1896b54cb7225822bca4d580af0b3cd"><td class="memItemLeft" align="right" valign="top"><a id="ac1896b54cb7225822bca4d580af0b3cd" name="ac1896b54cb7225822bca4d580af0b3cd"></a>
string </td><td class="memItemRight" valign="bottom"><b>Description</b><code> [get]</code></td></tr>
<tr class="memdesc:ac1896b54cb7225822bca4d580af0b3cd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the description of the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:ac1896b54cb7225822bca4d580af0b3cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a253ebfce6391d6105c9a9145e73c0e4d"><td class="memItemLeft" align="right" valign="top"><a id="a253ebfce6391d6105c9a9145e73c0e4d" name="a253ebfce6391d6105c9a9145e73c0e4d"></a>
string </td><td class="memItemRight" valign="bottom"><b>FolderName</b><code> [get]</code></td></tr>
<tr class="memdesc:a253ebfce6391d6105c9a9145e73c0e4d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the folder in which the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> is contained (i.e. if it differs from the index name of the <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> package).<br /></td></tr>
<tr class="separator:a253ebfce6391d6105c9a9145e73c0e4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a254b49a46a81c339d4503c3e7cfbcff1"><td class="memItemLeft" align="right" valign="top"><a id="a254b49a46a81c339d4503c3e7cfbcff1" name="a254b49a46a81c339d4503c3e7cfbcff1"></a>
bool </td><td class="memItemRight" valign="bottom"><b>IsExternal</b><code> [get]</code></td></tr>
<tr class="memdesc:a254b49a46a81c339d4503c3e7cfbcff1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the IsExternal property of the package.<br /></td></tr>
<tr class="separator:a254b49a46a81c339d4503c3e7cfbcff1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab420a02ce82b8080b445b28dc0b1c6c7"><td class="memItemLeft" align="right" valign="top"><a id="ab420a02ce82b8080b445b28dc0b1c6c7" name="ab420a02ce82b8080b445b28dc0b1c6c7"></a>
string </td><td class="memItemRight" valign="bottom"><b>Name</b><code> [get]</code></td></tr>
<tr class="memdesc:ab420a02ce82b8080b445b28dc0b1c6c7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the index name of the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:ab420a02ce82b8080b445b28dc0b1c6c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28e4078259c30b8d4b258d36fbc29404"><td class="memItemLeft" align="right" valign="top"><a id="a28e4078259c30b8d4b258d36fbc29404" name="a28e4078259c30b8d4b258d36fbc29404"></a>
string </td><td class="memItemRight" valign="bottom"><b>Title</b><code> [get]</code></td></tr>
<tr class="memdesc:a28e4078259c30b8d4b258d36fbc29404"><td class="mdescLeft"> </td><td class="mdescRight">Gets the title of the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> for display purposes.<br /></td></tr>
<tr class="separator:a28e4078259c30b8d4b258d36fbc29404"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add94e4b26c7fc8aa990e4873bff4fe46"><td class="memItemLeft" align="right" valign="top"><a id="add94e4b26c7fc8aa990e4873bff4fe46" name="add94e4b26c7fc8aa990e4873bff4fe46"></a>
string </td><td class="memItemRight" valign="bottom"><b>Version</b><code> [get]</code></td></tr>
<tr class="memdesc:add94e4b26c7fc8aa990e4873bff4fe46"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version string of the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>.<br /></td></tr>
<tr class="separator:add94e4b26c7fc8aa990e4873bff4fe46"><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 <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> packages.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a723a9cac45f2c5883d2a829ffad14f89" name="a723a9cac45f2c5883d2a829ffad14f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723a9cac45f2c5883d2a829ffad14f89">◆ </a></span>ScriptPackage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uLua.ScriptPackage.ScriptPackage </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>Name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>FolderName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classu_lua_1_1_script_package_json.html">ScriptPackageJson</a> </td>
<td class="paramname"><em>PackageJson</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>IsExternal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Public constructor. This is the main way to initialise a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Name</td><td>The name of the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a>. </td></tr>
<tr><td class="paramname">FolderName</td><td>The name of the folder in which the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> is contained (i.e. if it differs from the name of the <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> package). </td></tr>
<tr><td class="paramname">PackageJson</td><td>The object which holds most information for the <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> package. </td></tr>
<tr><td class="paramname">IsExternal</td><td>Specifies if the script package was defined as an external package. </td></tr>
</table>
</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="classu_lua_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>