-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassu_lua_1_1_lua_mono_behaviour.html
More file actions
415 lines (390 loc) · 29.6 KB
/
Copy pathclassu_lua_1_1_lua_mono_behaviour.html
File metadata and controls
415 lines (390 loc) · 29.6 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
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<!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.LuaMonoBehaviour 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"> v3.0.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_lua_mono_behaviour.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="#pro-methods">Protected Member Functions</a> |
<a href="#properties">Properties</a> |
<a href="classu_lua_1_1_lua_mono_behaviour-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uLua.LuaMonoBehaviour Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>MonoBehaviour script exposed to Lua. You may use this class as a base for your <a class="el" href="classu_lua_1_1_a_p_i.html" title="This MonoBehaviour sets up the API framework to your Unity scene. Add to an object in your scene and ...">API</a> game objects.
<a href="classu_lua_1_1_lua_mono_behaviour.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:a14c289a707a80490eb155d0deded7c48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a14c289a707a80490eb155d0deded7c48">Expose</a> ()</td></tr>
<tr class="memdesc:a14c289a707a80490eb155d0deded7c48"><td class="mdescLeft"> </td><td class="mdescRight">Exposes the object to Lua. <a href="classu_lua_1_1_lua_mono_behaviour.html#a14c289a707a80490eb155d0deded7c48">More...</a><br /></td></tr>
<tr class="separator:a14c289a707a80490eb155d0deded7c48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eb21776423904f0ff080693e7d31e6f"><td class="memItemLeft" align="right" valign="top">DynValue </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a4eb21776423904f0ff080693e7d31e6f">InvokeLua</a> (string functionName, params object[] args)</td></tr>
<tr class="memdesc:a4eb21776423904f0ff080693e7d31e6f"><td class="mdescLeft"> </td><td class="mdescRight">Invokes a Lua callback function. <a href="classu_lua_1_1_lua_mono_behaviour.html#a4eb21776423904f0ff080693e7d31e6f">More...</a><br /></td></tr>
<tr class="separator:a4eb21776423904f0ff080693e7d31e6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfc79367e009c101945f01ae59248e68"><td class="memItemLeft" align="right" valign="top"><a id="adfc79367e009c101945f01ae59248e68" name="adfc79367e009c101945f01ae59248e68"></a>
void </td><td class="memItemRight" valign="bottom"><b>Expose</b> ()</td></tr>
<tr class="memdesc:adfc79367e009c101945f01ae59248e68"><td class="mdescLeft"> </td><td class="mdescRight">Exposes the object to Lua.<br /></td></tr>
<tr class="separator:adfc79367e009c101945f01ae59248e68"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:adb2abf103f142cfa42206cf6e47d3aaf"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#adb2abf103f142cfa42206cf6e47d3aaf">Awake</a> ()</td></tr>
<tr class="memdesc:adb2abf103f142cfa42206cf6e47d3aaf"><td class="mdescLeft"> </td><td class="mdescRight">Exposes the game object to Lua if ExposeOn is set to 'Awake'. <a href="classu_lua_1_1_lua_mono_behaviour.html#adb2abf103f142cfa42206cf6e47d3aaf">More...</a><br /></td></tr>
<tr class="separator:adb2abf103f142cfa42206cf6e47d3aaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45395ceb9d86fe9b13489a1441af6dac"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a45395ceb9d86fe9b13489a1441af6dac">OnDestroy</a> ()</td></tr>
<tr class="memdesc:a45395ceb9d86fe9b13489a1441af6dac"><td class="mdescLeft"> </td><td class="mdescRight">Invokes the OnExit callback and removes the object from Lua. <a href="classu_lua_1_1_lua_mono_behaviour.html#a45395ceb9d86fe9b13489a1441af6dac">More...</a><br /></td></tr>
<tr class="separator:a45395ceb9d86fe9b13489a1441af6dac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56d10a1ad813b809d2bf1784e0132f59"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a56d10a1ad813b809d2bf1784e0132f59">OnEnable</a> ()</td></tr>
<tr class="memdesc:a56d10a1ad813b809d2bf1784e0132f59"><td class="mdescLeft"> </td><td class="mdescRight">Exposes the game object to Lua if ExposeOn is set to 'OnEnable'. <a href="classu_lua_1_1_lua_mono_behaviour.html#a56d10a1ad813b809d2bf1784e0132f59">More...</a><br /></td></tr>
<tr class="separator:a56d10a1ad813b809d2bf1784e0132f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64b99de685acecac39edbd925e2e25e9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a64b99de685acecac39edbd925e2e25e9">OnExpose</a> ()</td></tr>
<tr class="memdesc:a64b99de685acecac39edbd925e2e25e9"><td class="mdescLeft"> </td><td class="mdescRight">Scriptable method called when an object is exposed to Lua. <a href="classu_lua_1_1_lua_mono_behaviour.html#a64b99de685acecac39edbd925e2e25e9">More...</a><br /></td></tr>
<tr class="separator:a64b99de685acecac39edbd925e2e25e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fc943b324d6617ffbeac6f491bf65dd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a4fc943b324d6617ffbeac6f491bf65dd">Start</a> ()</td></tr>
<tr class="memdesc:a4fc943b324d6617ffbeac6f491bf65dd"><td class="mdescLeft"> </td><td class="mdescRight">Exposes the game object to Lua if ExposeOn is set to 'Start'. <a href="classu_lua_1_1_lua_mono_behaviour.html#a4fc943b324d6617ffbeac6f491bf65dd">More...</a><br /></td></tr>
<tr class="separator:a4fc943b324d6617ffbeac6f491bf65dd"><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:a94c108168284e50d0fd2e19e3a9201ff"><td class="memItemLeft" align="right" valign="top"><a id="a94c108168284e50d0fd2e19e3a9201ff" name="a94c108168284e50d0fd2e19e3a9201ff"></a>
DynValue </td><td class="memItemRight" valign="bottom"><b>this[DynValue key]</b><code> [get, set]</code></td></tr>
<tr class="memdesc:a94c108168284e50d0fd2e19e3a9201ff"><td class="mdescLeft"> </td><td class="mdescRight">Returns a dynamic value indexed by a dynamic value Key. <br /></td></tr>
<tr class="separator:a94c108168284e50d0fd2e19e3a9201ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93a1155dea4cb692510b85e885bb5092"><td class="memItemLeft" align="right" valign="top"><a id="a93a1155dea4cb692510b85e885bb5092" name="a93a1155dea4cb692510b85e885bb5092"></a>
DynValue </td><td class="memItemRight" valign="bottom"><b>this[string key]</b><code> [get, set]</code></td></tr>
<tr class="memdesc:a93a1155dea4cb692510b85e885bb5092"><td class="mdescLeft"> </td><td class="mdescRight">Returns a dynamic value indexed by a string key. <br /></td></tr>
<tr class="separator:a93a1155dea4cb692510b85e885bb5092"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1523d1646680cc7304bc2caf2599d73"><td class="memItemLeft" align="right" valign="top"><a id="ad1523d1646680cc7304bc2caf2599d73" name="ad1523d1646680cc7304bc2caf2599d73"></a>
bool </td><td class="memItemRight" valign="bottom"><b>EnableObjectScript</b><code> [get, set]</code></td></tr>
<tr class="memdesc:ad1523d1646680cc7304bc2caf2599d73"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the object script is enabled for this object.<br /></td></tr>
<tr class="separator:ad1523d1646680cc7304bc2caf2599d73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b5d568b212d8ed295082a672aeb3857"><td class="memItemLeft" align="right" valign="top"><a id="a2b5d568b212d8ed295082a672aeb3857" name="a2b5d568b212d8ed295082a672aeb3857"></a>
<a class="el" href="namespaceu_lua.html#a1f80e2b75fa116855258258b8870cc3f">ExposeTarget</a> </td><td class="memItemRight" valign="bottom"><b>ExposeTarget</b><code> [get, set]</code></td></tr>
<tr class="memdesc:a2b5d568b212d8ed295082a672aeb3857"><td class="mdescLeft"> </td><td class="mdescRight">Indicates when this object will be exposed to Lua.<br /></td></tr>
<tr class="separator:a2b5d568b212d8ed295082a672aeb3857"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2ded05e5bce1b5a2927662948963d3b"><td class="memItemLeft" align="right" valign="top"><a id="ab2ded05e5bce1b5a2927662948963d3b" name="ab2ded05e5bce1b5a2927662948963d3b"></a>
<a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td><td class="memItemRight" valign="bottom"><b>LuaParent</b><code> [get, set]</code></td></tr>
<tr class="memdesc:ab2ded05e5bce1b5a2927662948963d3b"><td class="mdescLeft"> </td><td class="mdescRight">Use to access/set the parent of an object. <br /></td></tr>
<tr class="separator:ab2ded05e5bce1b5a2927662948963d3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d99975f1061889e20d526c44724510d"><td class="memItemLeft" align="right" valign="top"><a id="a2d99975f1061889e20d526c44724510d" name="a2d99975f1061889e20d526c44724510d"></a>
bool </td><td class="memItemRight" valign="bottom"><b>IsExposed</b><code> [get]</code></td></tr>
<tr class="memdesc:a2d99975f1061889e20d526c44724510d"><td class="mdescLeft"> </td><td class="mdescRight">Tracks if an object has been exposed to Lua. <br /></td></tr>
<tr class="separator:a2d99975f1061889e20d526c44724510d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f04e7fa4bbe4eb2944594ada6cd623f"><td class="memItemLeft" align="right" valign="top"><a id="a8f04e7fa4bbe4eb2944594ada6cd623f" name="a8f04e7fa4bbe4eb2944594ada6cd623f"></a>
string </td><td class="memItemRight" valign="bottom"><b>LuaHandle</b><code> [get]</code></td></tr>
<tr class="memdesc:a8f04e7fa4bbe4eb2944594ada6cd623f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique handle of a Lua object. <br /></td></tr>
<tr class="separator:a8f04e7fa4bbe4eb2944594ada6cd623f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac478b6e22be9d035bc9ef51ef7739ce5"><td class="memItemLeft" align="right" valign="top"><a id="ac478b6e22be9d035bc9ef51ef7739ce5" name="ac478b6e22be9d035bc9ef51ef7739ce5"></a>
string </td><td class="memItemRight" valign="bottom"><b>LuaName</b><code> [get, set]</code></td></tr>
<tr class="memdesc:ac478b6e22be9d035bc9ef51ef7739ce5"><td class="mdescLeft"> </td><td class="mdescRight">Use to access the name of an object. <br /></td></tr>
<tr class="separator:ac478b6e22be9d035bc9ef51ef7739ce5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceu_lua_1_1_core_1_1_i_lua_object')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html">uLua.Core.ILuaObject</a></td></tr>
<tr class="memitem:af10ff65f1894a7567ba09fbd838d3b7a inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top">DynValue </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#af10ff65f1894a7567ba09fbd838d3b7a">this[DynValue key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af10ff65f1894a7567ba09fbd838d3b7a inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns a dynamic value indexed by a dynamic value Key. <a href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#af10ff65f1894a7567ba09fbd838d3b7a">More...</a><br /></td></tr>
<tr class="separator:af10ff65f1894a7567ba09fbd838d3b7a inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa70f0b87442d3a10539cdad8aa81f919 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top">DynValue </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#aa70f0b87442d3a10539cdad8aa81f919">this[string key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aa70f0b87442d3a10539cdad8aa81f919 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns a dynamic value indexed by a string key. <a href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#aa70f0b87442d3a10539cdad8aa81f919">More...</a><br /></td></tr>
<tr class="separator:aa70f0b87442d3a10539cdad8aa81f919 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e6edbe7cd526519ef13c3f70ec1e633 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#a3e6edbe7cd526519ef13c3f70ec1e633">LuaParent</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a3e6edbe7cd526519ef13c3f70ec1e633 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Use to access/set the parent of an object. <a href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#a3e6edbe7cd526519ef13c3f70ec1e633">More...</a><br /></td></tr>
<tr class="separator:a3e6edbe7cd526519ef13c3f70ec1e633 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadd900d4d92c6fead09a4c2d98345785 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#aadd900d4d92c6fead09a4c2d98345785">IsExposed</a><code> [get]</code></td></tr>
<tr class="memdesc:aadd900d4d92c6fead09a4c2d98345785 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Tracks if an object has been exposed to Lua. <a href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#aadd900d4d92c6fead09a4c2d98345785">More...</a><br /></td></tr>
<tr class="separator:aadd900d4d92c6fead09a4c2d98345785 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e372ed37bf2dde618f6f32f60f5d0d7 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top"><a id="a5e372ed37bf2dde618f6f32f60f5d0d7" name="a5e372ed37bf2dde618f6f32f60f5d0d7"></a>
string </td><td class="memItemRight" valign="bottom"><b>LuaHandle</b><code> [get]</code></td></tr>
<tr class="memdesc:a5e372ed37bf2dde618f6f32f60f5d0d7 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique handle of a Lua object.<br /></td></tr>
<tr class="separator:a5e372ed37bf2dde618f6f32f60f5d0d7 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a358765718d34d8efecf3e2a8939140d5 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#a358765718d34d8efecf3e2a8939140d5">LuaName</a><code> [get]</code></td></tr>
<tr class="memdesc:a358765718d34d8efecf3e2a8939140d5 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Use to access the name of an object. <a href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#a358765718d34d8efecf3e2a8939140d5">More...</a><br /></td></tr>
<tr class="separator:a358765718d34d8efecf3e2a8939140d5 inherit properties_interfaceu_lua_1_1_core_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >MonoBehaviour script exposed to Lua. You may use this class as a base for your <a class="el" href="classu_lua_1_1_a_p_i.html" title="This MonoBehaviour sets up the API framework to your Unity scene. Add to an object in your scene and ...">API</a> game objects.</p>
<p >Instances of this class are exposed to Lua if configured. All public members of derived classes will be exposed to Lua. Prior to exposing an object of type <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html" title="MonoBehaviour script exposed to Lua. You may use this class as a base for your API game objects.">uLua.LuaMonoBehaviour</a>, the derived type <code>T</code> must be registered to Lua by calling <code><a class="el" href="classu_lua_1_1_a_p_i.html#a5173240c9e5a01c6e6f281144e6d427d" title="Registers a type that implements the ILuaObject interface to Lua.">API.RegisterIndexedType()</a></code>. <br />
</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adb2abf103f142cfa42206cf6e47d3aaf" name="adb2abf103f142cfa42206cf6e47d3aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb2abf103f142cfa42206cf6e47d3aaf">◆ </a></span>Awake()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uLua.LuaMonoBehaviour.Awake </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Exposes the game object to Lua if ExposeOn is set to 'Awake'.</p>
<p >The LuaParent object must be set prior to this method being called. Objects will not be exposed to Lua if <code>ExposeOn</code> is set to None. If the object is exposed here, this method will also invoke an OnLoad callback and execute a resource script for the object if <code>EnableObjectScript</code> is set to true. </p>
</div>
</div>
<a id="a14c289a707a80490eb155d0deded7c48" name="a14c289a707a80490eb155d0deded7c48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14c289a707a80490eb155d0deded7c48">◆ </a></span>Expose()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void uLua.LuaMonoBehaviour.Expose </td>
<td>(</td>
<td class="paramname"></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>Exposes the object to Lua.</p>
<p >The property <code>IsExposed</code> can be used to check if this method has been called. The <code>IsExposed</code> flag cannot be reset. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_core_1_1_i_lua_object.html#adfc79367e009c101945f01ae59248e68">uLua.Core.ILuaObject</a>.</p>
</div>
</div>
<a id="a4eb21776423904f0ff080693e7d31e6f" name="a4eb21776423904f0ff080693e7d31e6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eb21776423904f0ff080693e7d31e6f">◆ </a></span>InvokeLua()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DynValue uLua.LuaMonoBehaviour.InvokeLua </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>functionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">params object[] </td>
<td class="paramname"><em>args</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>Invokes a Lua callback function.</p>
<p >The callback function must be implemented in a Lua script as a member of this object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">functionName</td><td>The name of the callback function to be called. </td></tr>
<tr><td class="paramname">args</td><td>(Optional) Parameters for the callback function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a45395ceb9d86fe9b13489a1441af6dac" name="a45395ceb9d86fe9b13489a1441af6dac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45395ceb9d86fe9b13489a1441af6dac">◆ </a></span>OnDestroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uLua.LuaMonoBehaviour.OnDestroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invokes the OnExit callback and removes the object from Lua.</p>
<p >This method is called by Unity Engine when a game object is destroyed. </p>
</div>
</div>
<a id="a56d10a1ad813b809d2bf1784e0132f59" name="a56d10a1ad813b809d2bf1784e0132f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56d10a1ad813b809d2bf1784e0132f59">◆ </a></span>OnEnable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uLua.LuaMonoBehaviour.OnEnable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Exposes the game object to Lua if ExposeOn is set to 'OnEnable'.</p>
<p >The LuaParent object must be set prior to this method being called. Objects will not be exposed to Lua if <code>ExposeOn</code> is set to None. If the object is exposed here, this method will also invoke an OnLoad callback and execute a resource script for the object if <code>EnableObjectScript</code> is set to true. Resource scripts are only executed for objects which are globals in Lua (i.e. LuaParent is set to null). </p>
</div>
</div>
<a id="a64b99de685acecac39edbd925e2e25e9" name="a64b99de685acecac39edbd925e2e25e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64b99de685acecac39edbd925e2e25e9">◆ </a></span>OnExpose()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uLua.LuaMonoBehaviour.OnExpose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Scriptable method called when an object is exposed to Lua.</p>
<p >Executes the object Lua script and invokes <code>OnLoad</code> by default. </p>
</div>
</div>
<a id="a4fc943b324d6617ffbeac6f491bf65dd" name="a4fc943b324d6617ffbeac6f491bf65dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fc943b324d6617ffbeac6f491bf65dd">◆ </a></span>Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uLua.LuaMonoBehaviour.Start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Exposes the game object to Lua if ExposeOn is set to 'Start'.</p>
<p >The LuaParent object must be set prior to this method being called. Objects will not be exposed to Lua if <code>ExposeOn</code> is set to None. If the object is exposed here, this method will also invoke an OnLoad callback and execute a resource script for the object if <code>EnableObjectScript</code> is set to true. Resource scripts are only executed for objects which are globals in Lua (i.e. LuaParent is set to null). </p>
</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_lua_mono_behaviour.html">LuaMonoBehaviour</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>