-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassu_lua_1_1_lua_mono_behaviour.html
490 lines (450 loc) · 34.5 KB
/
classu_lua_1_1_lua_mono_behaviour.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
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
<!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"> 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_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 which establishes a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object framework. For internal use.
<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">Used to raise a flag when an object is exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. <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:aa874da2a777e09784bb9f9446eb160ff"><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#aa874da2a777e09784bb9f9446eb160ff">InvokeLua</a> (string FunctionName, params object[] args)</td></tr>
<tr class="memdesc:aa874da2a777e09784bb9f9446eb160ff"><td class="mdescLeft"> </td><td class="mdescRight">Invokes a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> callback function. <a href="classu_lua_1_1_lua_mono_behaviour.html#aa874da2a777e09784bb9f9446eb160ff">More...</a><br /></td></tr>
<tr class="separator:aa874da2a777e09784bb9f9446eb160ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f028daf9f38d9e13d8fc3aafbe6c628"><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#a3f028daf9f38d9e13d8fc3aafbe6c628">Register</a> (string FunctionName, string Code="", string args="")</td></tr>
<tr class="memdesc:a3f028daf9f38d9e13d8fc3aafbe6c628"><td class="mdescLeft"> </td><td class="mdescRight">Registers a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> callback function. This method is available in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. <a href="classu_lua_1_1_lua_mono_behaviour.html#a3f028daf9f38d9e13d8fc3aafbe6c628">More...</a><br /></td></tr>
<tr class="separator:a3f028daf9f38d9e13d8fc3aafbe6c628"><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: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 <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. <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>
</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:a6642f068a9c0446b414489f9a8ce1733"><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#a6642f068a9c0446b414489f9a8ce1733">this[DynValue Key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a6642f068a9c0446b414489f9a8ce1733"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the DynValue Key. <a href="classu_lua_1_1_lua_mono_behaviour.html#a6642f068a9c0446b414489f9a8ce1733">More...</a><br /></td></tr>
<tr class="separator:a6642f068a9c0446b414489f9a8ce1733"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a291d159032e91a0f42d41342c99e803a"><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#a291d159032e91a0f42d41342c99e803a">this[string Key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a291d159032e91a0f42d41342c99e803a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the string key. <a href="classu_lua_1_1_lua_mono_behaviour.html#a291d159032e91a0f42d41342c99e803a">More...</a><br /></td></tr>
<tr class="separator:a291d159032e91a0f42d41342c99e803a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bdf5476d043616df482defa708a31f3"><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="classu_lua_1_1_lua_mono_behaviour.html#a6bdf5476d043616df482defa708a31f3">Context</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a6bdf5476d043616df482defa708a31f3"><td class="mdescLeft"> </td><td class="mdescRight">Used to access/set the context of an object. <a href="classu_lua_1_1_lua_mono_behaviour.html#a6bdf5476d043616df482defa708a31f3">More...</a><br /></td></tr>
<tr class="separator:a6bdf5476d043616df482defa708a31f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe9514a1edfb41600b0375f59f047349"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#afe9514a1edfb41600b0375f59f047349">Handle</a><code> [get]</code></td></tr>
<tr class="memdesc:afe9514a1edfb41600b0375f59f047349"><td class="mdescLeft"> </td><td class="mdescRight">Used to access the unique Handle of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object. <a href="classu_lua_1_1_lua_mono_behaviour.html#afe9514a1edfb41600b0375f59f047349">More...</a><br /></td></tr>
<tr class="separator:afe9514a1edfb41600b0375f59f047349"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d99975f1061889e20d526c44724510d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a2d99975f1061889e20d526c44724510d">IsExposed</a><code> [get]</code></td></tr>
<tr class="memdesc:a2d99975f1061889e20d526c44724510d"><td class="mdescLeft"> </td><td class="mdescRight">Used to track if an object has been exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. <a href="classu_lua_1_1_lua_mono_behaviour.html#a2d99975f1061889e20d526c44724510d">More...</a><br /></td></tr>
<tr class="separator:a2d99975f1061889e20d526c44724510d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bfb80e2c7d342e14fbbb0e8a4a1239a"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a0bfb80e2c7d342e14fbbb0e8a4a1239a">Name</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a0bfb80e2c7d342e14fbbb0e8a4a1239a"><td class="mdescLeft"> </td><td class="mdescRight">Used to access/set the name of an object. <a href="classu_lua_1_1_lua_mono_behaviour.html#a0bfb80e2c7d342e14fbbb0e8a4a1239a">More...</a><br /></td></tr>
<tr class="separator:a0bfb80e2c7d342e14fbbb0e8a4a1239a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header properties_interfaceu_lua_1_1_i_lua_object"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceu_lua_1_1_i_lua_object')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceu_lua_1_1_i_lua_object.html">uLua.ILuaObject</a></td></tr>
<tr class="memitem:ac0c5c30cdb923639aed02486408c1161 inherit properties_interfaceu_lua_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_i_lua_object.html#ac0c5c30cdb923639aed02486408c1161">this[DynValue Key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ac0c5c30cdb923639aed02486408c1161 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the DynValue Key. <a href="interfaceu_lua_1_1_i_lua_object.html#ac0c5c30cdb923639aed02486408c1161">More...</a><br /></td></tr>
<tr class="separator:ac0c5c30cdb923639aed02486408c1161 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46c4a4b996ffcf9f5ffff9cf51cce106 inherit properties_interfaceu_lua_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_i_lua_object.html#a46c4a4b996ffcf9f5ffff9cf51cce106">this[string Key]</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a46c4a4b996ffcf9f5ffff9cf51cce106 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the string key. <a href="interfaceu_lua_1_1_i_lua_object.html#a46c4a4b996ffcf9f5ffff9cf51cce106">More...</a><br /></td></tr>
<tr class="separator:a46c4a4b996ffcf9f5ffff9cf51cce106 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a349d3496c30ed5d84cd78b6372b00c4e inherit properties_interfaceu_lua_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_i_lua_object.html#a349d3496c30ed5d84cd78b6372b00c4e">Context</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a349d3496c30ed5d84cd78b6372b00c4e inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Used to access/set the context of an object. <a href="interfaceu_lua_1_1_i_lua_object.html#a349d3496c30ed5d84cd78b6372b00c4e">More...</a><br /></td></tr>
<tr class="separator:a349d3496c30ed5d84cd78b6372b00c4e inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e5249ea5f331fa06390530a9c9bef7c inherit properties_interfaceu_lua_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_i_lua_object.html#a1e5249ea5f331fa06390530a9c9bef7c">Handle</a><code> [get]</code></td></tr>
<tr class="memdesc:a1e5249ea5f331fa06390530a9c9bef7c inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Used to access the unique Handle of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object. <a href="interfaceu_lua_1_1_i_lua_object.html#a1e5249ea5f331fa06390530a9c9bef7c">More...</a><br /></td></tr>
<tr class="separator:a1e5249ea5f331fa06390530a9c9bef7c inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a9734aa0093d761e2dca67d18347167 inherit properties_interfaceu_lua_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_i_lua_object.html#a0a9734aa0093d761e2dca67d18347167">IsExposed</a><code> [get]</code></td></tr>
<tr class="memdesc:a0a9734aa0093d761e2dca67d18347167 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Used to track if an object has been exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. <a href="interfaceu_lua_1_1_i_lua_object.html#a0a9734aa0093d761e2dca67d18347167">More...</a><br /></td></tr>
<tr class="separator:a0a9734aa0093d761e2dca67d18347167 inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b7d3bed0c2ffa340c12908939eec6ce inherit properties_interfaceu_lua_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_i_lua_object.html#a6b7d3bed0c2ffa340c12908939eec6ce">Name</a><code> [get]</code></td></tr>
<tr class="memdesc:a6b7d3bed0c2ffa340c12908939eec6ce inherit properties_interfaceu_lua_1_1_i_lua_object"><td class="mdescLeft"> </td><td class="mdescRight">Used to access the name of an object. <a href="interfaceu_lua_1_1_i_lua_object.html#a6b7d3bed0c2ffa340c12908939eec6ce">More...</a><br /></td></tr>
<tr class="separator:a6b7d3bed0c2ffa340c12908939eec6ce inherit properties_interfaceu_lua_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 which establishes a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object framework. For internal use.</p>
<p >Instances of this class can be exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> by calling <code>uLua.API.Expose()</code>. All public members of derived classes will be exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. Prior to exposing an object of type <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html" title="MonoBehaviour script which establishes a Lua object framework. For internal use.">uLua.LuaMonoBehaviour</a>, the derived type <code>T</code> must be registered to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> by calling <code><a class="el" href="classu_lua_1_1_a_p_i.html#a4318d5c5f3e852eeb62909a68995379a" 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="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>Used to raise a flag when an object is exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>.</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_i_lua_object.html">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="aa874da2a777e09784bb9f9446eb160ff" name="aa874da2a777e09784bb9f9446eb160ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa874da2a777e09784bb9f9446eb160ff">◆ </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">void 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 <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> callback function.</p>
<p >The callback function must be implemented in a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> script as a member of this object. Alternatively, you can register a callback function by explicitly calling <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a3f028daf9f38d9e13d8fc3aafbe6c628" title="Registers a Lua callback function. This method is available in Lua.">uLua.LuaMonoBehaviour.Register()</a> with the relevant <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> code. </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 <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>.</p>
<p >This method is called by Unity Engine when a game object is destroyed. </p>
</div>
</div>
<a id="a3f028daf9f38d9e13d8fc3aafbe6c628" name="a3f028daf9f38d9e13d8fc3aafbe6c628"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f028daf9f38d9e13d8fc3aafbe6c628">◆ </a></span>Register()</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.Register </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">string </td>
<td class="paramname"><em>Code</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>args</em> = <code>""</code> </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>Registers a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> callback function. This method is available in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>.</p>
<p >Used to register a callback function by providing the relevant <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> code. </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 registered. </td></tr>
<tr><td class="paramname">Code</td><td>(Optional) The body of the function to be registered in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. If omitted, an empty function with the specified name is defined. </td></tr>
<tr><td class="paramname">args</td><td>(Optional) Parameters for the callback function. Must be separated by comma as they would be in a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> function definition, e.g. 'arg1,arg2'. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a6bdf5476d043616df482defa708a31f3" name="a6bdf5476d043616df482defa708a31f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bdf5476d043616df482defa708a31f3">◆ </a></span>Context</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> uLua.LuaMonoBehaviour.Context</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to access/set the context of an object.</p>
<p >The <code>Context</code> object represents the parent of an object in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. If the <code>Context</code> is null, the object will be global in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. Must be of type <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html" title="MonoBehaviour script which establishes a Lua object framework. For internal use.">uLua.LuaMonoBehaviour</a>. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#a349d3496c30ed5d84cd78b6372b00c4e">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="afe9514a1edfb41600b0375f59f047349" name="afe9514a1edfb41600b0375f59f047349"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe9514a1edfb41600b0375f59f047349">◆ </a></span>Handle</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string uLua.LuaMonoBehaviour.Handle</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>Used to access the unique Handle of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object.</p>
<p >The unique <code>Handle</code> of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object is defined as: <code>Context.Name</code>. If an object's context is null, its unique handle is simply its name. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#a1e5249ea5f331fa06390530a9c9bef7c">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="a2d99975f1061889e20d526c44724510d" name="a2d99975f1061889e20d526c44724510d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d99975f1061889e20d526c44724510d">◆ </a></span>IsExposed</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool uLua.LuaMonoBehaviour.IsExposed</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>Used to track if an object has been exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>.</p>
<p >Objects may be marked as exposed by calling the <code><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html#a14c289a707a80490eb155d0deded7c48" title="Used to raise a flag when an object is exposed to Lua.">Expose()</a></code> method. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#a0a9734aa0093d761e2dca67d18347167">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="a0bfb80e2c7d342e14fbbb0e8a4a1239a" name="a0bfb80e2c7d342e14fbbb0e8a4a1239a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bfb80e2c7d342e14fbbb0e8a4a1239a">◆ </a></span>Name</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string uLua.LuaMonoBehaviour.Name</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to access/set the name of an object.</p>
<p >If a name is not set, the game object's name will be used by default. The name of an object cannot be changed after it has been exposed to <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#a6b7d3bed0c2ffa340c12908939eec6ce">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="a6642f068a9c0446b414489f9a8ce1733" name="a6642f068a9c0446b414489f9a8ce1733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6642f068a9c0446b414489f9a8ce1733">◆ </a></span>this[DynValue Key]</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.this[DynValue Key]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the DynValue Key.</p>
<p >This indexer may be used in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> or within C# to access any member of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#ac0c5c30cdb923639aed02486408c1161">uLua.ILuaObject</a>.</p>
</div>
</div>
<a id="a291d159032e91a0f42d41342c99e803a" name="a291d159032e91a0f42d41342c99e803a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a291d159032e91a0f42d41342c99e803a">◆ </a></span>this[string Key]</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.this[string Key]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> value indexed by the string key.</p>
<p >This indexer may be used in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> or within C# to access any member of a <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> object. </p>
<p>Implements <a class="el" href="interfaceu_lua_1_1_i_lua_object.html#a46c4a4b996ffcf9f5ffff9cf51cce106">uLua.ILuaObject</a>.</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>