-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathnasal_api_doc_py2.html
7037 lines (7037 loc) · 383 KB
/
nasal_api_doc_py2.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
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
<html><head> <title>Nasal API</title> <style>
a.main_module_link {margin-left:30px;display:block;float:left;} div.container {background-color:#eee;clear:left;margin-top:20px;} h2.namespace_title {padding-left:20px;color:#fff;background-color:#8888AC} h4.class_function {padding-left:20px;background-color:#eee;color:#000033} h4.class_definition {padding-left:20px;background-color:#eee;color:#000033} h4.function {padding-left:20px;background-color:#eee;color:#000033} hr {margin-left:30px;margin-right:30px;} div.comments {padding-left:40px;display:inline;font-size:12px;} </style>
</head><body style="width:1024px;"><h1 style="padding-left:20px;display:block;color:#fff;background-color:#555588;"> Nasal $FGROOT Library<br/><span style="font-size:12px;">Flightgear version: 2019.1.1 <br/>This file is generated automatically by scripts/python/nasal_api_doc.py </span></h1> <br/><a href="http://plausible.org/nasal">Nasal documentation</a> <a href="http://wiki.flightgear.org/Nasal_scripting_language">Flightgear Nasal documentation</a>
<div style="float:right;"> <h2 style="font-size:14px;height:450px;width:250px;overflow:scroll;display:block;position:fixed;top:20px;right:20px;background-color:#8888AC;border:1px solid black;">
<a class="main_module_link" style="color:0000cc" href="#addons">addons</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#aircraft">aircraft</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#aurora">aurora</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#bits">bits</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#checklist">checklist</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#contrail">contrail</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#controls">controls</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#debug">debug</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#dynamic_view">dynamic_view</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#earthview">earthview</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#emesary">emesary</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#emesary_mp_bridge">emesary_mp_bridge</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#environment">environment</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#events">events</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#fuel">fuel</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#geo">geo</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#glide_slope_tunnel">glide_slope_tunnel</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#globals">globals</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#gui">gui</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#io">io</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#joystick">joystick</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#lag_adjust">lag_adjust</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#local_weather_auto_init">local_weather_auto_init</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#material">material</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#math">math</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#mp_broadcast">mp_broadcast</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#multikey">multikey</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#multiplayer">multiplayer</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#notifications">notifications</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#orbital_target">orbital_target</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#prop_key_handler">prop_key_handler</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#props">props</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#redout">redout</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#route_manager">route_manager</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#scenery">scenery</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#screen">screen</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#seaport">seaport</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#string">string</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#tanker">tanker</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#track_target">track_target</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#video">video</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#view">view</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#volcano">volcano</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#weather_scenario">weather_scenario</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#wildfire">wildfire</a> <br/>
<a class="main_module_link" style="color:0000cc" href="#windsock">windsock</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#FailureMgr">FailureMgr</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#canvas">canvas</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#console">console</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#input_helpers">input_helpers</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#jetways">jetways</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#jetways_edit">jetways_edit</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#local_weather">local_weather</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#performance_monitor">performance_monitor</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#std">std</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#towing">towing</a> <br/>
<a class="main_module_link" style="color:cc0000" href="#tutorial">tutorial</a> <br/>
</h2></div>
<div class="container" style="">
<h2 class="namespace_title"><a name="addons">addons</a></h2>
<div><h4 class="class_definition"><b>addons</b>.<b><i><u><font color="#000000">_listeners</font></u></i></b></h4>
<div class="comments"> hashes to store listeners and timers per addon ID</div><br/>
</div>
<div><h4 class="class_definition"><b>addons</b>.<b><i><u><font color="#000000">_timers</font></u></i></b></h4>
</div>
<div><h4 class="function"><b>addons</b>.<b>getNamespaceName</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="function"><b>addons</b>.<b>load</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="function"><b>addons</b>.<b>remove</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="class_definition"><b>addons</b>.<b><i><u><font color="#000000">_reloadFlags</font></u></i></b></h4>
</div>
<div><h4 class="function"><b>addons</b>.<b>reload</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="function"><b>addons</b>.<b>init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="aircraft">aircraft</a></h2>
<div><h4 class="function"><b>aircraft</b>.<b>makeNode</b> ( <font color="#cc0000">n</font> )</h4>
<div class="comments"> creates (if necessary) and returns a property node from arg[0],</div><br/>
<div class="comments"> which can be a property node already, or a property path</div><br/>
</div>
<div><h4 class="function"><b>aircraft</b>.<b>optarg</b> ( <font color="#cc0000">args, index, default</font> )</h4>
<div class="comments"> returns args[index] if available and non-nil, or default otherwise</div><br/>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">door</font></u></i></b></h4>
<div class="comments"> door</div><br/>
<hr/><div class="comments"> class for objects moving at constant speed, with the ability to</div><br/>
<div class="comments"> reverse moving direction at any point. Appropriate for doors, canopies, etc.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> door.new(<property>, <swingtime> [, <startpos>]);</div><br/>
<div class="comments"> property ... door node: property path or node</div><br/>
<div class="comments"> swingtime ... time in seconds for full movement (0 -> 1)</div><br/>
<div class="comments"> startpos ... initial position (default: 0)</div><br/>
<div class="comments"> PROPERTIES:</div><br/>
<div class="comments"> ./position-norm (double) (default: <startpos>)</div><br/>
<div class="comments"> ./enabled (bool) (default: 1)</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> var canopy = aircraft.door.new("sim/model/foo/canopy", 5);</div><br/>
<div class="comments"> canopy.open();</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.new</b> ( <font color="#cc0000">node, swingtime, pos = 0</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.enable</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> door.enable(bool) -> set ./enabled</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.setpos</b> ( <font color="#cc0000">pos</font> )</h4>
<div class="comments"> door.setpos(double) -> set ./position-norm without movement</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.getpos</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> double door.getpos() -> return current position as double</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.close</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> door.close() -> move to closed state</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.open</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> door.open() -> move to open state</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.toggle</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> door.toggle() -> move to opposite end position</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> door.stop() -> stop movement</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>door</i></b><b>.move</b> ( <font color="#cc0000">target</font> )</h4>
<div class="comments"> door.move(double) -> move to arbitrary position</div><br/>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">light</font></u></i></b></h4>
<div class="comments"> light</div><br/>
<hr/><div class="comments"> class for generation of pulsing values. Appropriate for controlling</div><br/>
<div class="comments"> beacons, strobes, etc.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> light.new(<property>, <pattern> [, <switch>]);</div><br/>
<div class="comments"> light.new(<property>, <stretch>, <pattern> [, <switch>]);</div><br/>
<div class="comments"> property ... light node: property path or node</div><br/>
<div class="comments"> stretch ... multiplicator for all pattern values</div><br/>
<div class="comments"> pattern ... array of on/off time intervals (in seconds)</div><br/>
<div class="comments"> switch ... property path or node to use as switch (default: ./enabled)</div><br/>
<div class="comments"> instead of ./enabled</div><br/>
<div class="comments"> PROPERTIES:</div><br/>
<div class="comments"> ./state (bool) (default: 0)</div><br/>
<div class="comments"> ./enabled (bool) (default: 0) except if <switch> given)</div><br/>
<div class="comments"> EXAMPLES:</div><br/>
<div class="comments"> aircraft.light.new("sim/model/foo/beacon", [0.4, 0.4]); anonymous light</div><br/>
<div class="comments">-------</div><br/>
<div class="comments"> var strobe = aircraft.light.new("sim/model/foo/strobe", [0.05, 0.05, 0.05, 1],</div><br/>
<div class="comments"> "controls/lighting/strobe");</div><br/>
<div class="comments"> strobe.switch(1);</div><br/>
<div class="comments">-------</div><br/>
<div class="comments"> var switch = props.globals.getNode("controls/lighting/strobe", 1);</div><br/>
<div class="comments"> var pattern = [0.02, 0.03, 0.02, 1];</div><br/>
<div class="comments"> aircraft.light.new("sim/model/foo/strobe-top", 1.001, pattern, switch);</div><br/>
<div class="comments"> aircraft.light.new("sim/model/foo/strobe-bot", 1.005, pattern, switch);</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.new</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.del</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> class destructor</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.switch</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> light.switch(bool) -> set light switch (also affects other lights</div><br/>
<div class="comments"> that use the same switch)</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.toggle</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> light.toggle() -> toggle light switch</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.cont</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> light.cont() -> continuous light</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.blink</b> ( <font color="#cc0000">count = -1, endstate = 0</font> )</h4>
<div class="comments"> light.blink() -> blinking light (default)</div><br/>
<div class="comments"> light.blink(3) -> when switched on, only run three blink sequences;</div><br/>
<div class="comments"> second optional arg defines state after the sequences</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.<font color="#0000cc">_switch_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>light</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">lowpass</font></u></i></b></h4>
<div class="comments"> lowpass</div><br/>
<hr/><div class="comments"> class that implements a variable-interval EWMA (Exponentially Weighted</div><br/>
<div class="comments"> Moving Average) lowpass filter with characteristics independent of the</div><br/>
<div class="comments"> frame rate.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> lowpass.new(<coefficient>);</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> var lp = aircraft.lowpass.new(1.5);</div><br/>
<div class="comments"> print(lp.filter(10)); prints 10</div><br/>
<div class="comments"> print(lp.filter(0));</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>lowpass</i></b><b>.new</b> ( <font color="#cc0000">coeff</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>lowpass</i></b><b>.filter</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> filter(raw_value) -> push new value, returns filtered value</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>lowpass</i></b><b>.get</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> get() -> returns filtered value</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>lowpass</i></b><b>.set</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> set() -> sets new average and returns it</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>lowpass</i></b><b>.<font color="#0000cc">_filter_</font></b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">angular_lowpass</font></u></i></b></h4>
<div class="comments"> angular lowpass</div><br/>
<hr/><div class="comments"> same as above, but for angles. Filters sin/cos separately and calculates the</div><br/>
<div class="comments"> angle again from them. This avoids unexpected jumps from 179.99 to -180 degree.</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>angular_lowpass</i></b><b>.new</b> ( <font color="#cc0000">coeff</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>angular_lowpass</i></b><b>.filter</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>angular_lowpass</i></b><b>.set</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>angular_lowpass</i></b><b>.get</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">data</font></u></i></b></h4>
<div class="comments"> class that loads and saves properties to aircraft-specific data files in</div><br/>
<div class="comments"> ~/.fgfs/aircraft-data/ (Unix) or %APPDATA%\flightgear.org\aircraft-data\.</div><br/>
<div class="comments"> There's no public constructor, as the only needed instance gets created</div><br/>
<div class="comments"> by the system.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> data.add(<properties>);</div><br/>
<div class="comments"> data.save([<interval>])</div><br/>
<div class="comments"> properties ... about any combination of property nodes (props.Node)</div><br/>
<div class="comments"> or path name strings, or lists or hashes of them,</div><br/>
<div class="comments"> lists of lists of them, etc.</div><br/>
<div class="comments"> interval ... save in <interval> minutes intervals, or only once</div><br/>
<div class="comments"> if 'nil' or empty (and again at reinit/exit)</div><br/>
<div class="comments"> SIGNALS:</div><br/>
<div class="comments"> /sim/signals/save ... set to 'true' right before saving. Can be used</div><br/>
<div class="comments"> to update values that are to be saved</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> var p = props.globals.getNode("/sim/model", 1);</div><br/>
<div class="comments"> var vec = [p, p];</div><br/>
<div class="comments"> var hash = {"foo": p, "bar": p};</div><br/>
<div class="comments"> add properties</div><br/>
<div class="comments"> aircraft.data.add("/sim/fg-root", p, "/sim/fg-home");</div><br/>
<div class="comments"> aircraft.data.add(p, vec, hash, "/sim/fg-root");</div><br/>
<div class="comments"> now save only once (and at exit/reinit, which is automatically done)</div><br/>
<div class="comments"> aircraft.data.save();</div><br/>
<div class="comments"> or save now and every 30 sec (and at exit/reinit)</div><br/>
<div class="comments"> aircraft.data.save(0.5);</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.load</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.save</b> ( <font color="#cc0000">v = nil</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.<font color="#0000cc">_save_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>data</i></b><b>.add</b> ( <font color="#cc0000">p...</font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">timer</font></u></i></b></h4>
<div class="comments"> timer</div><br/>
<hr/><div class="comments"> class that implements timer that can be started, stopped, reset, and can</div><br/>
<div class="comments"> have its value saved to the aircraft specific data file. Saving the value</div><br/>
<div class="comments"> is done automatically by the aircraft.Data class.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> timer.new(<property> [, <resolution:double> [, <save:bool>]])</div><br/>
<div class="comments"> <property> ... property path or props.Node hash that holds the timer value</div><br/>
<div class="comments"> <resolution> ... timer update resolution -- interval in seconds in which the</div><br/>
<div class="comments"> timer property is updated while running (default: 1 s)</div><br/>
<div class="comments"> <save> ... bool that defines whether the timer value should be saved</div><br/>
<div class="comments"> and restored next time, as needed for Hobbs meters</div><br/>
<div class="comments"> (default: 1)</div><br/>
<div class="comments"> EXAMPLES:</div><br/>
<div class="comments"> var hobbs_turbine = aircraft.timer.new("/sim/time/hobbs/turbine[0]", 60);</div><br/>
<div class="comments"> hobbs_turbine.start();</div><br/>
<div class="comments"> aircraft.timer.new("/sim/time/hobbs/battery", 60).start(); anonymous timer</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.new</b> ( <font color="#cc0000">prop, res = 1, save = 1</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.del</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.start</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.reset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.<font color="#0000cc">_apply_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.<font color="#0000cc">_save_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>timer</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">livery</font></u></i></b></h4>
<div class="comments"> livery</div><br/>
<hr/><div class="comments"> Class that maintains livery XML files (see English Electric Lightning for an</div><br/>
<div class="comments"> example). The last used livery is saved on exit and restored next time. Livery</div><br/>
<div class="comments"> files are regular PropertyList XML files whose properties are copied to the</div><br/>
<div class="comments"> main tree.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> livery.init(<livery-dir> [, <name-path> [, <sort-path>]]);</div><br/>
<div class="comments"> <livery-dir> ... directory with livery XML files, relative to $FG_ROOT</div><br/>
<div class="comments"> <name-path> ... property path to the livery name in the livery files</div><br/>
<div class="comments"> and the property tree (default: sim/model/livery/name)</div><br/>
<div class="comments"> <sort-path> ... property path to the sort criterion (default: same as</div><br/>
<div class="comments"> <name-path> -- that is: alphabetic sorting)</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> aircraft.livery.init("Aircraft/Lightning/Models/Liveries",</div><br/>
<div class="comments"> "sim/model/livery/variant",</div><br/>
<div class="comments"> "sim/model/livery/index"); optional</div><br/>
<div class="comments"> aircraft.livery.dialog.toggle();</div><br/>
<div class="comments"> aircraft.livery.select("OEBH");</div><br/>
<div class="comments"> aircraft.livery.next();</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>livery</i></b><b>.init</b> ( <font color="#cc0000">dir, nameprop = </font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">livery_update</font></u></i></b></h4>
<div class="comments"> livery_update</div><br/>
<hr/><div class="comments"> Class for maintaining liveries in MP aircraft. It is used in Nasal code that's</div><br/>
<div class="comments"> embedded in aircraft animation XML files, and checks in intervals whether the</div><br/>
<div class="comments"> parent aircraft has changed livery, in which case it changes the livery</div><br/>
<div class="comments"> in the remote aircraft accordingly. This class is a wrapper for overlay_update.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> livery_update.new(<livery-dir> [, <interval:10> [, <func>]]);</div><br/>
<div class="comments"> <livery-dir> ... directory with livery files, relative to $FG_ROOT</div><br/>
<div class="comments"> <interval> ... checking interval in seconds (default: 10)</div><br/>
<div class="comments"> <func> ... callback function that's called with the ./sim/model/livery/file</div><br/>
<div class="comments"> contents as argument whenever the livery has changed. This can</div><br/>
<div class="comments"> be used for post-processing.</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> <nasal></div><br/>
<div class="comments"> <load></div><br/>
<div class="comments"> var livery_update = aircraft.livery_update.new(</div><br/>
<div class="comments"> "Aircraft/R22/Models/Liveries", 30,</div><br/>
<div class="comments"> func print("R22 livery update"));</div><br/>
<div class="comments"> </load></div><br/>
<div class="comments"> <unload></div><br/>
<div class="comments"> livery_update.stop();</div><br/>
<div class="comments"> </unload></div><br/>
<div class="comments"> </nasal></div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>livery_update</i></b><b>.new</b> ( <font color="#cc0000">liveriesdir, interval = 10.01, callback = nil</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>livery_update</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">overlay_update</font></u></i></b></h4>
<div class="comments"> overlay_update</div><br/>
<hr/><div class="comments"> Class for maintaining overlays in MP aircraft. It is used in Nasal code that's</div><br/>
<div class="comments"> embedded in aircraft animation XML files, and checks in intervals whether the</div><br/>
<div class="comments"> parent aircraft has changed an overlay, in which case it copies the respective</div><br/>
<div class="comments"> overlay to the aircraft's root directory.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> livery_update.new();</div><br/>
<div class="comments"> livery_update.add(<overlay-dir>, <property> [, <callback>]);</div><br/>
<div class="comments"> <overlay-dir> ... directory with overlay files, relative to $FG_ROOT</div><br/>
<div class="comments"> <property> ... MP property where the overlay file name can be found</div><br/>
<div class="comments"> (usually one of the sim/multiplay/generic/string properties)</div><br/>
<div class="comments"> <callback> ... callback function that's called with two arguments:</div><br/>
<div class="comments"> the file name (without extension) and the overlay directory</div><br/>
<div class="comments"> EXAMPLE:</div><br/>
<div class="comments"> <nasal></div><br/>
<div class="comments"> <load></div><br/>
<div class="comments"> var update = aircraft.overlay_update.new();</div><br/>
<div class="comments"> update.add("Aircraft/F4U/Models/Logos", "sim/multiplay/generic/string");</div><br/>
<div class="comments"> </load></div><br/>
<div class="comments"> <unload></div><br/>
<div class="comments"> update.stop();</div><br/>
<div class="comments"> </unload></div><br/>
<div class="comments"> </nasal></div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>overlay_update</i></b><b>.new</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>overlay_update</i></b><b>.add</b> ( <font color="#cc0000">path, prop, callback = nil</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>overlay_update</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>overlay_update</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">steering</font></u></i></b></h4>
<div class="comments"> steering</div><br/>
<hr/><div class="comments"> Class that implements differential braking depending on rudder position.</div><br/>
<div class="comments"> Note that this overrides the controls.applyBrakes() wrapper. If you need</div><br/>
<div class="comments"> your own version, then override it again after the steering.init() call.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> steering.init([<property> [, <threshold>]]);</div><br/>
<div class="comments"> <property> ... property path or props.Node hash that enables/disables</div><br/>
<div class="comments"> brake steering (usually bound to the js trigger button)</div><br/>
<div class="comments"> <threshold> ... defines range (+- threshold) around neutral rudder</div><br/>
<div class="comments"> position in which both brakes are applied</div><br/>
<div class="comments"> EXAMPLES:</div><br/>
<div class="comments"> aircraft.steering.init("/controls/gear/steering", 0.2);</div><br/>
<div class="comments"> aircraft.steering.init();</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>steering</i></b><b>.init</b> ( <font color="#cc0000">switch = </font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>steering</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>steering</i></b><b>.setbrakes</b> ( <font color="#cc0000">left, right</font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">autotrim</font></u></i></b></h4>
<div class="comments"> autotrim</div><br/>
<hr/><div class="comments"> Singleton class that supports quick trimming and compensates for the lack</div><br/>
<div class="comments"> of resistance/force feedback in most joysticks. Normally the pilot trims such</div><br/>
<div class="comments"> that no real or artificially generated (by means of servo motors and spring</div><br/>
<div class="comments"> preloading) forces act on the stick/yoke and it is in a comfortable position.</div><br/>
<div class="comments"> This doesn't work well on computer joysticks.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> autotrim.start(); on key/button press</div><br/>
<div class="comments"> autotrim.stop(); on key/button release (mod-up)</div><br/>
<div class="comments"> USAGE:</div><br/>
<div class="comments"> (1) move the stick such that the aircraft is in an orientation that</div><br/>
<div class="comments"> you want to trim for (forward flight, hover, ...)</div><br/>
<div class="comments"> (2) press autotrim button and keep it pressed</div><br/>
<div class="comments"> (3) move stick/yoke to neutral position (center)</div><br/>
<div class="comments"> (4) release autotrim button</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.start</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.update</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.new</b> ( <font color="#cc0000">name</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.start</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>autotrim</i></b><b>.update</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">tyresmoke</font></u></i></b></h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke</i></b><b>.new</b> ( <font color="#cc0000">number, auto = 0, diff_norm = 0.05, check_vspeed=1</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke</i></b><b>.del</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke</i></b><b>.update</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke</i></b><b>.<font color="#0000cc">_wowchanged_</font></b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">tyresmoke_system</font></u></i></b></h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke_system</i></b><b>.new</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>tyresmoke_system</i></b><b>.del</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">rain</font></u></i></b></h4>
<div class="comments"> rain</div><br/>
<hr/><div class="comments"> Provides a property which can be used to control rain. Can be used to turn</div><br/>
<div class="comments"> off rain in internal views, and or used with a texture on canopies etc.</div><br/>
<div class="comments"> The output is co-ordinated with system precipitation:</div><br/>
<div class="comments"> /sim/model/rain/raining-norm rain intensity</div><br/>
<div class="comments"> /sim/model/rain/flow-mps drop flow speed [m/s]</div><br/>
<div class="comments"> See Hawker Seahawk for an example.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> aircraft.rain.init();</div><br/>
<div class="comments"> aircraft.rain.update();</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>rain</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>rain</i></b><b>.update</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>aircraft</b>.<b>teleport</b> ( <font color="#cc0000">airport = speed = 0, distance = 0, azimuth = 0, glideslope = 0, heading = 9999</font> )</h4>
<div class="comments"> teleport</div><br/>
<hr/><div class="comments"> Usage: aircraft.teleport(lat:48.3, lon:32.4, alt:5000);</div><br/>
</div>
<div><h4 class="function"><b>aircraft</b>.<b>wind_speed_from</b> ( <font color="#cc0000">azimuth</font> )</h4>
<div class="comments"> returns wind speed [kt] from given direction [deg]; useful for head-wind</div><br/>
</div>
<div><h4 class="function"><b>aircraft</b>.<b>kias_to_ktas</b> ( <font color="#cc0000">kias, altitude</font> )</h4>
<div class="comments"> returns true airspeed for given indicated airspeed [kt] and altitude [m]</div><br/>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">HUD</font></u></i></b></h4>
<div class="comments"> HUD control class to handle both HUD implementations</div><br/>
<hr/></div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.cycle_color</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.cycle_brightness</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.normal_type</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.cycle_type</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>HUD</i></b><b>.is_active</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>aircraft</b>.<b><i><u><font color="#000000">crossfeed_valve</font></u></i></b></h4>
<div class="comments"> crossfeed_valve</div><br/>
<hr/><div class="comments"> class that creates a fuel tank cross-feed valve. Designed for YASim aircraft;</div><br/>
<div class="comments"> JSBSim aircraft can simply use systems code within the FDM (see 747-400 for</div><br/>
<div class="comments"> an example).</div><br/>
<div class="comments"> WARNING: this class requires the tank properties to be ready, so call new()</div><br/>
<div class="comments"> after the FDM is initialized.</div><br/>
<div class="comments"> SYNOPSIS:</div><br/>
<div class="comments"> crossfeed_valve.new(<max_flow_rate>, <property>, <tank>, <tank>, ... );</div><br/>
<div class="comments"> crossfeed_valve.open(<update>);</div><br/>
<div class="comments"> crossfeed_valve.close(<update>);</div><br/>
<div class="comments"> <max_flow_rate> ... maximum transfer rate between the tanks in lbs/sec</div><br/>
<div class="comments"> <property> ... property path to use as switch - pass nil to use no such switch</div><br/>
<div class="comments"> <tank> ... number of a tank to connect - can have unlimited number of tanks connected</div><br/>
<div class="comments"> <update> ... update switch property when opening/closing valve via Nasal - 0 or 1; by default, 1</div><br/>
<div class="comments"> EXAMPLES:</div><br/>
<div class="comments"> aircraft.crossfeed_valve.new(0.5, "/controls/fuel/x-feed", 0, 1, 2);</div><br/>
<div class="comments">-------</div><br/>
<div class="comments"> var xfeed = aircraft.crossfeed_valve.new(1, nil, 0, 1);</div><br/>
<div class="comments"> xfeed.open();</div><br/>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>crossfeed_valve</i></b><b>.new</b> ( <font color="#cc0000">flow_rate, path</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>crossfeed_valve</i></b><b>.open</b> ( <font color="#cc0000">update_prop = 1</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>crossfeed_valve</i></b><b>.close</b> ( <font color="#cc0000">update_prop = 1</font> )</h4>
</div>
<div><h4 class="class_function"><b>aircraft</b>.<b><i>crossfeed_valve</i></b><b>.<font color="#0000cc">_loop_</font></b> ( <font color="#cc0000">id</font> )</h4>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="aurora">aurora</a></h2>
<div><h4 class="class_definition"><b>aurora</b>.<b><i><u><font color="#000000">aurora_manager</font></u></i></b></h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.state</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.start</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.update</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>aurora</b>.<b><i>aurora_manager</i></b><b>.evolve</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="bits">bits</a></h2>
<div><h4 class="function"><b>bits</b>.<b>test</b> ( <font color="#cc0000">n, b</font> )</h4>
<div class="comments"> checks whether bit <b> is set in number <n></div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>set</b> ( <font color="#cc0000">n, b</font> )</h4>
<div class="comments"> returns number <n> with bit <b> set</div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>clear</b> ( <font color="#cc0000">n, b</font> )</h4>
<div class="comments"> returns number <n> with bit <b> cleared</div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>toggle</b> ( <font color="#cc0000">n, b</font> )</h4>
<div class="comments"> returns number <n> with bit <b> toggled</div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>switch</b> ( <font color="#cc0000">n, b, v</font> )</h4>
<div class="comments"> returns number <n> with bit <b> set to value <v></div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>string</b> ( <font color="#cc0000">n, len = 1</font> )</h4>
<div class="comments"> returns number <n> as bit string, zero-padded to <len> digits:</div><br/>
<div class="comments"> bits.string(6) -> "110"</div><br/>
<div class="comments"> bits.string(6, 8) -> "00000110"</div><br/>
</div>
<div><h4 class="function"><b>bits</b>.<b>value</b> ( <font color="#cc0000">s</font> )</h4>
<div class="comments"> returns bit string <s> as number: bits.value("110") -> 6</div><br/>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="checklist">checklist</a></h2>
<div><h4 class="function"><b>checklist</b>.<b>convert_checklists</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> Convert checklists into full tutorials.</div><br/>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="contrail">contrail</a></h2>
<div class="container" style="">
<h2 class="namespace_title"><a name="controls">controls</a></h2>
<div><h4 class="function"><b>controls</b>.<b>startEngine</b> ( <font color="#cc0000">v = 1, which...</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>selectEngine</b> ( <font color="#cc0000">which</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>selectEngines</b> ( <font color="#cc0000">state, which...</font> )</h4>
<div class="comments"> Selects (state=1) or deselects (state=0) a list of engines, or all</div><br/>
<div class="comments"> engines if no list is specified. Example: selectEngines(1, 1, 3, 5);</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>selectAllEngines</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>stepMagnetos</b> ( <font color="#cc0000">change</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>centerFlightControls</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>throttleMouse</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>axisHandler</b> ( <font color="#cc0000">pre, post</font> )</h4>
<div class="comments"> Joystick axis handlers (use cmdarg). Shouldn't be called from</div><br/>
<div class="comments"> other contexts. A non-null argument reverses the axis direction.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>perIndexAxisHandler</b> ( <font color="#cc0000">pre, post</font> )</h4>
<div class="comments"> Joystick axis handler for controlling subsets of similar properties.</div><br/>
<div class="comments"> Shouldn't be called from other contexts.</div><br/>
<div class="comments"> The argument engine can be either an index number or a list of</div><br/>
<div class="comments"> index numbers.</div><br/>
<div class="comments"> Use only when perEngineSelectedAxisHandler() below will not do.</div><br/>
</div>
<div><h4 class="class_definition"><b>controls</b>.<b><i><u><font color="#000000">_axisMode</font></u></i></b></h4>
<div class="comments"> Joystick axis handler for controlling a selected axis on specific engines.</div><br/>
<div class="comments"> Shouldn't be called from other contexts.</div><br/>
<div class="comments"> The argument mode can be</div><br/>
<div class="comments"> 0 - throttle</div><br/>
<div class="comments"> 1 - mixture</div><br/>
<div class="comments"> 2 - propeller-pitch</div><br/>
<div class="comments"> The argument engine to the returned function can be either an</div><br/>
<div class="comments"> engine number or a list of engine numbers.</div><br/>
<div class="comments"> Usage example (controlling the mixture of engines 0 and 1):</div><br/>
<div class="comments"> <script></div><br/>
<div class="comments"> controls.perEngineSelectedAxisHandler(1)([0,1]);</div><br/>
<div class="comments"> </script></div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>perEngineSelectedAxisHandler</b> ( <font color="#cc0000">mode</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>flapsDown</b> ( <font color="#cc0000">step</font> )</h4>
<div class="comments"> Wrapper around stepProps() which emulates the "old" flap behavior for</div><br/>
<div class="comments"> configurations that aren't using the new mechanism.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>wingSweep</b> ( <font color="#cc0000">step</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>wingsDown</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>stepSpoilers</b> ( <font color="#cc0000">step</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>stepSlats</b> ( <font color="#cc0000">step</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>stepProps</b> ( <font color="#cc0000">dst, array, delta</font> )</h4>
<div class="comments"> Steps through an "array" of property settings. The first argument</div><br/>
<div class="comments"> specifies a destination property. The second is a string containing</div><br/>
<div class="comments"> a global property tree. This tree should contain an array of</div><br/>
<div class="comments"> indexed <setting> children. This function will maintain a</div><br/>
<div class="comments"> <current-setting> child, which contains the index of the currently</div><br/>
<div class="comments"> active setting. The third argument specifies an integer delta,</div><br/>
<div class="comments"> indicating how many steps to move through the setting array.</div><br/>
<div class="comments"> Note that because of the magic of the property system, this</div><br/>
<div class="comments"> mechanism works for all scalar property types (bool, int, double,</div><br/>
<div class="comments"> string).</div><br/>
<div class="comments"> TODO: This interface could easily be extended to allow for wrapping,</div><br/>
<div class="comments"> in addition to clamping, allowing a "cycle" of settings to be</div><br/>
<div class="comments"> defined. It could also be hooked up with the interpolate() call,</div><br/>
<div class="comments"> which would allow the removal of the transition-time feature from</div><br/>
<div class="comments"> YASim. Finally, other pre-existing features (the views and engine</div><br/>
<div class="comments"> magnetos, for instance), work similarly but not compatibly, and</div><br/>
<div class="comments"> could be integrated.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>slewProp</b> ( <font color="#cc0000">prop, delta</font> )</h4>
<div class="comments"> "Slews" a property smoothly, without dependence on the simulator</div><br/>
<div class="comments"> frame rate. The first argument is the property name. The second is</div><br/>
<div class="comments"> a rate, in units per second. NOTE: this modifies the property for</div><br/>
<div class="comments"> the current frame only; it is intended to be called by bindings</div><br/>
<div class="comments"> which repeat each frame. If you want to cause motion over time, see</div><br/>
<div class="comments"> interpolate(). Returns new value.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>elevatorTrim</b> ( <font color="#cc0000">speed</font> )</h4>
<div class="comments"> Handlers. These are suitable for binding to repeatable button press</div><br/>
<div class="comments"> events. They are *not* good for binding to the keyboard, since (at</div><br/>
<div class="comments"> least) X11 synthesizes its own key repeats.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>aileronTrim</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>rudderTrim</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>adjThrottle</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>adjMixture</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>adjCondition</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>adjPropeller</b> ( <font color="#cc0000">speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>adjEngControl</b> ( <font color="#cc0000">prop, speed</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>incThrottle</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> arg[0] is the throttle increment</div><br/>
<div class="comments"> arg[1] is the auto-throttle target speed increment</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>incAileron</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> arg[0] is the aileron increment</div><br/>
<div class="comments"> arg[1] is the autopilot target heading increment</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>incElevator</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> arg[0] is the elevator increment</div><br/>
<div class="comments"> arg[1] is the autopilot target altitude increment</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>elevatorTrimAxis</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> Joystick axis handlers. Don't call from other contexts.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>aileronTrimAxis</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>rudderTrimAxis</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>gearTogglePosition</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> to avoid clash with "gearToggle"; this will only toggle when</div><br/>
<div class="comments"> given a parameter of 1; as the controls button binding will pass 0 when the button is pressed and</div><br/>
<div class="comments"> 1 when the button is released.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>gearDown</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> Gear handling.</div><br/>
<div class="comments"> - parameter v is either 1 (down), -1 up (retracted)</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>gearToggle</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>applyBrakes</b> ( <font color="#cc0000">v, which = 0</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>applyPickle</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>applyParkingBrake</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>parkingBrakeToggle</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>toggleNWS</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>applyApplicableBrakes</b> ( <font color="#cc0000">v, which = 0</font> )</h4>
<div class="comments"> allows one binding to do airbrakes and wheel brakes</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>deployChute</b> ( <font color="#cc0000">v</font> )</h4>
<div class="comments"> 1: Deploy, -1: Release</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>trigger</b> ( <font color="#cc0000">b</font> )</h4>
<div class="comments"> Weapon handling.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>weaponSelect</b> ( <font color="#cc0000">d</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>ptt</b> ( <font color="#cc0000">b</font> )</h4>
<div class="comments"> Communication.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>toggleLights</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> Lighting.</div><br/>
</div>
<div><h4 class="function"><b>controls</b>.<b>replaySkip</b> ( <font color="#cc0000">skip_time</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>speedup</b> ( <font color="#cc0000">speed_up</font> )</h4>
</div>
<div><h4 class="function"><b>controls</b>.<b>cycleMouseMode</b> ( <font color="#cc0000">node</font> )</h4>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="debug">debug</a></h2>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_title</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
<div class="comments"> ANSI color code wrappers (see $ man console_codes)</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_section</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_error</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_bench</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_nil</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_string</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_num</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_bracket</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_brace</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_angle</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_vartype</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_proptype</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_path</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_internal</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_varname</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>propify</b> ( <font color="#cc0000">p, create = 0</font> )</h4>
<div class="comments"> Turn p into props.Node (if it isn't yet), or return nil.</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>tree</b> ( <font color="#cc0000">n = </font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_tree</font></b> ( <font color="#cc0000">n, graph = 1, prefix = </font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>attributes</b> ( <font color="#cc0000">p, verbose = 1, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_dump_prop</font></b> ( <font color="#cc0000">p, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_dump_var</font></b> ( <font color="#cc0000">v, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_dump_string</font></b> ( <font color="#cc0000">str, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b><font color="#0000cc">_dump_key</font></b> ( <font color="#cc0000">s, color=nil</font> )</h4>
<div class="comments"> dump hash keys as variables if they are valid variable names, or as string otherwise</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>string</b> ( <font color="#cc0000">o, color=nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>dump</b> ( <font color="#cc0000">vars...</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>local</b> ( <font color="#cc0000">frame = 0</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>backtrace</b> ( <font color="#cc0000">desc = nil, dump_vars = 1, skip_level = 0</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>proptrace</b> ( <font color="#cc0000">root = </font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>benchmark</b> ( <font color="#cc0000">label, fn, repeat = nil, output=nil</font> )</h4>
<div class="comments"> Executes function fn "repeat" times and prints execution time in seconds. If repeat</div><br/>
<div class="comments"> is an integer and an optional "output" argument is specified, each test's result</div><br/>
<div class="comments"> is appended to that vector, then the vector is returned. If repeat is nil, then</div><br/>
<div class="comments"> the funciton is run once and the result returned. Otherwise, the result is discarded.</div><br/>
<div class="comments"> Examples:</div><br/>
<div class="comments"> var test = func { getprop("/sim/aircraft"); }</div><br/>
<div class="comments"> debug.benchmark("test()/1", test, 1000);</div><br/>
<div class="comments"> debug.benchmark("test()/2", func setprop("/sim/aircraft", ""), 1000);</div><br/>
<div class="comments"> var results = debug.benchmark("test()", test, 1000, []);</div><br/>
<div class="comments"> print(" Results were:");</div><br/>
<div class="comments"> print(" ", debug.string(results));</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>benchmark_time</b> ( <font color="#cc0000">fn, repeat = 1, output = nil</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>rank</b> ( <font color="#cc0000">list, repeat = nil</font> )</h4>
<div class="comments"> Executes each function in the list and returns a sorted vector with the fastest</div><br/>
<div class="comments"> on top (i.e. first). Each position in the result is a vector of [func, time].</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>print_rank</b> ( <font color="#cc0000">label, list, names</font> )</h4>
</div>
<div><h4 class="function"><b>debug</b>.<b>printerror</b> ( <font color="#cc0000">err</font> )</h4>
<div class="comments"> print error vector as set by call(). By using call() one can execute</div><br/>
<div class="comments"> code that catches "exceptions" (by a die() call or errors). The Nasal</div><br/>
<div class="comments"> code doesn't abort in this case. Example:</div><br/>
<div class="comments"> var possibly_buggy = func { ... }</div><br/>
<div class="comments"> call(possibly_buggy, nil, var err = []);</div><br/>
<div class="comments"> debug.printerror(err);</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>warn</b> ( <font color="#cc0000">msg, level = 0</font> )</h4>
<div class="comments"> like die(), but code execution continues. The level argument defines</div><br/>
<div class="comments"> how many caller() levels to omit. One is automatically omitted, as</div><br/>
<div class="comments"> this would only point to debug.warn(), where the event in question</div><br/>
<div class="comments"> didn't happen.</div><br/>
</div>
<div><h4 class="function"><b>debug</b>.<b>isnan</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_definition"><b>debug</b>.<b><i><u><font color="#000000">Probe</font></u></i></b></h4>
<div class="comments"> Probe class - collect statistics; controlled via property tree</div><br/>
<div class="comments"> Data can be viewed / modified in the prop tree /_debug/nas/probe-<myLabel>/*</div><br/>
<div class="comments"> ./enable bool, </div><br/>
<div class="comments"> ./reset bool, reset hit counters to 0 and _start_time to now</div><br/>
<div class="comments"> ./hits[i] number of hits, by default i=0 -> hits</div><br/>
<div class="comments"> secondary counters can be added under the same path </div><br/>
<div class="comments"> with addCounter()</div><br/>
<div class="comments"> ./time after generateStats() show how long the probe was enabled</div><br/>
<div class="comments"> ./hps after generateStats() show avg. hits/second</div><br/>
<div class="comments"> ./hitratio after generateStats() if two counters: hits[1]/hits[0]</div><br/>
<div class="comments"> == Example == </div><br/>
<div class="comments"> var myProbe = debug.Probe.new("myLabel").enable();</div><br/>
<div class="comments"> var cnt2 = myProbe.addCounter(); create a 2nd counter</div><br/>
<div class="comments"> at the place of interest (e.g. in some loop or class method) insert:</div><br/>
<div class="comments"> myProbe.hit(); count how often this place in the code is hit</div><br/>
<div class="comments"> if (condition) </div><br/>
<div class="comments"> myProbe.hit(cnt2); count how often condition is true</div><br/>
<div class="comments"> print(myProbe.getHits()); </div><br/>
<div class="comments"> print(myProbe.getHits(cnt2)/myProbe.getHits()); print hit ratio</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.new</b> ( <font color="#cc0000">label, class = </font> )</h4>
<div class="comments"> label: Used in property path </div><br/>
<div class="comments"> prefix: Optional </div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.reset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.setTimeout</b> ( <font color="#cc0000">seconds</font> )</h4>
<div class="comments"> set timeout, next hit() after timeout will disable()</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.enable</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> enable counting </div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.disable</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> disable counting, write time and hit/s to property tree</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.generateStats</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.getHits</b> ( <font color="#cc0000">counter_id = 0</font> )</h4>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.addCounter</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> add secondary counter(s)</div><br/>
<div class="comments"> returns counter id</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Probe</i></b><b>.hit</b> ( <font color="#cc0000">counter_id = 0, callback = nil</font> )</h4>
<div class="comments"> increase counter (if enabled)</div><br/>
<div class="comments"> use addCounter() before using counter_id > 0</div><br/>
</div>
<div><h4 class="class_definition"><b>debug</b>.<b><i><u><font color="#000000">Breakpoint</font></u></i></b></h4>
<div class="comments"> Breakpoint (BP) - do conditional backtrace (BT) controlled via property tree</div><br/>
<div class="comments"> * count how often the BP was hit</div><br/>
<div class="comments"> * do only a limited number of BT, avoid flooding the log / console</div><br/>
<div class="comments"> Data can be viewed / modified in the prop tree /_debug/nas/bp-<myLabel>/*</div><br/>
<div class="comments"> * tokens: number of backtraces to do; each hit will decrease this by 1</div><br/>
<div class="comments"> * hits: total number of hits</div><br/>
<div class="comments"> == Example == </div><br/>
<div class="comments"> var myBP = debug.Breakpoint.new("myLabel", 0);</div><br/>
<div class="comments"> myBP.enable(4); allow 4 hits, then be quiet </div><br/>
<div class="comments"> at the place of interest (e.g. in some loop or class method) insert:</div><br/>
<div class="comments"> myBP.hit(); do backtrace here if tokens > 0, reduce tokens by 1</div><br/>
<div class="comments"> myBP.hit(myFunction); same but call myFunction instead of backtrace</div><br/>
<div class="comments"> print(myBP.getHits()); print total number of hits</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Breakpoint</i></b><b>.new</b> ( <font color="#cc0000">label, dump_locals = 1</font> )</h4>
<div class="comments"> label: Used in property path and as text for backtrace.</div><br/>
<div class="comments"> dump_locals: bool passed to backtrace. Dump variables in BT.</div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Breakpoint</i></b><b>.enable</b> ( <font color="#cc0000">tokens = 1</font> )</h4>
<div class="comments"> enable BP and set hit limit; </div><br/>
<div class="comments"> tokens: int > 0; default: 1 (single shot); 0 allowed (=disable); </div><br/>
</div>
<div><h4 class="class_function"><b>debug</b>.<b><i>Breakpoint</i></b><b>.hit</b> ( <font color="#cc0000">callback = nil</font> )</h4>
<div class="comments"> hit the breakpoint, e.g. do backtrace if we have tokens available</div><br/>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="dynamic_view">dynamic_view</a></h2>
<div><h4 class="function"><b>dynamic_view</b>.<b>sin</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>cos</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>sigmoid</b> ( <font color="#cc0000">x</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>nsigmoid</b> ( <font color="#cc0000">x</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>pow</b> ( <font color="#cc0000">v, w</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>npow</b> ( <font color="#cc0000">v, w</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>clamp</b> ( <font color="#cc0000">v, min, max</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>normatan</b> ( <font color="#cc0000">x</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>normdeg</b> ( <font color="#cc0000">a</font> )</h4>
</div>
<div><h4 class="class_definition"><b>dynamic_view</b>.<b><i><u><font color="#000000">Input</font></u></i></b></h4>
<div class="comments"> Class that reads a property value, applies factor & offset, clamps to min & max,</div><br/>
<div class="comments"> and optionally lowpass filters.</div><br/>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>Input</i></b><b>.new</b> ( <font color="#cc0000">prop = </font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>Input</i></b><b>.get</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>Input</i></b><b>.set</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_definition"><b>dynamic_view</b>.<b><i><u><font color="#000000">ViewAxis</font></u></i></b></h4>
<div class="comments"> Class that maintains one sim/current-view/goal-*-offset-deg property.</div><br/>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.new</b> ( <font color="#cc0000">prop</font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.reset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.add_offset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.sub_offset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.apply</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>ViewAxis</i></b><b>.static</b> ( <font color="#cc0000">v</font> )</h4>
</div>
<div><h4 class="class_definition"><b>dynamic_view</b>.<b><i><u><font color="#000000">view_manager</font></u></i></b></h4>
<div class="comments"> Singleton class that manages a dynamic cockpit view by manipulating</div><br/>
<div class="comments"> sim/current-view/goal-*-offset-deg properties.</div><br/>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.init</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.reset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.add_offset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.apply</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.lookat</b> ( <font color="#cc0000">heading, pitch, roll, x, y, z, time, fov</font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.resume</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.freeze</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.unfreeze</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.default_plane</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> default calculations for a plane</div><br/>
</div>
<div><h4 class="class_function"><b>dynamic_view</b>.<b><i>view_manager</i></b><b>.default_helicopter</b> ( <font color="#cc0000"></font> )</h4>
<div class="comments"> default calculations for a helicopter</div><br/>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>main_loop</b> ( <font color="#cc0000">id</font> )</h4>
<div class="comments"> Update loop for the whole dynamic view manager. It only runs if</div><br/>
<div class="comments"> /sim/current-view/dynamic-view is true.</div><br/>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>freeze</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>register</b> ( <font color="#cc0000">f</font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>reset</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>lookat</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>dynamic_view</b>.<b>resume</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div class="container" style="">
<h2 class="namespace_title"><a name="earthview">earthview</a></h2>
<div><h4 class="function"><b>earthview</b>.<b>check_lightning_table</b> ( <font color="#cc0000">lat, lon</font> )</h4>
</div>
<div><h4 class="function"><b>earthview</b>.<b>start</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>earthview</b>.<b>stop</b> ( <font color="#cc0000"></font> )</h4>
</div>
<div><h4 class="function"><b>earthview</b>.<b>place_earth_model</b> ( <font color="#cc0000">path, lat, lon, alt, heading, pitch, roll</font> )</h4>