-
Notifications
You must be signed in to change notification settings - Fork 0
/
lua.xml
5260 lines (4703 loc) · 215 KB
/
lua.xml
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
<?xml version="1.0" encoding="Windows-1252" ?>
<NotepadPlus>
<Environment ignoreCase="yes" paramSeparator="," terminal=";" additionalWordChar = ".:"/>
<AutoComplete language="LUA">
<KeyWord name="and" func="no" />
<KeyWord name="assert" func="yes">
<Overload retVal="void" descr="
Issues an error when the value of its argument v is false (i.e., nil or false);
otherwise, returns all its arguments. message is an error message; when absent, it
defaults to 'assertion failed!'">
<Param name="Bool:v"/>
<Param name="String:[message]"/>
</Overload>
</KeyWord>
<KeyWord name="break" func="no" />
<KeyWord name="collectgarbage" func="yes">
<Overload retVal="void" descr="This function is a generic interface to the garbage collector.
It performs different functions according to its first argument, opt:
* 'stop': stops the garbage collector.
* 'restart': restarts the garbage collector.
* 'collect': performs a full garbage-collection cycle.
* 'count': returns the total memory in use by Lua (in Kbytes).
* 'step': performs a garbage-collection step. The step 'size' is controlled by arg
(larger values mean more steps) in a non-specified way. If you want to control
the step size you must experimentally tune the value of arg. Returns true if
the step finished a collection cycle.
* 'setpause': sets arg as the new value for the pause of the collector (see §2.10).
Returns the previous value for pause.
* 'setstepmul': sets arg as the new value for the step multiplier of the collector
(see §2.10). Returns the previous value for step.
">
<Param name="String:opt"/>
<Param name="[arg]"/>
</Overload>
</KeyWord>
<KeyWord name="coroutine.create" func="yes">
<Overload retVal="void" descr="
Creates a new coroutine, with body f. f must be a Lua function. Returns this new
coroutine, an object with type 'thread'.
">
<Param name="Function:f" />
</Overload>
</KeyWord>
<KeyWord name="coroutine.resume" func="yes">
<Overload retVal="void" descr="
Starts or continues the execution of coroutine co. The first time you resume a
coroutine, it starts running its body. The values val1, ··· are passed as the
arguments to the body function. If the coroutine has yielded, resume restarts it; the
values val1, ··· are passed as the results from the yield.
If the coroutine runs without any errors, resume returns true plus any values passed
to yield (if the coroutine yields) or any values returned by the body function (if the
coroutine terminates). If there is any error, resume returns false plus the error
message.
">
<Param name="co" />
<Param name="[, val, ...]" />
</Overload>
</KeyWord>
<KeyWord name="coroutine.running" func="yes">
<Overload retVal="void" descr="
Returns the running coroutine, or nil when called by the main thread.
"></Overload>
</KeyWord>
<KeyWord name="coroutine.status" func="yes">
<Overload retVal="void" descr="
Returns the status of coroutine co, as a string: 'running', if the coroutine is running (that is, it called status);
'suspended', if the coroutine is suspended in a call to yield, or if it has not started running yet;
'normal' if the coroutine is active but not running (that is, it has resumed another coroutine); and
'dead' if the coroutine has finished its body function, or if it has stopped with an error.
">
<Param name="co" />
</Overload>
</KeyWord>
<KeyWord name="coroutine.wrap" func="yes">
<Overload retVal="void" descr="
Creates a new coroutine, with body f. f must be a Lua function. Returns a function that resumes
the coroutine each time it is called. Any arguments passed to the function behave as the extra
arguments to resume. Returns the same values returned by resume, except the first boolean. In
case of error, propagates the error.
">
<Param name="f" />
</Overload>
</KeyWord>
<KeyWord name="coroutine.yield" func="yes">
<Overload retVal="void" descr="
Suspends the execution of the calling coroutine. The coroutine cannot be running a C function, a
metamethod, or an iterator. Any arguments to yield are passed as extra results to resume.
">
<Param name="..." />
</Overload>
</KeyWord>
<KeyWord name="debug.debug" func="yes">
<Overload retVal="void" descr="
Enters an interactive mode with the user, running each string that the user enters. Using
simple commands and other debug facilities, the user can inspect global and local variables,
change their values, evaluate expressions, and so on. A line containing only the word cont
finishes this function, so that the caller continues its execution.
Note that commands for debug.debug are not lexically nested within any function, and so
have no direct access to local variables.
"></Overload>
</KeyWord>
<KeyWord name="debug.getfenv" func="yes">
<Overload retVal="void" descr="
Returns the environment of object o.
">
<Param name="o" />
</Overload>
</KeyWord>
<KeyWord name="debug.gethook" func="yes">
<Overload retVal="void" descr="
Returns the current hook settings of the thread, as three values: the current hook function, the
current hook mask, and the current hook count (as set by the debug.sethook function).
">
<Param name="[thread]" />
</Overload>
</KeyWord>
<KeyWord name="debug.getinfo" func="yes">
<Overload retVal="void" descr="
Returns a table with information about a function. You can give the function directly, or you
can give a number as the value of function, which means the function running at level function
of the call stack of the given thread: level 0 is the current function (getinfo itself); level 1
is the function that called getinfo; and so on. If function is a number larger than the number
of active functions, then getinfo returns nil.
The returned table can contain all the fields returned by lua_getinfo, with the string what
describing which fields to fill in. The default for what is to get all information available,
except the table of valid lines. If present, the option 'f' adds a field named func with the
function itself. If present, the option 'L' adds a field named activelines with the table of
valid lines.
For instance, the expression debug.getinfo(1,'n').name returns a table with a name for the current
function, if a reasonable name can be found, and the expression debug.getinfo(print) returns a table
with all available information about the print function.
">
<Param name="[thread,]" />
<Param name="function" />
<Param name="[, what]" />
</Overload>
</KeyWord>
<KeyWord name="debug.getlocal" func="yes">
<Overload retVal="void" descr="
This function returns the name and the value of the local variable with index local of the function
at level level of the stack. (The first parameter or local variable has index 1, and so on, until the
last active local variable.) The function returns nil if there is no local variable with the given index,
and raises an error when called with a level out of range. (You can call debug.getinfo to check whether
the level is valid.)
Variable names starting with '(' (open parentheses) represent internal variables (loop control variables,
temporaries, and C function locals).
">
<Param name="[thread,]" />
<Param name="level" />
<Param name="local" />
</Overload>
</KeyWord>
<KeyWord name="debug.getmetatable" func="yes">
<Overload retVal="void" descr="
Returns the metatable of the given object or nil if it does not have a metatable.
">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="debug.getregistry" func="yes">
<Overload retVal="void" descr="
Returns the registry table (see §3.5).
"></Overload>
</KeyWord>
<KeyWord name="debug.getupvalue" func="yes">
<Overload retVal="void" descr="
This function returns the name and the value of the upvalue with index up of the function
func. The function returns nil if there is no upvalue with the given index.
">
<Param name="func" />
<Param name="up" />
</Overload>
</KeyWord>
<KeyWord name="debug.setfenv" func="yes">
<Overload retVal="void" descr="
Sets the environment of the given object to the given table. Returns object.
">
<Param name="object" />
<Param name="table" />
</Overload>
</KeyWord>
<KeyWord name="debug.sethook" func="yes">
<Overload retVal="void" descr="
Sets the given function as a hook. The string mask and the number count describe when the hook
will be called. The string mask may have the following characters, with the given meaning:
* 'c': the hook is called every time Lua calls a function;
* 'r': the hook is called every time Lua returns from a function;
* 'l': the hook is called every time Lua enters a new line of code.
With a count different from zero, the hook is called after every count instructions.
When called without arguments, debug.sethook turns off the hook.
When the hook is called, its first parameter is a string describing the event that has triggered
its call: 'call', 'return' (or 'tail return', when simulating a return from a tail call), 'line',
and 'count'. For line events, the hook also gets the new line number as its second parameter.
Inside a hook, you can call getinfo with level 2 to get more information about the running function
(level 0 is the getinfo function, and level 1 is the hook function), unless the event is 'tail return'.
In this case, Lua is only simulating the return, and a call to getinfo will return invalid data.
">
<Param name="[thread,]" />
<Param name="hook" />
<Param name="mask" />
<Param name="[, count]" />
</Overload>
</KeyWord>
<KeyWord name="debug.setlocal" func="yes">
<Overload retVal="void" descr="
This function assigns the value value to the local variable with index local of the function at level
level of the stack. The function returns nil if there is no local variable with the given index, and
raises an error when called with a level out of range. (You can call getinfo to check whether the level
is valid.) Otherwise, it returns the name of the local variable.
">
<Param name="[thread,]" />
<Param name="level" />
<Param name="local" />
<Param name="value" />
</Overload>
</KeyWord>
<KeyWord name="debug.setmetatable" func="yes">
<Overload retVal="void" descr="
Sets the metatable for the given object to the given table (which can be nil).
">
<Param name="object" />
<Param name="table" />
</Overload>
</KeyWord>
<KeyWord name="debug.setupvalue" func="yes">
<Overload retVal="void" descr="
This function assigns the value value to the upvalue with index up of the function func. The function
returns nil if there is no upvalue with the given index. Otherwise, it returns the name of the upvalue.
">
<Param name="func" />
<Param name="up" />
<Param name="value" />
</Overload>
</KeyWord>
<KeyWord name="debug.traceback" func="yes">
<Overload retVal="void" descr="
Returns a string with a traceback of the call stack. An optional message string is appended at the
beginning of the traceback. An optional level number tells at which level to start the traceback
(default is 1, the function calling traceback).
">
<Param name="[thread,]" />
<Param name="[message]" />
<Param name="[, level]" />
</Overload>
</KeyWord>
<KeyWord name="do" func="no" />
<KeyWord name="dofile" func="yes">
<Overload retVal="void" descr="
Opens the named file and executes its contents as a Lua chunk. When called without arguments, dofile
executes the contents of the standard input (stdin). Returns all values returned by the chunk. In case
of errors, dofile propagates the error to its caller (that is, dofile does not run in protected mode).
">
<Param name="filename" />
</Overload>
</KeyWord>
<KeyWord name="clearlog" func="yes">
<Overload retVal="void" descr="
Der Inhalt des EEP-Ereignis-Fensters wird gelöscht.
">
</Overload>
</KeyWord>
<KeyWord name="EEPActivateCtrlDesk" func="yes">
<Overload retVal="number" descr="
Zweck - Ruft ein Gleisbildstellpult (GBS) im Radarfenster auf.
ok = EEPActivateCtrlDesk(Wildungen)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist der Stellpult-Name des GBS als String. (Nicht dessen LuaName!) Der Stellpult-Name ist in den Objekteigenschaften des Stellpults in dem
gleichnamigen Feld eingetragen.
* Der Rückgabewert ist true, wenn die Ausführung erfolgreich war, sonst false.">
<Param name="Stellpult-Name" />
</Overload>
</KeyWord>
<KeyWord name="EEPChangeInfoSignal" func="yes">
<Overload retVal="number" descr="
Zweck - Weist einem Tipp-Text einen neuen Text zu
EEPChangeInfoSignal(1, *Hallo*)
*Anführungszeichen
Parameter zwei
Rückgabewerte einer
Voraussetzung EEP 13
Bemerkungen
* Das erste Argument ist die Signal-ID.
* Das zweite Argument ist der gewünschte Text. Zeilenumbruch mit \n
* Rückgabewert ist true, wenn das Ziel der Funktion gefunden wurde.
">
<Param name="ID" />
<Param name="TEXT" />
</Overload>
</KeyWord>
<KeyWord name="EEPChangeInfoStructure" func="yes">
<Overload retVal="number" descr="
Zweck - Weist einem Tipp-Text einen neuen Text zu
EEPChangeInfoStructure(*#1*, *Hallo*)
* Anführungszeichen
Parameter zwei
Rückgabewerte einer
Voraussetzung EEP 13
Bemerkungen * Das erste Argument ist der Lua-Name der Immobilie. Er steht in den
Objekteigenschaften.
* Das zweite Argument ist der gewünschte Text. Zeilenumbruch mit \n.
* Rückgabewert ist true, wenn das Ziel der Funktion gefunden wurde.
">
<Param name="Lua-Name" />
<Param name="TEXT" />
</Overload>
</KeyWord>
<KeyWord name="EEPChangeInfoSwitch" func="yes">
<Overload retVal="number" descr="
Zweck - Weist einem Tipp-Text einen neuen Text zu
EEPChangeInfoSwitch(1, *Hallo*)
* Anführungszeichen
Parameter zwei
Rückgabewerte einer
Voraussetzung EEP 13
Bemerkungen
Das erste Argument ist die Weichen-ID.
Das zweite Argument ist der gewünschte Text. Zeilenumbruch mit \n
Rückgabewert ist true, wenn das Ziel der Funktion gefunden wurde.
">
<Param name="ID" />
<Param name="TEXT" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetAnlLng" func="yes">
<Overload retVal="number" descr="
Zweck - Liefert die auf Achsnamen bezogene Anlagensprache. Diese wird mit dem ersten
Einsetzen eines Modells mit Achsen von EEP vergeben und ändert sich danach nicht
mehr. Solange noch kein Modell mit Achsen eingesetzt wurde, entspricht diese
Anlagensprache der Sprache der aktuellen EEP-Version, d.h. der EEP-spezifischen
Variablen EEPLng.
Anlagensprache = EEPGetAnlLng()
if Anlagensprache == *GER* then
print(*Die Anlagensprache in Bezug auf Achsen ist
deutsch.*)
elseif Anlagensprache == *ENG* then
print(*Die Anlagensprache in Bezug auf Achsen ist
englisch.*)
elseif Anlagensprache == *FRA* then
print(*Die Anlagensprache in Bezug auf Achsen ist
französisch.*)
end
Parameter keiner
Rückgabewerte zwei
Voraussetzung EEP 17
Bemerkungen
• Der Funktionsaufruf durch EEP erfolgt ohne Parameter.
• Der Rückgabewert ist das Kürzel für die in Bezug auf Achsnamen vergebene
*Anlagensprache* (Definition siehe oben unter Zweck):
GER = deutsche Version
ENG = englische Version
FRA = französische Version">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetAnlVer" func="yes">
<Overload retVal="number" descr="
Zweck - Liefert die EEP-Version, mit der die Anlage zuletzt gespeichert wurde.
Anlagenversion = EEPGetAnlVer()
print(Die Anlage wurde zuletzt vor dem Öffnen in
EEP , Anlagenversion, gespeichert)
Parameter keiner
Rückgabewerte einer
Voraussetzung EEP 17
Bemerkungen
• Der Funktionsaufruf durch EEP erfolgt ohne Parameter.
• Der Rückgabewert ist dieVersionsnummer von EEP, in der die Anlage zuletzt
gespeichert wurde. Er ist sofort nach jeder Speicherung aktuell.">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetCloudsIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt den Wolkenanteil.
Wolkenanteil = EEPGetCloudsIntensity()
Parameter keiner
Rückgabewerte einer
Voraussetzung EEP 16.1 - Plug-in 1
Bemerkungen
• Der Rückgabewert ist der Wolkenanteil in Prozent unabhängig davon, wie der
Wolkenanteil vorher gesetzt wurde, ob unter *Einstellung der Umwelt* oder mit den
Lua- Funktionen EEPSetCloudsIntensity() bzw. EEPSetDarkCloudsIntensity().
• Achtung: Nach EEPSetCloudsIntensity() bzw. EEPSetDarkCloudsIntensity() liefert
EEPGetCloudsIntensity() frühestens im nächsten Zyklus der EEPMain() die neuen Wolkenanteile.">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetCloudsMode" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt ob global (außerhalb eventueller Wetterzonen) Wolken am Himmel sind und welcher Art sie sind.
Modus = EEPGetCloudsMode()
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Funktionsaufruf durch EEP erfolgt ohne Parameter.
* Der Rückgabewert gibt den Wolken-Modus an:
0 = keine Wolken,
1 = Wolken,
2 = dunkle Wolken.
* Achtung: Nach EEPSetCloudsIntensity() bzw. EEPSetDarkCloudsIntensity() liefert
EEPGetCloudsMode() frühestens im nächsten Zyklus der EEPMain() den neuen Wolkenmodus">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetTrainFromTrainyard" func="yes">
<Overload retVal="number" descr="
Zweck - Schickt einen ausgewählten Zug aus einem ausgewählten virtuellen Zugdepot
EEPGetTrainFromTrainyard(1,*#Rheingold*,1)
*Anführungszeichen
Parameter drei
Rückgabewerte einer
Voraussetzung EEP 11.3 Plugin 2
Bemerkungen
* Das erste Argument ist die ID des Zugdepots. Sie steht in der Kopfzeile des Eigenschaftenfensters.
* Das zweite Argument ist der Name des Zuges als String. Wird der Name weggelassen,
dann bestimmt das dritte Argument den Zug
* Das dritte Argument ist der Listenplatz des Zuges im Depot. Dieses Argument gilt nur,
wenn kein Zugname angegeben ist. Bei vorgegebenem Zugnamen ist diese Zahl beliebig,
aber dennoch erforderlich.
* Rückgabewert ist true, wenn das Depot und der angeforderte Zug existieren, andernfalls false.
">
<Param name="Depot" />
<Param name="Zugname" />
<Param name="Nr" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetTrainLength" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Gesamtlänge des angegebenen Zuges.
ok, Laenge = EEPGetTrainLength(*#Gueterzug*)
*Anführungszeichen
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 15.1 Plug-In 1
Bemerkungen
* Das Argument ist der komplette Zugname als String.
* Der erste Rückgabewert ist true, wenn der angesprochene Zug existiert, sonst false.
* Der zweite Rückgabewert ist die Zuglänge in Metern.
">
<Param name="*#Name*" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetTrainRoute" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Route eines Zugverbandes.
hResult, hData = EEPGetTrainRoute(*#Personenzug*)
*Anführungszeichen setzen
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 11.2 Plugin 2
Bemerkungen
* Das Argument ist der komplette Zugname als String.
* Der erste Rückgabewert ist true, wenn der angesprochene Zug existiert oder false,
wenn er nicht existiert.
* Der zweite Rückgabewert ist die ermittelte Route.
">
<Param name="#Name" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetTrainSpeed" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Ist-Geschwindigkeit oder die Reisegeschwindigkeit eines
Fahrzeugverbandes (z.B. eines Zuges).
ok, IstGeschwindigkeit = EEPGetTrainSpeed(*#VT98;001*)
ok, IstGeschwindigkeit = EEPGetTrainSpeed(*#VT98;001*, false)
ok, ReiseGeschwindigkeit = EEPGetTrainSpeed(*#VT98;001*, true)
Parameter einer oder zwei
Rückgabewerte zwei
Voraussetzung EEP 11.0 17.2 - Plug-in 2
Bemerkungen
* Der Parameter ist der komplette Name des *Fahrzeugverbands* (mit vorangestelltem #-Zeichen) als String.
* Ab EEP 17.2 Plug-in 2 kann ein optionaler 2. Parameter mit true oder. false bzw.
1 oder. 0 eingegeben werden.
o Bei false oder 0 oder Nichtexistenz wird - wie auch vorher - die augenblickliche
Ist-Geschwindigkeit zurückgegeben.
o Bei true oder 1 wird die *Reise*geschwindigkeit zurückgegeben (auch wenn
er vor einem Signal wartet!)
* Der 1. Rückgabewert ist entweder true, wenn der angesprochene *Fahrzeugverband* existiert oder false, wenn er nicht existiert.
* Der 2. Rückgabewert ist die ermittelte Geschwindigkeit.
* Achtung: Nach EEPSetTrainSpeed() liefert EEPGetTrainSpeed() frühestens im
nächsten Zyklus der EEPMain() den neuen Wert.">
<Param name="*#Name*, false|true" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneClouds" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt ob in einer Wetterzone Wolken am Himmel sind und welcher Art sie sind.
ok, Modus = EEPGetZoneClouds(3)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sie steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert gibt den Wolken-Modus an:
0 = keine Wolken,
1 = Wolken,
2 = dunkle Wolken.
* Achtung: Nach EEPSetZoneClouds() liefert EEPGetZoneClouds() frühestens im
nächsten Zyklus der EEPMain() den neuen Wolkenmodus.">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneFogIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Nebeldichte in einer Wetterzone.
ok, Nebeldichte = EEPGetZoneFogIntensity(2)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sie steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert ist die Nebeldichte in Prozent.
* Achtung: Nach EEPGetZoneFogIntensity() liefert EEPGetZoneFogIntensity() frühestens im nächsten Zyklus der EEPMain() die neue Nebeldichte.">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneHailIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Hagel-/Graupelstärke in einer Wetterzone
ok, Hagelstaerke = EEPGetZoneHailIntensity(4)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sie steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert ist die Hagel-/Graupelstärke in Prozent.
* Achtung: Nach EEPSetZoneHailIntensity() liefert EEPGetZoneHailIntensity() frühestens im
nächsten Zyklus der EEPMain() die neue Hagel-/Graupelstärke.">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneRainIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Windstärke in einer Wetterzone.
ok, Windstaerke = EEPGetZoneRainIntensity(2)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sie steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert ist die Regenstärke in Prozent.
* Achtung: Nach EEPSetZoneRainIntensity() liefert EEPGetZoneRainIntensity() frühestens im nächsten Zyklus der EEPMain() die neue Windstärke">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneSnowIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Schneefallstärke in einer Wetterzone
ok, Schneefallstaerke = EEPGetZoneSnowIntensity(3)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sie steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert ist die Schneefallstärke in Prozent.
* Achtung: Nach EEPSetZoneSnowIntensity() liefert EEPGetZoneSnowIntensity() frühestens im nächsten Zyklus der EEPMain() die neue Schneefallstärke.">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZoneWindIntensity" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die Windstärke in einer Wetterzone.
ok, Windstaerke = EEPGetZoneWindIntensity(2)
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sieht steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten
false.
* Der 2. Rückgabewert ist die Windstärke in Prozent.
* Achtung: Nach EEPSetZoneWindIntensity() liefert EEPGetZoneWindIntensity() frühestens im nächsten Zyklus der EEPMain() die neue Windstärke">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPGetZonePos" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt die aktuelle Position einer Wetterzone und ihren Radius.
ok, Pos_X, Pos_Y, Pos_Z, Radius = EEPGetZonePos(3)
Parameter einer
Rückgabewerte fünf
Voraussetzung EEP 17.1 - Plug-in 1
Bemerkungen
* Der Parameter ist die Nummer der Wetterzone als numerische Zahl. Sieht steht in
der obersten Zeile ihrer Objekteigenschaften.
* Der 1. Rückgabewert ist true, wenn die Ausführung erfolgreich war, ansonsten false.
* Der 2. Rückgabewert ist die X-Position der Zone.
* Der 3. Rückgabewert ist die Y-Position der Zone.
* Der 4. Rückgabewert ist die Z-Position der Zone.
* Der 5. Rückgabewert ist der Radius der Zone.
* Achtung: Nach EEPSetZonePos() liefert EEPGetZonePos() frühestens im nächsten Zyklus der EEPMain() die neuen Werte.">
<Param name="Zonennummer" />
</Overload>
</KeyWord>
<KeyWord name="EEPHideInfoTextTop" func="yes">
<Overload retVal="number" descr="
Zweck Blendet den Infotext am oberen Bildrand aus.
EEPHideInfoTextTop()
Parameter keiner
Rückgabewert einer
Voraussetzung EEP 13 Plugin 1
Bemerkung * Diese Funktion benötigt keine Argumente.
* Rückgabewert ist true, wenn die Funktion erfolgreich ausgeführt wurde.
">
</Overload>
</KeyWord>
<KeyWord name="EEPHideInfoTextBottom" func="yes">
<Overload retVal="number" descr="
Zweck Blendet den Infotext am unteren Bildrand aus.
EEPHideInfoTextBottom()
Parameter keiner
Rückgabewert einer
Voraussetzung EEP 13 Plugin 1
Bemerkung * Diese Funktion benötigt keine Argumente.
* Rückgabewert ist true, wenn die Funktion erfolgreich ausgeführt wurde.
">
</Overload>
</KeyWord>
<KeyWord name="EEPIsAuxiliaryTrackReserved" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt, ob ein Weg-Element der Kategorie *Sonstige* besetzt ist bzw. ob es mit dem
x-ten Fahrzeugverband besetzt ist und gibt dann dessen Namen zurück.
ok, besetzt = EEPIsAuxiliaryTrackReserved(321)
ok, besetzt, Name = EEPIsAuxiliaryTrackReserved(321,true)
ok, besetzt, Name = EEPIsAuxiliaryTrackReserved(321,3)
Parameter einer oder zwei
Rückgabewerte zwei oder drei
Voraussetzung EEP 11.3 Plugin 3 13.2 Plugin 2 17.2 Plugin 2
Bemerkungen
* Der (1.) Parameter ist die ID des Weges der Kategorie *Sonstige*, welcher auf *besetzt* geprüft werden soll.
* Ab EEP 13.2 Plug-in 2 kann ein optionaler 2. Parameter true oder 1 mitgegeben
werden, damit die Funktion als 3. Rückgabewert den Namen des vordersten Fahrzeugverbandeses in Wegrichtung liefert.
Ab EEP 17.2 Plug-in 2 können auch Zahlen größer 1 eingegeben werden, damit
die Funktion den Namen des Fahrzeugverbandes auf der entsprechenden hinteren
Position als 3. Rückgabewert ausgibt.
* Der 1. Rückgabewert ist true, wenn der zu prüfende Weg existiert und registriert ist,
andernfalls false.
* Der 2. Rückgabewert ist ohne den 2. Parameter true, wenn der Weg besetzt ist,
andernfalls false. Mit dem 2. Parameter gibt er true zurück, wenn an der im 2. Parameter bezeichneten Stelle (wobei dort true = 1 ist) ein Fahrzeugverband steht, andernfalls false.
* Der 3. (optionale) Rückgabewert ist der Name des Fahrzeugverbandes, welcher
den Weg auf der als 2. Parameter angegebenen Position (wobei true = 1 ist) besetzt. Wird als 3. Parameter eine Zahl eingegeben, die größer als die Anzahl der
Fahrzeugverbände ist, die auf dem Weg stehen, so ist der 3. Rückgabe-wert eine
leere Zeichenkette (String).
ACHTUNG: Der 3. Rückgabewert ist korrekt, solange die Fahrzeugverbände nicht
in Bewegung sind! Wenn sich aber die Fahrzeuge bewegen, kann der Lua-Interpreter falsche Namen liefern, da sich die Liste mit den Namen z.B. mit 60 fps ändert,
Lua aber asynchron in einem anderen Thread (CPU) läuft, um EEP nicht zu verlang -
samen.
* Der Weg muss zuvor für Besetztabfragen registriert worden sein!">
<Param name="Weg-ID, [true|false]" />
</Overload>
</KeyWord>
<KeyWord name="EEPIsControlTrackReserved" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt, ob ein Steuerstrecken-Element besetzt ist bzw. ob es mit dem x-ten
Fahrzeugverband besetzt ist und gibt dann dessen Namen zurück.
ok, besetzt = EEPIsControlTrackReserved(333)
ok, besetzt, Name = EEPIsControlTrackReserved(333, true)
ok, besetzt, Name = EEPIsControlTrackReserved(333, 1)
Parameter einer oder zwei
Rückgabewerte zwei oder drei
Voraussetzung EEP 11.3 Plugin 3 13.2 Plugin 2 17.2 Plugin 2
Bemerkungen
* Der (1.) Parameter ist die ID der Steuerstrecke, welche auf *besetzt* geprüft werden soll.
* Ab EEP 13.2 Plug-in 2 kann ein optionaler 2. Parameter true oder 1 mitgegeben
werden, damit die Funktion als 3. Rückgabewert den Namen des vordersten Fahrzeugverbandeses in Steuerstreckenrichtung liefert.
Ab EEP 17.2 Plug-in 2 können auch Zahlen größer 1 eingegeben werden, damit
die Funktion den Namen des Fahrzeugverbandes auf der entsprechenden hinteren
Position als 3. Rückgabewert ausgibt.
* Der 1. Rückgabewert ist true, wenn die zu prüfende Steuerstrecke existiert und registriert ist, andernfalls false.
* Der 2. Rückgabewert ist ohne den 2. Parameter true, wenn die Steuerstrecke besetzt ist, andernfalls false.
Mit dem 2. Parameter gibt er true zurück, wenn an der im 2. Parameter bezeichneten Stelle (wobei dort true = 1 ist)
ein Fahrzeugverband steht, andernfalls false.
* Der 3. (optionale) Rückgabewert ist der Name des Fahrzeugverbandes, welcher
die Steuerstrecke auf der als 2. Parameter angegebenen Position (wobei true = 1
ist) besetzt. Wird als 3. Parameter eine Zahl eingegeben, die größer als die Anzahl
der Fahrzeugverbände ist, die auf der Steuerstrecke stehen, so ist der 3. Rückgabewert eine leere Zeichenkette (String).
ACHTUNG: Der 3. Rückgabewert ist korrekt, solange die Fahrzeugverbände nicht
in Bewegung sind! Wenn sich aber die Fahrzeuge bewegen, kann der Lua-Interpreter falsche Namen liefern,
da sich die Liste mit den Namen z.B. mit 60 fps ändert, Lua aber asynchron in einem anderen Thread (CPU) läuft,
um EEP nicht zu verlangsamen.
* Die Steuerstrecke muss zuvor für Besetztabfragen registriert worden sein!">
<Param name="Steuerstrecken-ID, [true|false]" />
</Overload>
</KeyWord>
<KeyWord name="EEPIsRailTrackReserved" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt, ob ein Gleiselement besetzt ist bzw. ob es mit dem x-ten Zugverband
besetzt ist und gibt dann dessen Namen zurück.
ok, besetzt = EEPIsRailTrackReserved(123)
ok, besetzt, Name = EEPIsRailTrackReserved(123, true)
ok, besetzt, Name = EEPIsRailTrackReserved(123, 2)
Parameter einer oder zwei
Rückgabewerte zwei oder drei
Voraussetzung EEP 11.3 Plug-in 3 13.2 Plug-in 2 17.2 Plug-in 2
Bemerkungen
* Der (1.) Parameter ist die ID des Gleises, das auf *besetzt* geprüft werden soll.
* Ab EEP 13.2 Plug-in 2 kann ein optionaler 2. Parameter true oder 1 mitgegeben
werden, damit die Funktion als 3. Rückgabewert den Namen des vordersten Zugverbandeses in Gleisrichtung liefert.
Ab EEP 17.2 Plug-in 2 können auch Zahlen größer 1 eingegeben werden, damit
die Funktion den Namen des Zugverbandes auf der entsprechenden hinteren Position als 3. Rückgabewert ausgibt.
* Der 1. Rückgabewert ist true, wenn das zu prüfende Gleis existiert und registriert
ist, andernfalls false.
* Der 2. Rückgabewert ist ohne den 2. Parameter true, wenn das Gleis besetzt ist,
andernfalls false. Mit dem 2. Parameter gibt er true zurück,
wenn an der im 2. Parameter bezeichneten Stelle (wobei dort true = 1 ist) ein Zugverband steht, andernfalls false.
* Der 3. (optionale) Rückgabewert ist der Name des Zugverbandes, welcher das
Gleis auf der als 2. Parameter angegebenen Position (wobei true = 1 ist) besetzt.
Wird als 3. Parameter eine Zahl eingegeben, die größer als die Anzahl der Zugverbände
ist, die auf dem Gleis stehen, so ist der 3. Rückgabewert eine leere Zeichenkette (String).
ACHTUNG: Der 3. Rückgabewert ist korrekt, solange die Züge nicht in Bewegung
sind! Wenn sich aber die Fahrzeuge bewegen, kann der Lua-Interpreter falsche
Namen liefern, da sich die Liste mit den Namen z.B. mit 60 fps ändert, Lua aber
asynchron in einem anderen Thread (CPU) läuft, um EEP nicht zu verlangsamen.
* Das Gleis muss zuvor für Besetztabfragen registriert worden sein!">
<Param name="Gleis-ID, [true|Zahl]" />
</Overload>
</KeyWord>
<KeyWord name="EEPIsRoadTrackReserved" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt, ob ein Straßenelement besetzt ist bzw. ob es mit dem x-ten
Fahrzeugverband besetzt ist und gibt dann dessen Namen zurück.
ok, besetzt = EEPIsRoadTrackReserved(211)
ok, besetzt, Name = EEPIsRoadTrackReserved(211, true)
ok, besetzt, Name = EEPIsRoadTrackReserved(211, 3
Parameter einer oder zwei
Rückgabewerte zwei oder drei
Voraussetzung EEP 11.3 Plugin 3 13.2 Plugin 2 17.2 Plugin 2
Bemerkungen
* Der (1.) Parameter ist die ID der Straße, welche auf *besetzt* geprüft werden soll.
* Ab EEP 13.2 Plug-in 2 kann ein optionaler 2. Parameter true oder 1 mitgegeben
werden, damit die Funktion als 3. Rückgabewert den Namen des vordersten Fahrzeugverbandeses in Straßenrichtung liefert.
Ab EEP 17.2 Plug-in 2 können auch Zahlen größer 1 eingegeben werden, damit
die Funktion den Namen des Fahrzeugverbandes auf der entsprechenden hinteren
Position als 3. Rückgabewert ausgibt..
* Der 1. Rückgabewert ist true, wenn die zu prüfende Straße existiert und registriert
ist, andernfalls false.
* Der 2. Rückgabewert ist ohne den 2. Parameter true, wenn die Straße besetzt ist,
andernfalls false. Mit dem 2. Parameter gibt er true zurück,
wenn an der im 2. Parameter bezeichneten Stelle (wobei dort true = 1 ist) ein Fahrzeugverband steht,
andernfalls false.
* Der 3. (optionale) Rückgabewert ist der Name des Fahrzeugverbandes, welcher
die Straße auf der als 2. Parameter angegebenen Position (wobei true = 1 ist) besetzt.
Wird als 3. Parameter eine Zahl eingegeben, die größer als die Anzahl der
Fahrzeugverbände ist, die auf der Straße stehen, so ist der 3. Rückgabewert eine
leere Zeichenkette (String).
ACHTUNG: Der 3. Rückgabewert ist korrekt, solange die Fahrzeugver-bände nicht
in Bewegung sind! Wenn sich aber die Fahrzeuge bewegen, kann der Lua-Interpreter falsche Namen liefern,
da sich die Liste mit den Namen z.B. mit 60 fps ändert, Lua aber asynchron in einem anderen Thread (CPU)
läuft, um EEP nicht zu verlangsamen.
* Die Straße muss zuvor für Besetztabfragen registriert worden sein!">
<Param name="Strassen-ID, [true|false]" />
</Overload>
</KeyWord>
<KeyWord name="EEPIsTramTrackReserved" func="yes">
<Overload retVal="number" descr="
Zweck - Ermittelt, ob ein Straßenbahngleis besetzt ist bzw. ob es mit dem x-ten Zugverband
besetzt ist und gibt dann dessen Namen zurück.
ok, besetzt = EEPIsTramTrackReserved(187)
ok, besetzt, Name = EEPIsTramTrackReserved(187, true)
ok, besetzt, Name = EEPIsTramTrackReserved(187, 2)
Parameter einer oder zwei
Rückgabewerte zwei oder drei
Voraussetzung EEP 11.3 Plugin 3 13.3 Plugin 3 17.2 Plugin 2
Bemerkungen
* Der (1.) Parameter ist die ID des Straßenbahngleises, welches auf *besetzt* geprüft werden soll.
* Ab EEP 13.2 Plug-in 2 kann ein optionaler 2. Parameter true oder 1 mitgegeben
werden, damit die Funktion als 3. Rückgabewert den Namen des vordersten Zugverbandeses in Gleisrichtung liefert.
Ab EEP 17.2 Plug-in 2 können auch Zahlen größer 1 eingegeben werden, damit
die Funktion den Namen des Zuges auf der entsprechenden hinteren Position als
3. Rückgabewert ausgibt.
* Der 1. Rückgabewert ist true, wenn das zu prüfende Straßenbahngleis existiert
und registriert ist, andernfalls false.
* Der 2. Rückgabewert ist ohne den 2. Parameter true, wenn das Straßenbahngleis
besetzt ist, andernfalls false. Mit dem 2. Parameter gibt er true zurück, wenn an
der im 2. Parameter bezeichneten Stelle (wobei dort true = 1 ist) ein Zugverband
steht, andernfalls false.
* Der 3. (optionale) Rückgabewert ist der Name des Zugverbandes, welcher das Stra-
ßenbahngleis auf der als 2. Parameter angegebenen Position (wobei true = 1 ist)
besetzt. Wird als 3. Parameter eine Zahl eingegeben, die größer als die Anzahl der
Zugverbände ist, die auf dem Gleis stehen, so ist der 3. Rückgabewert eine leere
Zeichenkette (String).
ACHTUNG: Der 3. Rückgabewert ist korrekt, solange die Züge nicht in Bewegung
sind! Wenn sich aber die Fahrzeuge bewegen, kann der Lua-Interpreter falsche
Namen liefern, da sich die Liste mit den Namen z.B. mit 60 fps ändert, Lua aber
asynchron in einem anderen Thread (CPU) läuft, um EEP nicht zu verlangsamen.
* Das Straßenbahngleis muss zuvor für Besetztabfragen registriert worden sein!">
<Param name="Strassenbahngleis-ID, [true|false]" />
</Overload>
</KeyWord>
<KeyWord name="EEPLng" func="yes">
<Overload retVal="number" descr="
Zweck - Liefert das Kürzel für die Sprache der installierten EEP-Version:
GER = deutsche Version,
ENG = englische Version,
FRA = französische Version.
if EEPLng == *GER* then
print(*Dies ist eine deutsche EEP-Version*)
elseif EEPLng == *ENG* then
print(*This is an English version of EEP*)
elseif EEPLng == *FRA* then
print(*Il s'agit d'une version française de l'EEP*)
end
Voraussetzung EEP 17">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="EEPLoadData" func="yes">
<Overload retVal="number" descr="
Zweck - Lädt etwas aus einem speziellen Speicherbereich.
Wird automatisch zusammen mit der Anlage gespeichert und geladen.
Ersatz für die klassischen Hilfssignale.
hResult, hData = EEPLoadData(1)
if hResult then
print(*Slot 1 enthält: *..hData)
else
print(*Slot 1 ist leer*)
end
Parameter einer
Rückgabewerte zwei
Voraussetzung EEP 11.0
Bemerkungen
* Es gibt 1000 Speicherplätze, durchnummeriert von 1 bis 1000.
* Man kann entweder Zahlen oder Zeichenketten (*Strings*) speichern, wobei letztere
keine Formatierungszeichen enthalten dürfen.
* Das Argument ist die Nummer des Speicherplatzes.
* Der erste Rückgabewert ist true, wenn der betroffene Speicher einen Inhalt hat oder
false, wenn er leer ist.
* Der zweite Rückgabewert ist der Inhalt des Speichers.
* Wenn die Anlage geladen wird, dann holt EEP selbständig alle Inhalte dieser
Speicherplätze aus dem Anhang des Skripts. Damit können sie bei Bedarf durch Aufruf
von EEPLoadData() abgefragt und Variablen zugewiesen werden.
">
<Param name="Slot" />
</Overload>
</KeyWord>
<KeyWord name="EEPLoadProject" func="yes">
<Overload retVal="number" descr="
Zweck - Lädt eine Anlage aus dem Ordner *Resourcen\Anlagen*.
EEPLoadProject(*Tutorials\\Tutorial_54_LUA.anl3*)
* Anführungszeichen setzen
Parameter einer
Rückgabewerte einer
Voraussetzung EEP 11.3 Plugin 3
Bemerkungen
* Das Argument ist der Unterordner (wenn erforderlich) und der Dateiname einschließlich
.anl3 Suffix. Trennzeichen zwischen Ordner- und Dateiname ist ein doppelter Backslash.
* Rückgabewert ist true, wenn die Anlage existiert, andernfalls false.
">
<Param name="Dateiname" />
</Overload>
</KeyWord>
<KeyWord name="EEPMain" func="yes">
<Overload retVal="number" descr="
Zweck - Wird zyklisch alle 200 Millisekunden, also fünf Mal je Sekunde, von EEP aufgerufen.
Geeignet für alle Aktionen, die regelmäßig ausgeführt werden sollen.
function EEPMain()
return 1
end
Parameter keine
Rückgabewerte einer
Voraussetzung EEP 10.2 Plugin 2
Bemerkungen
* Muss im Skript deklariert sein, sonst stellt EEP die Verbindung zu Lua nicht her.
* Der Funktionsaufruf durch EEP erfolgt ohne Parameter.
* Die Funktion muss eine Zahl ungleich Null zurück liefern.
* Liefert die Funktion den Wert 0 zurück, dann wird die Funktion nicht erneut aufgerufen.
Alle anderen Funktionsaufrufe funktionieren weiterhin.
* Fehlt der Rückgabewert oder ist er keine Zahl, dann erfolgt eine Fehlermeldung und die
Verbindung zu Lua wird beendet.
">
</Overload>
</KeyWord>
<KeyWord name="EEPRegisterAuxiliaryTrack" func="yes">
<Overload retVal="number" descr="
Zweck - Registriert einen Weg-Element der Kategorie *Sonstige* für Besetztabfragen.
EEPRegisterAuxiliaryTrack(1)
Parameter einer
Rückgabewerte einer
Voraussetzung EEP 11.3 Plugin 3
Bemerkungen
* Das Argument ist die ID des zu registrierenden Weges.
* Rückgabewert ist true, wenn der Weg existiert, andernfalls false
* Registrierung ist zwingende Voraussetzung für Besetztabfragen
">
<Param name="ID" />
</Overload>