-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassu_lua_1_1_a_p_i.html
873 lines (819 loc) · 52.9 KB
/
classu_lua_1_1_a_p_i.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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
<!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.API 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_a_p_i.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="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="classu_lua_1_1_a_p_i-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uLua.API Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>This script sets up the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a> framework to your Unity scene.
<a href="classu_lua_1_1_a_p_i.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:a9a290d7efe604d27542efcf1a1222fd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classu_lua_1_1_script_package.html">ScriptPackage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a9a290d7efe604d27542efcf1a1222fd5">GetPackage</a> (string PackageName)</td></tr>
<tr class="memdesc:a9a290d7efe604d27542efcf1a1222fd5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> object for the specified package name. If the package is not found, returns a null value. <a href="classu_lua_1_1_a_p_i.html#a9a290d7efe604d27542efcf1a1222fd5">More...</a><br /></td></tr>
<tr class="separator:a9a290d7efe604d27542efcf1a1222fd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab668f51c44e87ac2ce716f36692845b7"><td class="memItemLeft" align="right" valign="top"><a id="ab668f51c44e87ac2ce716f36692845b7" name="ab668f51c44e87ac2ce716f36692845b7"></a>
int </td><td class="memItemRight" valign="bottom"><b>GetPackageCount</b> ()</td></tr>
<tr class="memdesc:ab668f51c44e87ac2ce716f36692845b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of packages found under the script package path.<br /></td></tr>
<tr class="separator:ab668f51c44e87ac2ce716f36692845b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefa199306a8077a686ee6145a5aaacc8"><td class="memItemLeft" align="right" valign="top"><a id="aefa199306a8077a686ee6145a5aaacc8" name="aefa199306a8077a686ee6145a5aaacc8"></a>
string </td><td class="memItemRight" valign="bottom"><b>GetPackageName</b> (int i)</td></tr>
<tr class="memdesc:aefa199306a8077a686ee6145a5aaacc8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the package at the specified index.<br /></td></tr>
<tr class="separator:aefa199306a8077a686ee6145a5aaacc8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47cb6c6f2a66e7bf2bac42c4c8748d0d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a47cb6c6f2a66e7bf2bac42c4c8748d0d">LoadPackage</a> (string PackageName)</td></tr>
<tr class="memdesc:a47cb6c6f2a66e7bf2bac42c4c8748d0d"><td class="mdescLeft"> </td><td class="mdescRight">Public function used to load a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> on demand. <a href="classu_lua_1_1_a_p_i.html#a47cb6c6f2a66e7bf2bac42c4c8748d0d">More...</a><br /></td></tr>
<tr class="separator:a47cb6c6f2a66e7bf2bac42c4c8748d0d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a87501f08d88b106cb1542f0cafb21153"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a87501f08d88b106cb1542f0cafb21153">ExecuteExternalFile</a> (string File, bool overwriteExisting=false)</td></tr>
<tr class="memdesc:a87501f08d88b106cb1542f0cafb21153"><td class="mdescLeft"> </td><td class="mdescRight">Executes a script from the external directory. <a href="classu_lua_1_1_a_p_i.html#a87501f08d88b106cb1542f0cafb21153">More...</a><br /></td></tr>
<tr class="separator:a87501f08d88b106cb1542f0cafb21153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a544821d2eb95f8a24cf0caa95ec03e67"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a544821d2eb95f8a24cf0caa95ec03e67">ExecuteFile</a> (string File, bool overwriteExisting=false)</td></tr>
<tr class="memdesc:a544821d2eb95f8a24cf0caa95ec03e67"><td class="mdescLeft"> </td><td class="mdescRight">Executes a script from the resource directory. <a href="classu_lua_1_1_a_p_i.html#a544821d2eb95f8a24cf0caa95ec03e67">More...</a><br /></td></tr>
<tr class="separator:a544821d2eb95f8a24cf0caa95ec03e67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad4b6cab0c4aac473d9c42aea6902556"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#aad4b6cab0c4aac473d9c42aea6902556">Expose< T ></a> (T Object, <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> Context=null)</td></tr>
<tr class="memdesc:aad4b6cab0c4aac473d9c42aea6902556"><td class="mdescLeft"> </td><td class="mdescRight">Exposes an object 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_a_p_i.html#aad4b6cab0c4aac473d9c42aea6902556">More...</a><br /></td></tr>
<tr class="separator:aad4b6cab0c4aac473d9c42aea6902556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae85b13a4101bcfca3c7ad3e552d5e7cf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#ae85b13a4101bcfca3c7ad3e552d5e7cf">Invoke</a> (string Event, params object[] args)</td></tr>
<tr class="memdesc:ae85b13a4101bcfca3c7ad3e552d5e7cf"><td class="mdescLeft"> </td><td class="mdescRight">Invokes a game event. <a href="classu_lua_1_1_a_p_i.html#ae85b13a4101bcfca3c7ad3e552d5e7cf">More...</a><br /></td></tr>
<tr class="separator:ae85b13a4101bcfca3c7ad3e552d5e7cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a386b6b9a042dffd6b4c80778a09e3af5"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a386b6b9a042dffd6b4c80778a09e3af5">Log</a> (string String)</td></tr>
<tr class="memdesc:a386b6b9a042dffd6b4c80778a09e3af5"><td class="mdescLeft"> </td><td class="mdescRight">Logs a message to the console. <a href="classu_lua_1_1_a_p_i.html#a386b6b9a042dffd6b4c80778a09e3af5">More...</a><br /></td></tr>
<tr class="separator:a386b6b9a042dffd6b4c80778a09e3af5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada52e258c5bf614c93adeb538ce9b326"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#ada52e258c5bf614c93adeb538ce9b326">LogError</a> (string String)</td></tr>
<tr class="memdesc:ada52e258c5bf614c93adeb538ce9b326"><td class="mdescLeft"> </td><td class="mdescRight">Logs an error to the console. <a href="classu_lua_1_1_a_p_i.html#ada52e258c5bf614c93adeb538ce9b326">More...</a><br /></td></tr>
<tr class="separator:ada52e258c5bf614c93adeb538ce9b326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45b940fac3cc703a6bbf7bacfbc1e911"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a45b940fac3cc703a6bbf7bacfbc1e911">LogWarning</a> (string String)</td></tr>
<tr class="memdesc:a45b940fac3cc703a6bbf7bacfbc1e911"><td class="mdescLeft"> </td><td class="mdescRight">Logs a warning to the console. <a href="classu_lua_1_1_a_p_i.html#a45b940fac3cc703a6bbf7bacfbc1e911">More...</a><br /></td></tr>
<tr class="separator:a45b940fac3cc703a6bbf7bacfbc1e911"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d362a6db6d3e03ce35e85eada11c8bc"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a2d362a6db6d3e03ce35e85eada11c8bc">LoadSavedData</a> (<a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> Object, string Index="SaveData")</td></tr>
<tr class="memdesc:a2d362a6db6d3e03ce35e85eada11c8bc"><td class="mdescLeft"> </td><td class="mdescRight">Loads table data saved for the specified object. <a href="classu_lua_1_1_a_p_i.html#a2d362a6db6d3e03ce35e85eada11c8bc">More...</a><br /></td></tr>
<tr class="separator:a2d362a6db6d3e03ce35e85eada11c8bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa18d35f539e44f72fe61283dbb08c159"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#aa18d35f539e44f72fe61283dbb08c159">RegisterEvent</a> (string Event, string HandlerName="")</td></tr>
<tr class="memdesc:aa18d35f539e44f72fe61283dbb08c159"><td class="mdescLeft"> </td><td class="mdescRight">Registers an event to the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a>. <a href="classu_lua_1_1_a_p_i.html#aa18d35f539e44f72fe61283dbb08c159">More...</a><br /></td></tr>
<tr class="separator:aa18d35f539e44f72fe61283dbb08c159"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea912a7eede5521dbfc09946056152fa"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#aea912a7eede5521dbfc09946056152fa">RegisterEventHandler</a> (string Event, string HandlerName, <a class="el" href="interfaceu_lua_1_1_i_lua_object.html">ILuaObject</a> Context=null)</td></tr>
<tr class="memdesc:aea912a7eede5521dbfc09946056152fa"><td class="mdescLeft"> </td><td class="mdescRight">Registers an event handler to be called when an event is invoked. <a href="classu_lua_1_1_a_p_i.html#aea912a7eede5521dbfc09946056152fa">More...</a><br /></td></tr>
<tr class="separator:aea912a7eede5521dbfc09946056152fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a899d6736b13d0ec1494a77d71d2b070f"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a899d6736b13d0ec1494a77d71d2b070f">RemoveEventHandlers</a> (<a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> Context)</td></tr>
<tr class="memdesc:a899d6736b13d0ec1494a77d71d2b070f"><td class="mdescLeft"> </td><td class="mdescRight">Removes all event handlers registered in a specific context. <a href="classu_lua_1_1_a_p_i.html#a899d6736b13d0ec1494a77d71d2b070f">More...</a><br /></td></tr>
<tr class="separator:a899d6736b13d0ec1494a77d71d2b070f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4318d5c5f3e852eeb62909a68995379a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a4318d5c5f3e852eeb62909a68995379a">RegisterIndexedType</a> (Type Type)</td></tr>
<tr class="memdesc:a4318d5c5f3e852eeb62909a68995379a"><td class="mdescLeft"> </td><td class="mdescRight">Registers a type that implements the <a class="el" href="interfaceu_lua_1_1_i_lua_object.html" title="Interface used to implement a fully indexed Lua object.">ILuaObject</a> interface 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_a_p_i.html#a4318d5c5f3e852eeb62909a68995379a">More...</a><br /></td></tr>
<tr class="separator:a4318d5c5f3e852eeb62909a68995379a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cb9775ed28e5b25e1754f0424669425"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a5cb9775ed28e5b25e1754f0424669425">RegisterType< T ></a> ()</td></tr>
<tr class="memdesc:a5cb9775ed28e5b25e1754f0424669425"><td class="mdescLeft"> </td><td class="mdescRight">Registers a type 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_a_p_i.html#a5cb9775ed28e5b25e1754f0424669425">More...</a><br /></td></tr>
<tr class="separator:a5cb9775ed28e5b25e1754f0424669425"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4feae7dfb393e8a11f907a96c25ef14b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a4feae7dfb393e8a11f907a96c25ef14b">SaveData</a> (<a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> Object, string Index="SaveData")</td></tr>
<tr class="memdesc:a4feae7dfb393e8a11f907a96c25ef14b"><td class="mdescLeft"> </td><td class="mdescRight">Saves table data from the specified object. <a href="classu_lua_1_1_a_p_i.html#a4feae7dfb393e8a11f907a96c25ef14b">More...</a><br /></td></tr>
<tr class="separator:a4feae7dfb393e8a11f907a96c25ef14b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1415bce6f73803285209c2063763d766"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_a_p_i.html#a1415bce6f73803285209c2063763d766">TryRegisterEventHandler</a> (string HandlerName, <a class="el" href="interfaceu_lua_1_1_i_lua_object.html">ILuaObject</a> Context=null)</td></tr>
<tr class="memdesc:a1415bce6f73803285209c2063763d766"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to register an event handler for a registered event. <a href="classu_lua_1_1_a_p_i.html#a1415bce6f73803285209c2063763d766">More...</a><br /></td></tr>
<tr class="separator:a1415bce6f73803285209c2063763d766"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7bb50177d7009eae7f2a8d5c9d0046db"><td class="memItemLeft" align="right" valign="top"><a id="a7bb50177d7009eae7f2a8d5c9d0046db" name="a7bb50177d7009eae7f2a8d5c9d0046db"></a>
static string </td><td class="memItemRight" valign="bottom"><b>ExternalDirectory</b> = ""</td></tr>
<tr class="memdesc:a7bb50177d7009eae7f2a8d5c9d0046db"><td class="mdescLeft"> </td><td class="mdescRight">Directory for external <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> scripts. The path is determined at run-time.<br /></td></tr>
<tr class="separator:a7bb50177d7009eae7f2a8d5c9d0046db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae11ac18faabb9320023906bd440fdae3"><td class="memItemLeft" align="right" valign="top"><a id="ae11ac18faabb9320023906bd440fdae3" name="ae11ac18faabb9320023906bd440fdae3"></a>
static string </td><td class="memItemRight" valign="bottom"><b>SaveDataPath</b> = ""</td></tr>
<tr class="memdesc:ae11ac18faabb9320023906bd440fdae3"><td class="mdescLeft"> </td><td class="mdescRight">Path for user save data under the external directory.<br /></td></tr>
<tr class="separator:ae11ac18faabb9320023906bd440fdae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae08300a8963e9eab17ab4ab2ba7d539f"><td class="memItemLeft" align="right" valign="top"><a id="ae08300a8963e9eab17ab4ab2ba7d539f" name="ae08300a8963e9eab17ab4ab2ba7d539f"></a>
static string </td><td class="memItemRight" valign="bottom"><b>ScriptsPath</b> = ""</td></tr>
<tr class="memdesc:ae08300a8963e9eab17ab4ab2ba7d539f"><td class="mdescLeft"> </td><td class="mdescRight">Path for user scripts under the external directory.<br /></td></tr>
<tr class="separator:ae08300a8963e9eab17ab4ab2ba7d539f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff2e6940038c510f8569a9ccef6801ab"><td class="memItemLeft" align="right" valign="top"><a id="aff2e6940038c510f8569a9ccef6801ab" name="aff2e6940038c510f8569a9ccef6801ab"></a>
static string </td><td class="memItemRight" valign="bottom"><b>MainResourcesFolder</b> = ""</td></tr>
<tr class="memdesc:aff2e6940038c510f8569a9ccef6801ab"><td class="mdescLeft"> </td><td class="mdescRight">Path to the main resources folder for scripts. Used by the VS Code debugger to find the <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> scripts.<br /></td></tr>
<tr class="separator:aff2e6940038c510f8569a9ccef6801ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0984986207083c324a1cd62f354ee0fd"><td class="memItemLeft" align="right" valign="top"><a id="a0984986207083c324a1cd62f354ee0fd" name="a0984986207083c324a1cd62f354ee0fd"></a>
static string </td><td class="memItemRight" valign="bottom"><b>ScriptPackagesPath</b> = ""</td></tr>
<tr class="memdesc:a0984986207083c324a1cd62f354ee0fd"><td class="mdescLeft"> </td><td class="mdescRight">Path for script packages under the external directory.<br /></td></tr>
<tr class="separator:a0984986207083c324a1cd62f354ee0fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ca842887a9a8735030c7ec2c7696cdf"><td class="memItemLeft" align="right" valign="top"><a id="a9ca842887a9a8735030c7ec2c7696cdf" name="a9ca842887a9a8735030c7ec2c7696cdf"></a>
static string </td><td class="memItemRight" valign="bottom"><b>LuaScriptsExtension</b> = ""</td></tr>
<tr class="memdesc:a9ca842887a9a8735030c7ec2c7696cdf"><td class="mdescLeft"> </td><td class="mdescRight">File extension for all external <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> scripts.<br /></td></tr>
<tr class="separator:a9ca842887a9a8735030c7ec2c7696cdf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >This script sets up the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a> framework to your Unity scene.</p>
<p >Includes methods to execute <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> scripts, expose game objects to the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a>, and invoke events. Inherits from MonoBehaviour. Intended use is to add to an object in the scene and set up for use.</p>
<p >This script invokes the <code>SceneLoaded</code> event when the scene is loaded. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a87501f08d88b106cb1542f0cafb21153" name="a87501f08d88b106cb1542f0cafb21153"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87501f08d88b106cb1542f0cafb21153">◆ </a></span>ExecuteExternalFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool uLua.API.ExecuteExternalFile </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>File</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>overwriteExisting</em> = <code>false</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a script from the external directory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">File</td><td>The <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> file to execute. The file extension must be omitted. </td></tr>
<tr><td class="paramname">overwriteExisting</td><td>(Optional) If true, the method will overwrite any previous script with the same filename. Otherwise, any previous script will be called from a hash table. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a544821d2eb95f8a24cf0caa95ec03e67" name="a544821d2eb95f8a24cf0caa95ec03e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a544821d2eb95f8a24cf0caa95ec03e67">◆ </a></span>ExecuteFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool uLua.API.ExecuteFile </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>File</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>overwriteExisting</em> = <code>false</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a script from the resource directory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">File</td><td>The <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> file to execute. The file extension must be omitted. </td></tr>
<tr><td class="paramname">overwriteExisting</td><td>(Optional) If true, the method will overwrite any previous script with the same filename. Otherwise, any previous script will be called from a hash table. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aad4b6cab0c4aac473d9c42aea6902556" name="aad4b6cab0c4aac473d9c42aea6902556"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad4b6cab0c4aac473d9c42aea6902556">◆ </a></span>Expose< T >()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.Expose< T > </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>Object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td>
<td class="paramname"><em>Context</em> = <code>null</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Exposes an object 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 >Called internally by <a class="el" href="classu_lua_1_1_exposed_mono_behaviour.html#a83a0836c5fdc604aa665c92af3e67da3" title="Exposes the game object to Lua if ExposeOn is set to 'Start'.">uLua.ExposedMonoBehaviour.Start()</a>. Can be called manually at an earlier point or for objects which have <code>ExposeOnStart</code> disabled. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Object</td><td>The object to 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>. The generic type <code>T</code> must implement the <a class="el" href="interfaceu_lua_1_1_i_lua_object.html" title="Interface used to implement a fully indexed Lua object.">ILuaObject</a> interface. </td></tr>
<tr><td class="paramname">Context</td><td>The <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a> context of the object. If null, the object will be exposed as a global. </td></tr>
</table>
</dd>
</dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>class</em></td><td> </td></tr>
<tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>ILuaObject</em></td><td> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<a id="a9a290d7efe604d27542efcf1a1222fd5" name="a9a290d7efe604d27542efcf1a1222fd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a290d7efe604d27542efcf1a1222fd5">◆ </a></span>GetPackage()</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_script_package.html">ScriptPackage</a> uLua.API.GetPackage </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>PackageName</em></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>Returns the <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> object for the specified package name. If the package is not found, returns a null value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PackageName</td><td>The name of the package. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae85b13a4101bcfca3c7ad3e552d5e7cf" name="ae85b13a4101bcfca3c7ad3e552d5e7cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae85b13a4101bcfca3c7ad3e552d5e7cf">◆ </a></span>Invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.Invoke </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>Event</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invokes a game event.</p>
<p >This method 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> as a global and may be called from 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 or within C#. <a class="el" href="classu_lua_1_1_events.html" title="Static container class for registered events.">Events</a> should registered AFTER Unity's Awake call to prevent unexpected behaviour (e.g. on Unity's scene loaded or start events). <a class="el" href="classu_lua_1_1_events.html" title="Static container class for registered events.">Events</a> may also be registered 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> by overriding <a class="el" href="classu_lua_1_1_exposed_mono_behaviour.html#a81c110fb30bdfb8170934ec49ed8085c" title="Scriptable method called when an object is exposed to Lua.">uLua.ExposedMonoBehaviour.OnExpose()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Event</td><td>The name of the event to be invoked. </td></tr>
<tr><td class="paramname">args</td><td>(Optional) Parameters for the event handler. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a47cb6c6f2a66e7bf2bac42c4c8748d0d" name="a47cb6c6f2a66e7bf2bac42c4c8748d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47cb6c6f2a66e7bf2bac42c4c8748d0d">◆ </a></span>LoadPackage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool uLua.API.LoadPackage </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>PackageName</em></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 function used to load a <a class="el" href="classu_lua_1_1_script_package.html" title="A class to describe Lua packages.">ScriptPackage</a> on demand.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PackageName</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> to be loaded. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2d362a6db6d3e03ce35e85eada11c8bc" name="a2d362a6db6d3e03ce35e85eada11c8bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d362a6db6d3e03ce35e85eada11c8bc">◆ </a></span>LoadSavedData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.LoadSavedData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td>
<td class="paramname"><em>Object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>Index</em> = <code>"SaveData"</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads table data saved for the specified object.</p>
<p >Saved data will be loaded from the <code>SaveDataPath</code> under the external directory. This method 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> as a global and may be called from 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 or within C#. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Object</td><td>The object of which the saved data will be loaded. </td></tr>
<tr><td class="paramname">Index</td><td>(Optional) The index of <code>Object</code> which contains the table data to be saved. Default value is "SaveData". </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a386b6b9a042dffd6b4c80778a09e3af5" name="a386b6b9a042dffd6b4c80778a09e3af5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a386b6b9a042dffd6b4c80778a09e3af5">◆ </a></span>Log()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.Log </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>String</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message to the console.</p>
<p >Invokes the event 'LuaMessageLogged' which may be handled in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. This method 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> as a global and may be called from 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 or within C#. </p>
</div>
</div>
<a id="ada52e258c5bf614c93adeb538ce9b326" name="ada52e258c5bf614c93adeb538ce9b326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada52e258c5bf614c93adeb538ce9b326">◆ </a></span>LogError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.LogError </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>String</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs an error to the console.</p>
<p >Invokes the event 'LuaErrorLogged' which may be handled in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. This method 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> as a global and may be called from 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 or within C#. </p>
</div>
</div>
<a id="a45b940fac3cc703a6bbf7bacfbc1e911" name="a45b940fac3cc703a6bbf7bacfbc1e911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45b940fac3cc703a6bbf7bacfbc1e911">◆ </a></span>LogWarning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.LogWarning </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>String</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a warning to the console.</p>
<p >Invokes the event 'LuaWarningLogged' which may be handled in <a class="el" href="classu_lua_1_1_lua.html" title="Wrapper class which streamlines use of the MoonSharp Lua context.">Lua</a>. This method 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> as a global and may be called from 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 or within C#. </p>
</div>
</div>
<a id="aa18d35f539e44f72fe61283dbb08c159" name="aa18d35f539e44f72fe61283dbb08c159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa18d35f539e44f72fe61283dbb08c159">◆ </a></span>RegisterEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.RegisterEvent </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>Event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>HandlerName</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers an event to the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a>.</p>
<p ><a class="el" href="classu_lua_1_1_events.html" title="Static container class for registered events.">Events</a> should registered AFTER Unity's Awake call to prevent unexpected behaviour (e.g. on Unity's scene loaded or start events). <a class="el" href="classu_lua_1_1_events.html" title="Static container class for registered events.">Events</a> may also be registered 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> by overriding <a class="el" href="classu_lua_1_1_exposed_mono_behaviour.html#a81c110fb30bdfb8170934ec49ed8085c" title="Scriptable method called when an object is exposed to Lua.">uLua.ExposedMonoBehaviour.OnExpose()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Event</td><td>The name of the event to be registered. </td></tr>
<tr><td class="paramname">HandlerName</td><td>(Optional) The name of the event handler function. Defaults to 'On{Event}', e.g. the default even thandler for an event named 'LoadingFinished' would be 'OnLoadingFinished', </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aea912a7eede5521dbfc09946056152fa" name="aea912a7eede5521dbfc09946056152fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea912a7eede5521dbfc09946056152fa">◆ </a></span>RegisterEventHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool uLua.API.RegisterEventHandler </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>Event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>HandlerName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interfaceu_lua_1_1_i_lua_object.html">ILuaObject</a> </td>
<td class="paramname"><em>Context</em> = <code>null</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers an event handler to be called when an event is invoked.</p>
<p >This method 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> as a global and may be called from 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 or within C#. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Event</td><td>The name of the event. </td></tr>
<tr><td class="paramname">HandlerName</td><td>The name of the event handler function. </td></tr>
<tr><td class="paramname">Context</td><td>(Optional) The object that contains the event handler implementation. If not specified, the event handler will be global. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4318d5c5f3e852eeb62909a68995379a" name="a4318d5c5f3e852eeb62909a68995379a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4318d5c5f3e852eeb62909a68995379a">◆ </a></span>RegisterIndexedType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.RegisterIndexedType </td>
<td>(</td>
<td class="paramtype">Type </td>
<td class="paramname"><em>Type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a type that implements the <a class="el" href="interfaceu_lua_1_1_i_lua_object.html" title="Interface used to implement a fully indexed Lua object.">ILuaObject</a> interface 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 >Intended for use with <a class="el" href="classu_lua_1_1_lua_mono_behaviour.html" title="MonoBehaviour script which establishes a Lua object framework. For internal use.">LuaMonoBehaviour</a> and <a class="el" href="classu_lua_1_1_lua_class.html" title="Class structure which establishes a Lua object framework. For internal use.">LuaClass</a>. </p>
</div>
</div>
<a id="a5cb9775ed28e5b25e1754f0424669425" name="a5cb9775ed28e5b25e1754f0424669425"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cb9775ed28e5b25e1754f0424669425">◆ </a></span>RegisterType< T >()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.RegisterType< T > </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a type 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 >Any C# or Unity type may be registered to use within the <a class="el" href="classu_lua_1_1_a_p_i.html" title="This script sets up the API framework to your Unity scene.">API</a>. Use with caution. </p>
</div>
</div>
<a id="a899d6736b13d0ec1494a77d71d2b070f" name="a899d6736b13d0ec1494a77d71d2b070f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a899d6736b13d0ec1494a77d71d2b070f">◆ </a></span>RemoveEventHandlers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.RemoveEventHandlers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td>
<td class="paramname"><em>Context</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all event handlers registered in a specific context.</p>
<p >This method 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> as a global and may be called from 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 or within C#. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Context</td><td>The object that contains the event handler implementation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4feae7dfb393e8a11f907a96c25ef14b" name="a4feae7dfb393e8a11f907a96c25ef14b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4feae7dfb393e8a11f907a96c25ef14b">◆ </a></span>SaveData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void uLua.API.SaveData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classu_lua_1_1_lua_mono_behaviour.html">LuaMonoBehaviour</a> </td>
<td class="paramname"><em>Object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>Index</em> = <code>"SaveData"</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves table data from the specified object.</p>
<p >Data will be saved to the <code>SaveDataPath</code> under the external directory. This method 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> as a global and may be called from 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 or within C#. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Object</td><td>The object for which the data will be saved. </td></tr>
<tr><td class="paramname">Index</td><td>(Optional) The index of <code>Object</code> which contains the table data to be saved. Default value is "SaveData". </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1415bce6f73803285209c2063763d766" name="a1415bce6f73803285209c2063763d766"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1415bce6f73803285209c2063763d766">◆ </a></span>TryRegisterEventHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool uLua.API.TryRegisterEventHandler </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>HandlerName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interfaceu_lua_1_1_i_lua_object.html">ILuaObject</a> </td>
<td class="paramname"><em>Context</em> = <code>null</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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to register an event handler for a registered event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">HandlerName</td><td>The name of the event handler function. If a matching registered event is not found, this function has no effect. </td></tr>
<tr><td class="paramname">(Optional)</td><td>Context The object that contains the event handler implementation. If not specified, the event handler will be global. </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_a_p_i.html">API</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>