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
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Crazy Eddies GUI System: CEGUI::LuaScriptModule Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1LuaScriptModule.html">LuaScriptModule</a> </li>
</ul>
</div>
</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> </div>
<div class="headertitle">
<div class="title">CEGUI::LuaScriptModule Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::LuaScriptModule" --><!-- doxytag: inherits="CEGUI::ScriptModule" -->
<p>Interface for the <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> class.
<a href="classCEGUI_1_1LuaScriptModule.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::LuaScriptModule:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1LuaScriptModule__inherit__graph.gif" border="0" usemap="#CEGUI_1_1LuaScriptModule_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1LuaScriptModule_inherit__map" id="CEGUI_1_1LuaScriptModule_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system..." alt="" coords="16,5,165,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::LuaScriptModule:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1LuaScriptModule__coll__graph.gif" border="0" usemap="#CEGUI_1_1LuaScriptModule_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1LuaScriptModule_coll__map" id="CEGUI_1_1LuaScriptModule_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system..." alt="" coords="180,120,329,149"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="40,5,147,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1LuaScriptModule-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a0d148c9c80c6ad2430a9b4b38413f0d3">executeScriptFile</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a script file. <a href="#a0d148c9c80c6ad2430a9b4b38413f0d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ad861002c262f2a12afc3bd55371bba3b">executeScriptFile</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a script file. <a href="#ad861002c262f2a12afc3bd55371bba3b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a1c5ada909d7a0fff376cbe5a73477d37">executeScriptFile</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a script file. <a href="#a1c5ada909d7a0fff376cbe5a73477d37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#aebb2d7687a17798865d61455ec57d4d2">executeScriptGlobal</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &function_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global function. The function should not take any parameters and should return an integer. <a href="#aebb2d7687a17798865d61455ec57d4d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ac28f65478ac7db73136057c10b92bda7">executeScriptGlobal</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &function_name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global function. The function should not take any parameters and should return an integer. <a href="#ac28f65478ac7db73136057c10b92bda7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a7a1a04fef47ab33d78173ae1daf21453">executeScriptGlobal</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &function_name, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global function. The function should not take any parameters and should return an integer. <a href="#a7a1a04fef47ab33d78173ae1daf21453"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a15ef444b531d4271e718141ad3c90875">executeScriptedEventHandler</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &handler_name, const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global 'event handler' function by looking it up by name. <a href="#a15ef444b531d4271e718141ad3c90875"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a459d123f68ec691b15f41c31d35ea2e8">executeScriptedEventHandler</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &handler_name, const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global 'event handler' function by looking it up by name. <a href="#a459d123f68ec691b15f41c31d35ea2e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#add462383d2681ad12915da1733b3c32a">executeScriptedEventHandler</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &handler_name, const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global 'event handler' function by looking it up by name. <a href="#add462383d2681ad12915da1733b3c32a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a577a94fd7107ce1ab448acefb3264ffd">executeString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. <a href="#a577a94fd7107ce1ab448acefb3264ffd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a4a5a29d249a1d515ff82e422a58fdd3f">executeString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. <a href="#a4a5a29d249a1d515ff82e422a58fdd3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ae8e7ef4aa622ecde293a6a5dde45c732">executeString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. <a href="#ae8e7ef4aa622ecde293a6a5dde45c732"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ae8d5843adcac3d47e0d2bf409e7e28e6">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#ae8d5843adcac3d47e0d2bf409e7e28e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#afc6e73172e5b59a96ac969a226ae3512">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#afc6e73172e5b59a96ac969a226ae3512"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a813c39387006b755bc29a141f9ed6e66">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a813c39387006b755bc29a141f9ed6e66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a4ab1ae222fc74d03365e8c0f4294f0b3">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a4ab1ae222fc74d03365e8c0f4294f0b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#aff718647b25978aae2074bc5b0b106a8">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#aff718647b25978aae2074bc5b0b106a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a55b723a9eceedc35546bbab73c5efeb0">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name, const int error_handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a55b723a9eceedc35546bbab73c5efeb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a99ac7c0fc292ad37d39afd7a02f1f625">createBindings</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method called during system initialisation, prior to running any scripts via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to complete initialisation or binding of the script language to the gui system objects. <a href="#a99ac7c0fc292ad37d39afd7a02f1f625"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ac008f0590a39c9508291f5258f2d3508">destroyBindings</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method called during system destruction, after all scripts have been run via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. <a href="#ac008f0590a39c9508291f5258f2d3508"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">lua_State * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a93e8062c0fdc3ef98d7b3331e6c48f8d">getLuaState</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method used to get a pointer to the lua_State that the script module is attached to. <a href="#a93e8062c0fdc3ef98d7b3331e6c48f8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#afd7969f6a3ac570c183fb584305a95d2">setDefaultPCallErrorHandler</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &error_handler_function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the lua function that will be passed as the error handler in calls to lua_pcall, unless an alternative is specified in some other function call. <a href="#afd7969f6a3ac570c183fb584305a95d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a56d3c577ef11a92e7bb19dc30d0c1c46">setDefaultPCallErrorHandler</a> (int function_reference)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function that will be passed as the error handler in calls to lua_pcall, unless an alternative is specified in some other function call. <a href="#a56d3c577ef11a92e7bb19dc30d0c1c46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ad61c45b0fc56cc958cf02dd12547e114">getActivePCallErrorHandlerString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the function name string of the active error handler function. <a href="#ad61c45b0fc56cc958cf02dd12547e114"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#af4af26a88bad20ae41f04ac97c70fc57">getActivePCallErrorHandlerReference</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the lua registry index of the active error handler function. <a href="#af4af26a88bad20ae41f04ac97c70fc57"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1LuaScriptModule.html">LuaScriptModule</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#a388385d9f5b31d3c99cd4028bd7cbd9f">create</a> (lua_State *state=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> object. <a href="#a388385d9f5b31d3c99cd4028bd7cbd9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab29c466d6b04efdfa12e6c9b708d084b"></a><!-- doxytag: member="CEGUI::LuaScriptModule::destroy" ref="ab29c466d6b04efdfa12e6c9b708d084b" args="(LuaScriptModule &mod)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LuaScriptModule.html#ab29c466d6b04efdfa12e6c9b708d084b">destroy</a> (<a class="el" href="classCEGUI_1_1LuaScriptModule.html">LuaScriptModule</a> &mod)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the given <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> object. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for the <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a388385d9f5b31d3c99cd4028bd7cbd9f"></a><!-- doxytag: member="CEGUI::LuaScriptModule::create" ref="a388385d9f5b31d3c99cd4028bd7cbd9f" args="(lua_State *state=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1LuaScriptModule.html">LuaScriptModule</a>& CEGUI::LuaScriptModule::create </td>
<td>(</td>
<td class="paramtype">lua_State * </td>
<td class="paramname"><em>state</em> = <code>0</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>Pointer to the lua_State that the script module should attach to, if this is 0 a lua_State will be created. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a99ac7c0fc292ad37d39afd7a02f1f625"></a><!-- doxytag: member="CEGUI::LuaScriptModule::createBindings" ref="a99ac7c0fc292ad37d39afd7a02f1f625" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::createBindings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method called during system initialisation, prior to running any scripts via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to complete initialisation or binding of the script language to the gui system objects. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ScriptModule.html#a2e860178e3b661bc9f3fadfa11862bc4">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="ac008f0590a39c9508291f5258f2d3508"></a><!-- doxytag: member="CEGUI::LuaScriptModule::destroyBindings" ref="ac008f0590a39c9508291f5258f2d3508" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::destroyBindings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method called during system destruction, after all scripts have been run via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ScriptModule.html#ad96fa1199a2cbc545aa2b31db53149ce">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a15ef444b531d4271e718141ad3c90875"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptedEventHandler" ref="a15ef444b531d4271e718141ad3c90875" args="(const String &handler_name, const EventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::LuaScriptModule::executeScriptedEventHandler </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>handler_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> & </td>
<td class="paramname"><em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global 'event handler' function by looking it up by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handler_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the scripted handler function. If this string contains dots '.' it will be parsed as tables containing a function field. For example: 'mytable.subtable.func'</td></tr>
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object that should be passed, by any appropriate means, to the scripted function.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the event was handled.</li>
<li>false if the event was not handled. </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#a8d4b606d34851972ec06d220f9ed4b02">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a459d123f68ec691b15f41c31d35ea2e8"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptedEventHandler" ref="a459d123f68ec691b15f41c31d35ea2e8" args="(const String &handler_name, const EventArgs &e, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::LuaScriptModule::executeScriptedEventHandler </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>handler_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> & </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global 'event handler' function by looking it up by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handler_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the scripted handler function. If this string contains dots '.' it will be parsed as tables containing a function field. For example: 'mytable.subtable.func'</td></tr>
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object that should be passed, by any appropriate means, to the scripted function.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the event was handled.</li>
<li>false if the event was not handled. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="add462383d2681ad12915da1733b3c32a"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptedEventHandler" ref="add462383d2681ad12915da1733b3c32a" args="(const String &handler_name, const EventArgs &e, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::LuaScriptModule::executeScriptedEventHandler </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>handler_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> & </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global 'event handler' function by looking it up by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handler_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the scripted handler function. If this string contains dots '.' it will be parsed as tables containing a function field. For example: 'mytable.subtable.func'</td></tr>
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object that should be passed, by any appropriate means, to the scripted function.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the event was handled.</li>
<li>false if the event was not handled. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ad861002c262f2a12afc3bd55371bba3b"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptFile" ref="ad861002c262f2a12afc3bd55371bba3b" args="(const String &filename, const String &resourceGroup, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeScriptFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a script file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the filename of the script file that is to be executed.</td></tr>
<tr><td class="paramname">resourceGroup</td><td>Resource group idendifier to be passed to the <a class="el" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a> when loading the script file.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1c5ada909d7a0fff376cbe5a73477d37"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptFile" ref="a1c5ada909d7a0fff376cbe5a73477d37" args="(const String &filename, const String &resourceGroup, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeScriptFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a script file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the filename of the script file that is to be executed.</td></tr>
<tr><td class="paramname">resourceGroup</td><td>Resource group idendifier to be passed to the <a class="el" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a> when loading the script file.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0d148c9c80c6ad2430a9b4b38413f0d3"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptFile" ref="a0d148c9c80c6ad2430a9b4b38413f0d3" args="(const String &filename, const String &resourceGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeScriptFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a script file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the filename of the script file that is to be executed.</td></tr>
<tr><td class="paramname">resourceGroup</td><td>Resource group idendifier to be passed to the <a class="el" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a> when loading the script file. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#aec4f69dc1e7426941db9d2e5e5e41f5b">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a7a1a04fef47ab33d78173ae1daf21453"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptGlobal" ref="a7a1a04fef47ab33d78173ae1daf21453" args="(const String &function_name, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::LuaScriptModule::executeScriptGlobal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>function_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global function. The function should not take any parameters and should return an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">function_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the function, in the global script environment, that is to be executed.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The integer value returned from the script function. </dd></dl>
</div>
</div>
<a class="anchor" id="aebb2d7687a17798865d61455ec57d4d2"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptGlobal" ref="aebb2d7687a17798865d61455ec57d4d2" args="(const String &function_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::LuaScriptModule::executeScriptGlobal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>function_name</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global function. The function should not take any parameters and should return an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">function_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the function, in the global script environment, that is to be executed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The integer value returned from the script function. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#a483fc3776f5c6254bd05c9a6fc64f292">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="ac28f65478ac7db73136057c10b92bda7"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeScriptGlobal" ref="ac28f65478ac7db73136057c10b92bda7" args="(const String &function_name, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::LuaScriptModule::executeScriptGlobal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>function_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global function. The function should not take any parameters and should return an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">function_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the function, in the global script environment, that is to be executed.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The integer value returned from the script function. </dd></dl>
</div>
</div>
<a class="anchor" id="a577a94fd7107ce1ab448acefb3264ffd"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeString" ref="a577a94fd7107ce1ab448acefb3264ffd" args="(const String &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the valid script code that should be executed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#aedf7d59b6471974724c70d6d875e8f53">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a4a5a29d249a1d515ff82e422a58fdd3f"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeString" ref="a4a5a29d249a1d515ff82e422a58fdd3f" args="(const String &str, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the valid script code that should be executed.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8e7ef4aa622ecde293a6a5dde45c732"></a><!-- doxytag: member="CEGUI::LuaScriptModule::executeString" ref="ae8e7ef4aa622ecde293a6a5dde45c732" args="(const String &str, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::executeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the valid script code that should be executed.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="af4af26a88bad20ae41f04ac97c70fc57"></a><!-- doxytag: member="CEGUI::LuaScriptModule::getActivePCallErrorHandlerReference" ref="af4af26a88bad20ae41f04ac97c70fc57" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::LuaScriptModule::getActivePCallErrorHandlerReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the lua registry index of the active error handler function. </p>
<p>The 'active' error handler for the <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> is either the default as specified by calling setDefaultPCallErrorHandler, or whatever might have been set up by a call to the internal initErrorHandlerFunc function. </p>
<dl class="user"><dt><b>This may return a value previously set by the user, or the value as</b></dt><dd>bound internally by the script module for an error handler specified by function name.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This function is really intended for use internally by other parts of the lua scripting support. Although it could be useful elsewhere for advanced uses, so long as you're careful!</dd></dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>You should never call luaL_unref on the value returned by this function unless you created tge reference in the first place, and even then only after having called setDefaultPCallErrorHandler passing LUA_NOREF. </dd></dl>
</div>
</div>
<a class="anchor" id="ad61c45b0fc56cc958cf02dd12547e114"></a><!-- doxytag: member="CEGUI::LuaScriptModule::getActivePCallErrorHandlerString" ref="ad61c45b0fc56cc958cf02dd12547e114" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::LuaScriptModule::getActivePCallErrorHandlerString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the function name string of the active error handler function. </p>
<p>The 'active' error handler for the <a class="el" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class.">LuaScriptModule</a> is either the default as specified by calling setDefaultPCallErrorHandler, or whatever might have been set up by a call to the internal initErrorHandlerFunc function.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function is really intended for use internally by other parts of the lua scripting support. Although it could be useful elsewhere for advanced uses, so long as you're careful! </dd></dl>
</div>
</div>
<a class="anchor" id="a93e8062c0fdc3ef98d7b3331e6c48f8d"></a><!-- doxytag: member="CEGUI::LuaScriptModule::getLuaState" ref="a93e8062c0fdc3ef98d7b3331e6c48f8d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lua_State* CEGUI::LuaScriptModule::getLuaState </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method used to get a pointer to the lua_State that the script module is attached to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the lua_State that the script module is attached to. </dd></dl>
</div>
</div>
<a class="anchor" id="afd7969f6a3ac570c183fb584305a95d2"></a><!-- doxytag: member="CEGUI::LuaScriptModule::setDefaultPCallErrorHandler" ref="afd7969f6a3ac570c183fb584305a95d2" args="(const String &error_handler_function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::setDefaultPCallErrorHandler </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler_function</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the lua function that will be passed as the error handler in calls to lua_pcall, unless an alternative is specified in some other function call. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error_handler_function</td><td>Name of the lua function to be called. This is looked up / bound on first usage. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a56d3c577ef11a92e7bb19dc30d0c1c46"></a><!-- doxytag: member="CEGUI::LuaScriptModule::setDefaultPCallErrorHandler" ref="a56d3c577ef11a92e7bb19dc30d0c1c46" args="(int function_reference)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LuaScriptModule::setDefaultPCallErrorHandler </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>function_reference</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the function that will be passed as the error handler in calls to lua_pcall, unless an alternative is specified in some other function call. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">function_reference</td><td>Lua function registry index of the function to be called. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a813c39387006b755bc29a141f9ed6e66"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="a813c39387006b755bc29a141f9ed6e66" args="(EventSet *target, const String &name, const String &subscriber_name, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8d5843adcac3d47e0d2bf409e7e28e6"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="ae8d5843adcac3d47e0d2bf409e7e28e6" args="(EventSet *target, const String &name, const String &subscriber_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#af5ff0f0e6cdcb47c0a704447cc6d7726">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="aff718647b25978aae2074bc5b0b106a8"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="aff718647b25978aae2074bc5b0b106a8" args="(EventSet *target, const String &name, Event::Group group, const String &subscriber_name, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a4ab1ae222fc74d03365e8c0f4294f0b3"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="a4ab1ae222fc74d03365e8c0f4294f0b3" args="(EventSet *target, const String &name, Event::Group group, const String &subscriber_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScriptModule.html#a0d787a8c552d7a22a2619cff95c2eccc">CEGUI::ScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="afc6e73172e5b59a96ac969a226ae3512"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="afc6e73172e5b59a96ac969a226ae3512" args="(EventSet *target, const String &name, const String &subscriber_name, const String &error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
<tr><td class="paramname">error_handler</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the script fuction that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a55b723a9eceedc35546bbab73c5efeb0"></a><!-- doxytag: member="CEGUI::LuaScriptModule::subscribeEvent" ref="a55b723a9eceedc35546bbab73c5efeb0" args="(EventSet *target, const String &name, Event::Group group, const String &subscriber_name, const int error_handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::LuaScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>error_handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
<tr><td class="paramname">error_handler</td><td>integer value describing a lua registry reference to the function that will be called if an error occurs while executing the handler function. NB: This is the function passed as the error handler to lua_pcall.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
