-
Notifications
You must be signed in to change notification settings - Fork 4
/
bge.logic.html
2673 lines (2358 loc) · 183 KB
/
bge.logic.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Game Logic (bge.logic) — Blender Python API</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme_overrides.css" type="text/css" />
<link rel="stylesheet" href="_static/css/version_switch.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="canonical" href="https://upbge.org/docs/latest/api/bge.logic.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=715c20a1"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/version_switch.js?v=fa006b38"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Blender Python API"
href="_static/opensearch.xml"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Rasterizer (bge.render)" href="bge.render.html" />
<link rel="prev" title="SCA_XORController(SCA_IController)" href="bge.types.SCA_XORController.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
UPBGE 0.3+ + Blender 4.0.0 Alpha Python API
<img src="_static/upbge_logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Application Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bpy.context.html">Context Access (bpy.context)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.data.html">Data Access (bpy.data)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.msgbus.html">Message Bus (bpy.msgbus)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.ops.html">Operators (bpy.ops)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.types.html">Types (bpy.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.utils.html">Utilities (bpy.utils)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.path.html">Path Utilities (bpy.path)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.app.html">Application Data (bpy.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.props.html">Property Definitions (bpy.props)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Game Engine Modules</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="bge.types.html">Game Types (bge.types)</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Game Logic (bge.logic)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.render.html">Rasterizer (bge.render)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html">Video Texture (bge.texture)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#ffmpeg-video-and-image-status">FFmpeg Video and Image Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#image-blending-modes">Image Blending Modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.events.html">Game Keys (bge.events)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.constraints.html">Physics Constraints (bge.constraints)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.app.html">Application Data (bge.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgui.html">Game GUI (bgui)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Standalone Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="aud.html">Audio System (aud)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgl.html">OpenGL Wrapper (bgl)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bl_math.html">Additional Math Functions (bl_math)</a></li>
<li class="toctree-l1"><a class="reference internal" href="blf.html">Font Drawing (blf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bmesh.html">BMesh Module (bmesh)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy_extras.html">Extra Utilities (bpy_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="freestyle.html">Freestyle Module (freestyle)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu.html">GPU Module (gpu)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu_extras.html">GPU Utilities (gpu_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="idprop.types.html">ID Property Access (idprop.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="imbuf.html">Image Buffer (imbuf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="mathutils.html">Math Types & Utilities (mathutils)</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UPBGE 0.3+ + Blender 4.0.0 Alpha Python API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Game Logic (bge.logic)</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="game-logic-bge-logic">
<h1>Game Logic (bge.logic)<a class="headerlink" href="#game-logic-bge-logic" title="Link to this heading"></a></h1>
<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h2>
<p>Module to access logic functions, imported automatically into the python controllers namespace.</p>
<div class="highlight-python notranslate" id="module-bge.logic"><div class="highlight"><pre><span></span><span class="c1"># To get the controller thats running this python script:</span>
<span class="n">cont</span> <span class="o">=</span> <span class="n">bge</span><span class="o">.</span><span class="n">logic</span><span class="o">.</span><span class="n">getCurrentController</span><span class="p">()</span> <span class="c1"># bge.logic is automatically imported</span>
<span class="c1"># To get the game object this controller is on:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="n">cont</span><span class="o">.</span><span class="n">owner</span>
</pre></div>
</div>
<p><a class="reference internal" href="bge.types.KX_GameObject.html#bge.types.KX_GameObject" title="bge.types.KX_GameObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">KX_GameObject</span></code></a> and <a class="reference internal" href="bge.types.KX_Camera.html#bge.types.KX_Camera" title="bge.types.KX_Camera"><code class="xref py py-class docutils literal notranslate"><span class="pre">KX_Camera</span></code></a> or <a class="reference internal" href="bge.types.KX_LightObject.html#bge.types.KX_LightObject" title="bge.types.KX_LightObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">KX_LightObject</span></code></a> methods are available depending on the type of object</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># To get a sensor linked to this controller.</span>
<span class="c1"># "sensorname" is the name of the sensor as defined in the Blender interface.</span>
<span class="c1"># +---------------------+ +--------+</span>
<span class="c1"># | Sensor "sensorname" +--+ Python +</span>
<span class="c1"># +---------------------+ +--------+</span>
<span class="n">sens</span> <span class="o">=</span> <span class="n">cont</span><span class="o">.</span><span class="n">sensors</span><span class="p">[</span><span class="s2">"sensorname"</span><span class="p">]</span>
<span class="c1"># To get a sequence of all sensors:</span>
<span class="n">sensors</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">sensors</span>
</pre></div>
</div>
<p>See the sensor’s reference for available methods:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_MouseFocusSensor.html#bge.types.SCA_MouseFocusSensor" title="bge.types.SCA_MouseFocusSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_MouseFocusSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_NearSensor.html#bge.types.SCA_NearSensor" title="bge.types.SCA_NearSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_NearSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_NetworkMessageSensor.html#bge.types.SCA_NetworkMessageSensor" title="bge.types.SCA_NetworkMessageSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_NetworkMessageSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_RadarSensor.html#bge.types.SCA_RadarSensor" title="bge.types.SCA_RadarSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_RadarSensor</span></code></a></p></li>
</ul>
</td><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_RaySensor.html#bge.types.SCA_RaySensor" title="bge.types.SCA_RaySensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_RaySensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_CollisionSensor.html#bge.types.SCA_CollisionSensor" title="bge.types.SCA_CollisionSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_CollisionSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_DelaySensor.html#bge.types.SCA_DelaySensor" title="bge.types.SCA_DelaySensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_DelaySensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_JoystickSensor.html#bge.types.SCA_JoystickSensor" title="bge.types.SCA_JoystickSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_JoystickSensor</span></code></a></p></li>
</ul>
</td><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_KeyboardSensor.html#bge.types.SCA_KeyboardSensor" title="bge.types.SCA_KeyboardSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_KeyboardSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_MouseSensor.html#bge.types.SCA_MouseSensor" title="bge.types.SCA_MouseSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_MouseSensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_PropertySensor.html#bge.types.SCA_PropertySensor" title="bge.types.SCA_PropertySensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PropertySensor</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_RandomSensor.html#bge.types.SCA_RandomSensor" title="bge.types.SCA_RandomSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_RandomSensor</span></code></a></p></li>
</ul>
</td></tr></table>
<p>You can also access actuators linked to the controller</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># To get an actuator attached to the controller:</span>
<span class="c1"># +--------+ +-------------------------+</span>
<span class="c1"># + Python +--+ Actuator "actuatorname" |</span>
<span class="c1"># +--------+ +-------------------------+</span>
<span class="n">actuator</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">actuators</span><span class="p">[</span><span class="s2">"actuatorname"</span><span class="p">]</span>
<span class="c1"># Activate an actuator</span>
<span class="n">controller</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="n">actuator</span><span class="p">)</span>
</pre></div>
</div>
<p>See the actuator’s reference for available methods</p>
<table class="hlist"><tr><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_ActionActuator.html#bge.types.SCA_ActionActuator" title="bge.types.SCA_ActionActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_ActionActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_CameraActuator.html#bge.types.SCA_CameraActuator" title="bge.types.SCA_CameraActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_CameraActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_ConstraintActuator.html#bge.types.SCA_ConstraintActuator" title="bge.types.SCA_ConstraintActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_ConstraintActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_GameActuator.html#bge.types.SCA_GameActuator" title="bge.types.SCA_GameActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_GameActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_MouseActuator.html#bge.types.SCA_MouseActuator" title="bge.types.SCA_MouseActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_MouseActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_NetworkMessageActuator.html#bge.types.SCA_NetworkMessageActuator" title="bge.types.SCA_NetworkMessageActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_NetworkMessageActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_ObjectActuator.html#bge.types.SCA_ObjectActuator" title="bge.types.SCA_ObjectActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_ObjectActuator</span></code></a></p></li>
</ul>
</td><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_ParentActuator.html#bge.types.SCA_ParentActuator" title="bge.types.SCA_ParentActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_ParentActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_AddObjectActuator.html#bge.types.SCA_AddObjectActuator" title="bge.types.SCA_AddObjectActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_AddObjectActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_DynamicActuator.html#bge.types.SCA_DynamicActuator" title="bge.types.SCA_DynamicActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_DynamicActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_EndObjectActuator.html#bge.types.SCA_EndObjectActuator" title="bge.types.SCA_EndObjectActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_EndObjectActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_ReplaceMeshActuator.html#bge.types.SCA_ReplaceMeshActuator" title="bge.types.SCA_ReplaceMeshActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_ReplaceMeshActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_SceneActuator.html#bge.types.SCA_SceneActuator" title="bge.types.SCA_SceneActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_SceneActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_SoundActuator.html#bge.types.SCA_SoundActuator" title="bge.types.SCA_SoundActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_SoundActuator</span></code></a></p></li>
</ul>
</td><td><ul class="simple">
<li><p><a class="reference internal" href="bge.types.SCA_StateActuator.html#bge.types.SCA_StateActuator" title="bge.types.SCA_StateActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_StateActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_TrackToActuator.html#bge.types.SCA_TrackToActuator" title="bge.types.SCA_TrackToActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_TrackToActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_VisibilityActuator.html#bge.types.SCA_VisibilityActuator" title="bge.types.SCA_VisibilityActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_VisibilityActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_2DFilterActuator.html#bge.types.SCA_2DFilterActuator" title="bge.types.SCA_2DFilterActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_2DFilterActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_PropertyActuator.html#bge.types.SCA_PropertyActuator" title="bge.types.SCA_PropertyActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PropertyActuator</span></code></a></p></li>
<li><p><a class="reference internal" href="bge.types.SCA_RandomActuator.html#bge.types.SCA_RandomActuator" title="bge.types.SCA_RandomActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_RandomActuator</span></code></a></p></li>
</ul>
</td></tr></table>
<p>Most logic brick’s methods are accessors for the properties available in the logic buttons.
Consult the logic bricks documentation for more information on how each logic brick works.</p>
<p>There are also methods to access the current <a class="reference internal" href="bge.types.KX_Scene.html#bge.types.KX_Scene" title="bge.types.KX_Scene"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_Scene</span></code></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get the current scene</span>
<span class="n">scene</span> <span class="o">=</span> <span class="n">bge</span><span class="o">.</span><span class="n">logic</span><span class="o">.</span><span class="n">getCurrentScene</span><span class="p">()</span>
<span class="c1"># Get the current camera</span>
<span class="n">cam</span> <span class="o">=</span> <span class="n">scene</span><span class="o">.</span><span class="n">active_camera</span>
</pre></div>
</div>
<p>Matricies as used by the game engine are <strong>row major</strong>
<code class="docutils literal notranslate"><span class="pre">matrix[row][col]</span> <span class="pre">=</span> <span class="pre">float</span></code></p>
<p><a class="reference internal" href="bge.types.KX_Camera.html#bge.types.KX_Camera" title="bge.types.KX_Camera"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_Camera</span></code></a> has some examples using matrices.</p>
</section>
<section id="variables">
<h2>Variables<a class="headerlink" href="#variables" title="Link to this heading"></a></h2>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.globalDict">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">globalDict</span></span><a class="headerlink" href="#bge.logic.globalDict" title="Link to this definition"></a></dt>
<dd><p>A dictionary that is saved between loading blend files so you can use it to store inventory and other variables you want to store between scenes and blend files.
It can also be written to a file and loaded later on with the game load/save actuators.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>only python built in types such as int/string/bool/float/tuples/lists can be saved, GameObjects, Actuators etc will not work as expected.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dictionary</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.keyboard">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">keyboard</span></span><a class="headerlink" href="#bge.logic.keyboard" title="Link to this definition"></a></dt>
<dd><p>The current keyboard wrapped in an <a class="reference internal" href="bge.types.SCA_PythonKeyboard.html#bge.types.SCA_PythonKeyboard" title="bge.types.SCA_PythonKeyboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonKeyboard</span></code></a> object.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="bge.types.SCA_PythonKeyboard.html#bge.types.SCA_PythonKeyboard" title="bge.types.SCA_PythonKeyboard"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonKeyboard</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.mouse">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">mouse</span></span><a class="headerlink" href="#bge.logic.mouse" title="Link to this definition"></a></dt>
<dd><p>The current mouse wrapped in an <a class="reference internal" href="bge.types.SCA_PythonMouse.html#bge.types.SCA_PythonMouse" title="bge.types.SCA_PythonMouse"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonMouse</span></code></a> object.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="bge.types.SCA_PythonMouse.html#bge.types.SCA_PythonMouse" title="bge.types.SCA_PythonMouse"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonMouse</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.joysticks">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">joysticks</span></span><a class="headerlink" href="#bge.logic.joysticks" title="Link to this definition"></a></dt>
<dd><p>A list of attached <a class="reference internal" href="bge.types.SCA_PythonJoystick.html#bge.types.SCA_PythonJoystick" title="bge.types.SCA_PythonJoystick"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonJoystick</span></code></a>.
The list size is the maximum number of supported joysticks.
If no joystick is available for a given slot, the slot is set to None.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of <a class="reference internal" href="bge.types.SCA_PythonJoystick.html#bge.types.SCA_PythonJoystick" title="bge.types.SCA_PythonJoystick"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_PythonJoystick</span></code></a></p>
</dd>
</dl>
</dd></dl>
</section>
<section id="general-functions">
<h2>General functions<a class="headerlink" href="#general-functions" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getCurrentController">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getCurrentController</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getCurrentController" title="Link to this definition"></a></dt>
<dd><p>Gets the Python controller associated with this Python script.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="bge.types.SCA_PythonController.html#bge.types.SCA_PythonController" title="bge.types.SCA_PythonController"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.SCA_PythonController</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getCurrentScene">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getCurrentScene</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getCurrentScene" title="Link to this definition"></a></dt>
<dd><p>Gets the current Scene.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="bge.types.KX_Scene.html#bge.types.KX_Scene" title="bge.types.KX_Scene"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_Scene</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getSceneList">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getSceneList</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getSceneList" title="Link to this definition"></a></dt>
<dd><p>Gets a list of the current scenes loaded in the game engine. Since 0.3, it contains only the current KX_Scene.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of <a class="reference internal" href="bge.types.KX_Scene.html#bge.types.KX_Scene" title="bge.types.KX_Scene"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_Scene</span></code></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Scenes in your blend file that have not been converted wont be in this list. This list will only contain scenes such as overlays scenes.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getInactiveSceneNames">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getInactiveSceneNames</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getInactiveSceneNames" title="Link to this definition"></a></dt>
<dd><p>Gets a list of the scene’s names not loaded in the game engine.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of string</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.loadGlobalDict">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">loadGlobalDict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.loadGlobalDict" title="Link to this definition"></a></dt>
<dd><p>Loads bge.logic.globalDict from a file.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.saveGlobalDict">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">saveGlobalDict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.saveGlobalDict" title="Link to this definition"></a></dt>
<dd><p>Saves bge.logic.globalDict to a file.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.startGame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">startGame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">blend</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.startGame" title="Link to this definition"></a></dt>
<dd><p>Loads the blend file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>blend</strong> (<em>string</em>) – The name of the blend file</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.endGame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">endGame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.endGame" title="Link to this definition"></a></dt>
<dd><p>Ends the current game.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.restartGame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">restartGame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.restartGame" title="Link to this definition"></a></dt>
<dd><p>Restarts the current game by reloading the .blend file (the last saved version, not what is currently running).</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.LibLoad">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">LibLoad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">blend</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_actions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_scripts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asynchronous</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scene</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.LibLoad" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Converts the all of the datablocks of the given type from the given blend.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>blend</strong> (<em>string</em>) – The path to the blend file (or the name to use for the library if data is supplied)</p></li>
<li><p><strong>type</strong> (<em>string</em>) – The datablock type (currently only “Action”, “Mesh” and “Scene” are supported)</p></li>
<li><p><strong>data</strong> (<em>bytes</em>) – Binary data from a blend file (optional)</p></li>
<li><p><strong>load_actions</strong> (<em>bool</em>) – Search for and load all actions in a given Scene and not just the “active” actions (Scene type only)</p></li>
<li><p><strong>verbose</strong> (<em>bool</em>) – Whether or not to print debugging information (e.g., “SceneName: Scene”)</p></li>
<li><p><strong>load_scripts</strong> (<em>bool</em>) – Whether or not to load text datablocks as well (can be disabled for some extra security)</p></li>
<li><p><strong>asynchronous</strong> (<em>bool</em>) – Whether or not to do the loading asynchronously (in another thread). Only the “Scene” type is currently supported for this feature.</p></li>
<li><p><strong>scene</strong> (<a class="reference internal" href="bge.types.KX_Scene.html#bge.types.KX_Scene" title="bge.types.KX_Scene"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_Scene</span></code></a> or string) – Scene to merge loaded data to, if <cite>None</cite> use the current scene.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="bge.types.KX_LibLoadStatus.html#bge.types.KX_LibLoadStatus" title="bge.types.KX_LibLoadStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.KX_LibLoadStatus</span></code></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Asynchronously loaded libraries will not be available immediately after LibLoad() returns. Use the returned KX_LibLoadStatus to figure out when the libraries are ready.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.LibNew">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">LibNew</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.LibNew" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Uses existing datablock data and loads in as a new library.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – A unique library name used for removal later</p></li>
<li><p><strong>type</strong> (<em>string</em>) – The datablock type (currently only “Mesh” is supported)</p></li>
<li><p><strong>data</strong> (<em>list</em><em> of </em><em>strings</em>) – A list of names of the datablocks to load</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.LibFree">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">LibFree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.LibFree" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Frees a library, removing all objects and meshes from the currently active scenes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> (<em>string</em>) – The name of the library to free (the name used in LibNew)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.LibList">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">LibList</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.LibList" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Returns a list of currently loaded libraries.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list [str]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.addScene">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">addScene</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overlay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.addScene" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Loads a scene into the game engine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This function is not effective immediately, the scene is queued
and added on the next logic cycle where it will be available
from <cite>getSceneList</cite></p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – The name of the scene</p></li>
<li><p><strong>overlay</strong> (<em>integer</em>) – Overlay or underlay (optional)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.sendMessage">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">sendMessage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_from</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.sendMessage" title="Link to this definition"></a></dt>
<dd><p>Sends a message to sensors in any active scene.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subject</strong> (<em>string</em>) – The subject of the message</p></li>
<li><p><strong>body</strong> (<em>string</em>) – The body of the message (optional)</p></li>
<li><p><strong>to</strong> (<em>string</em>) – The name of the object to send the message to (optional)</p></li>
<li><p><strong>message_from</strong> (<em>string</em>) – The name of the object that the message is coming from (optional)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setGravity">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setGravity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gravity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setGravity" title="Link to this definition"></a></dt>
<dd><p>Sets the world gravity.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>gravity</strong> (<em>Vector</em><em>(</em><em>(</em><em>fx</em><em>, </em><em>fy</em><em>, </em><em>fz</em><em>)</em><em>)</em>) – gravity vector</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getSpectrum">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getSpectrum</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getSpectrum" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.0.0.</span></p>
</div>
<p>Returns a 512 point list from the sound card.
This only works if the fmod sound driver is being used.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list [float], len(<a class="reference internal" href="#bge.logic.getSpectrum" title="bge.logic.getSpectrum">getSpectrum</a>()) == 512</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getMaxLogicFrame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getMaxLogicFrame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getMaxLogicFrame" title="Link to this definition"></a></dt>
<dd><p>Gets the maximum number of logic frames per render frame.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The maximum number of logic frames per render frame</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setMaxLogicFrame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setMaxLogicFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maxlogic</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setMaxLogicFrame" title="Link to this definition"></a></dt>
<dd><p>Sets the maximum number of logic frames that are executed per render frame.
This does not affect the physic system that still runs at full frame rate.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>maxlogic</strong> (<em>integer</em>) – The new maximum number of logic frames per render frame. Valid values: 1..5</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getMaxPhysicsFrame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getMaxPhysicsFrame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getMaxPhysicsFrame" title="Link to this definition"></a></dt>
<dd><p>Gets the maximum number of physics frames per render frame.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The maximum number of physics frames per render frame</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setMaxPhysicsFrame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setMaxPhysicsFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maxphysics</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setMaxPhysicsFrame" title="Link to this definition"></a></dt>
<dd><p>Sets the maximum number of physics timestep that are executed per render frame.
Higher value allows physics to keep up with realtime even if graphics slows down the game.
Physics timestep is fixed and equal to 1/tickrate (see setLogicTicRate)
maxphysics/ticrate is the maximum delay of the renderer that physics can compensate.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>maxphysics</strong> (<em>integer</em>) – The new maximum number of physics timestep per render frame. Valid values: 1..5.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getLogicTicRate">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getLogicTicRate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getLogicTicRate" title="Link to this definition"></a></dt>
<dd><p>Gets the logic update frequency.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The logic frequency in Hz</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setLogicTicRate">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setLogicTicRate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ticrate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setLogicTicRate" title="Link to this definition"></a></dt>
<dd><p>Sets the logic update frequency.</p>
<p>The logic update frequency is the number of times logic bricks are executed every second.
The default is 60 Hz.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ticrate</strong> (<em>float</em>) – The new logic update frequency (in Hz).</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getPhysicsTicRate">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getPhysicsTicRate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getPhysicsTicRate" title="Link to this definition"></a></dt>
<dd><p>Gets the physics update frequency</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The physics update frequency in Hz</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setPhysicsTicRate">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setPhysicsTicRate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ticrate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setPhysicsTicRate" title="Link to this definition"></a></dt>
<dd><p>Sets the physics update frequency</p>
<p>The physics update frequency is the number of times the physics system is executed every second.
The default is 60 Hz.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ticrate</strong> (<em>float</em>) – The new update frequency (in Hz).</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getExitKey">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getExitKey</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getExitKey" title="Link to this definition"></a></dt>
<dd><p>Gets the key used to exit the game engine</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The key (defaults to <a class="reference internal" href="bge.events.html#bge.events.ESCKEY" title="bge.events.ESCKEY"><code class="xref py py-mod docutils literal notranslate"><span class="pre">bge.events.ESCKEY</span></code></a>)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setExitKey">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setExitKey</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setExitKey" title="Link to this definition"></a></dt>
<dd><p>Sets the key used to exit the game engine</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>key</strong> (<em>int</em>) – A key constant from <a class="reference internal" href="bge.events.html#module-bge.events" title="bge.events"><code class="xref py py-mod docutils literal notranslate"><span class="pre">bge.events</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.NextFrame">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">NextFrame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.NextFrame" title="Link to this definition"></a></dt>
<dd><p>Render next frame (if Python has control)</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setRender">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setRender</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">render</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setRender" title="Link to this definition"></a></dt>
<dd><p>Sets the global flag that controls the render of the scene.
If True, the render is done after the logic frame.
If False, the render is skipped and another logic frame starts immediately.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>GPU VSync no longer limits the number of frame per second when render is off,
but the <em>Use Frame Rate</em> option still regulates the fps. To run as many frames
as possible, untick this option (Render Properties, System panel).</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>render</strong> (<em>bool</em>) – the render flag</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getRender">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getRender</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getRender" title="Link to this definition"></a></dt>
<dd><p>Get the current value of the global render flag</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The flag value</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="time-related-functions">
<h2>Time related functions<a class="headerlink" href="#time-related-functions" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getClockTime">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getClockTime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getClockTime" title="Link to this definition"></a></dt>
<dd><p>Get the current BGE render time, in seconds. The BGE render time is the
simulation time corresponding to the next scene that will be rendered.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getFrameTime">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getFrameTime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getFrameTime" title="Link to this definition"></a></dt>
<dd><p>Get the current BGE frame time, in seconds. The BGE frame time is the
simulation time corresponding to the current call of the logic system.
Generally speaking, it is what the user is interested in.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getRealTime">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getRealTime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getRealTime" title="Link to this definition"></a></dt>
<dd><p>Get the number of real (system-clock) seconds elapsed since the beginning
of the simulation.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getTimeScale">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getTimeScale</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getTimeScale" title="Link to this definition"></a></dt>
<dd><p>Get the time multiplier between real-time and simulation time. The default
value is 1.0. A value greater than 1.0 means that the simulation is going
faster than real-time, a value lower than 1.0 means that the simulation is
going slower than real-time.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setTimeScale">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setTimeScale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_scale</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setTimeScale" title="Link to this definition"></a></dt>
<dd><p>Set the time multiplier between real-time and simulation time. A value
greater than 1.0 means that the simulation is going faster than real-time,
a value lower than 1.0 means that the simulation is going slower than
real-time. Note that a too large value may lead to some physics
instabilities.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>time_scale</strong> – The new time multiplier.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getUseExternalClock">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getUseExternalClock</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getUseExternalClock" title="Link to this definition"></a></dt>
<dd><p>Get if the BGE use the inner BGE clock, or rely or on an external
clock. The default is to use the inner BGE clock.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setUseExternalClock">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setUseExternalClock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_external_clock</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setUseExternalClock" title="Link to this definition"></a></dt>
<dd><p>Set if the BGE use the inner BGE clock, or rely or on an external
clock. If the user selects the use of an external clock, he should call
regularly the setClockTime method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>use_external_clock</strong> – the new setting</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.setClockTime">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">setClockTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.setClockTime" title="Link to this definition"></a></dt>
<dd><p>Set the next value of the simulation clock. It is preferable to use this
method from a custom main function in python, as calling it in the logic
block can easily lead to a blocked system (if the time does not advance
enough to run at least the next logic step).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>new_time</strong> – the next value of the BGE clock (in second).</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="utility-functions">
<h2>Utility functions<a class="headerlink" href="#utility-functions" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.expandPath">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">expandPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.expandPath" title="Link to this definition"></a></dt>
<dd><p>Converts a blender internal path into a proper file system path.</p>
<p>Use / as directory separator in path
You can use ‘//’ at the start of the string to define a relative path;
Blender replaces that string by the directory of the current .blend or runtime file
to make a full path name. The function also converts the directory separator to
the local file system format.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path</strong> (<em>string</em>) – The path string to be converted/expanded.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The converted string</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getAverageFrameRate">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getAverageFrameRate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getAverageFrameRate" title="Link to this definition"></a></dt>
<dd><p>Gets the estimated/average framerate for all the active scenes, not only the current scene.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The estimated average framerate in frames per second</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getBlendFileList">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getBlendFileList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'//'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getBlendFileList" title="Link to this definition"></a></dt>
<dd><p>Returns a list of blend files in the same directory as the open blend file, or from using the option argument.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path</strong> (<em>string</em>) – Optional directory argument, will be expanded (like expandPath) into the full path.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of filenames, with no directory prefix</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getRandomFloat">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getRandomFloat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getRandomFloat" title="Link to this definition"></a></dt>
<dd><p>Returns a random floating point value in the range [0 - 1)</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.PrintGLInfo">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">PrintGLInfo</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.PrintGLInfo" title="Link to this definition"></a></dt>
<dd><p>Prints GL Extension Info into the console</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getGraphicsCardVendor">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getGraphicsCardVendor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getGraphicsCardVendor" title="Link to this definition"></a></dt>
<dd><p>Returns the graphics card vendor name. Very useful to make different setups depending on the graphic card used by the user.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.PrintMemInfo">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">PrintMemInfo</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.PrintMemInfo" title="Link to this definition"></a></dt>
<dd><p>Prints engine statistics into the console</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.logic.getProfileInfo">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">getProfileInfo</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.logic.getProfileInfo" title="Link to this definition"></a></dt>
<dd><p>Returns a Python dictionary that contains the same information as the on screen profiler. The keys are the profiler categories and the values are tuples with the first element being time taken (in ms) and the second element being the percentage of total time.</p>
</dd></dl>
</section>
<section id="constants">
<h2>Constants<a class="headerlink" href="#constants" title="Link to this heading"></a></h2>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_TRUE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_TRUE</span></span><a class="headerlink" href="#bge.logic.KX_TRUE" title="Link to this definition"></a></dt>
<dd><p>True value used by some modules.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_FALSE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_FALSE</span></span><a class="headerlink" href="#bge.logic.KX_FALSE" title="Link to this definition"></a></dt>
<dd><p>False value used by some modules.</p>
</dd></dl>
<section id="sensors">
<h3>Sensors<a class="headerlink" href="#sensors" title="Link to this heading"></a></h3>
<section id="sensor-status">
<span id="id1"></span><h4>Sensor Status<a class="headerlink" href="#sensor-status" title="Link to this heading"></a></h4>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_SENSOR_INACTIVE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_SENSOR_INACTIVE</span></span><a class="headerlink" href="#bge.logic.KX_SENSOR_INACTIVE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_SENSOR_JUST_ACTIVATED">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_SENSOR_JUST_ACTIVATED</span></span><a class="headerlink" href="#bge.logic.KX_SENSOR_JUST_ACTIVATED" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_SENSOR_ACTIVE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_SENSOR_ACTIVE</span></span><a class="headerlink" href="#bge.logic.KX_SENSOR_ACTIVE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_SENSOR_JUST_DEACTIVATED">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_SENSOR_JUST_DEACTIVATED</span></span><a class="headerlink" href="#bge.logic.KX_SENSOR_JUST_DEACTIVATED" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="armature-sensor">
<h4>Armature Sensor<a class="headerlink" href="#armature-sensor" title="Link to this heading"></a></h4>
<p id="armaturesensor-type">See <a class="reference internal" href="bge.types.SCA_ArmatureSensor.html#bge.types.SCA_ArmatureSensor.type" title="bge.types.SCA_ArmatureSensor.type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.SCA_ArmatureSensor.type</span></code></a></p>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_ARMSENSOR_STATE_CHANGED">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_ARMSENSOR_STATE_CHANGED</span></span><a class="headerlink" href="#bge.logic.KX_ARMSENSOR_STATE_CHANGED" title="Link to this definition"></a></dt>
<dd><p>Detect that the constraint is changing state (active/inactive)</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>0</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_ARMSENSOR_LIN_ERROR_BELOW">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_ARMSENSOR_LIN_ERROR_BELOW</span></span><a class="headerlink" href="#bge.logic.KX_ARMSENSOR_LIN_ERROR_BELOW" title="Link to this definition"></a></dt>
<dd><p>Detect that the constraint linear error is above a threshold</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>1</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_ARMSENSOR_LIN_ERROR_ABOVE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_ARMSENSOR_LIN_ERROR_ABOVE</span></span><a class="headerlink" href="#bge.logic.KX_ARMSENSOR_LIN_ERROR_ABOVE" title="Link to this definition"></a></dt>
<dd><p>Detect that the constraint linear error is below a threshold</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>2</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_ARMSENSOR_ROT_ERROR_BELOW">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_ARMSENSOR_ROT_ERROR_BELOW</span></span><a class="headerlink" href="#bge.logic.KX_ARMSENSOR_ROT_ERROR_BELOW" title="Link to this definition"></a></dt>
<dd><p>Detect that the constraint rotation error is above a threshold</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>3</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_ARMSENSOR_ROT_ERROR_ABOVE">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_ARMSENSOR_ROT_ERROR_ABOVE</span></span><a class="headerlink" href="#bge.logic.KX_ARMSENSOR_ROT_ERROR_ABOVE" title="Link to this definition"></a></dt>
<dd><p>Detect that the constraint rotation error is below a threshold</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>4</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="property-sensor">
<span id="logic-property-sensor"></span><h4>Property Sensor<a class="headerlink" href="#property-sensor" title="Link to this heading"></a></h4>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_PROPSENSOR_EQUAL">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_PROPSENSOR_EQUAL</span></span><a class="headerlink" href="#bge.logic.KX_PROPSENSOR_EQUAL" title="Link to this definition"></a></dt>
<dd><p>Activate when the property is equal to the sensor value.</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>1</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_PROPSENSOR_NOTEQUAL">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_PROPSENSOR_NOTEQUAL</span></span><a class="headerlink" href="#bge.logic.KX_PROPSENSOR_NOTEQUAL" title="Link to this definition"></a></dt>
<dd><p>Activate when the property is not equal to the sensor value.</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>2</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_PROPSENSOR_INTERVAL">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_PROPSENSOR_INTERVAL</span></span><a class="headerlink" href="#bge.logic.KX_PROPSENSOR_INTERVAL" title="Link to this definition"></a></dt>
<dd><p>Activate when the property is between the specified limits.</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>
<dd class="field-odd"><p>3</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.logic.KX_PROPSENSOR_CHANGED">
<span class="sig-prename descclassname"><span class="pre">bge.logic.</span></span><span class="sig-name descname"><span class="pre">KX_PROPSENSOR_CHANGED</span></span><a class="headerlink" href="#bge.logic.KX_PROPSENSOR_CHANGED" title="Link to this definition"></a></dt>
<dd><p>Activate when the property changes</p>
<dl class="field-list simple">
<dt class="field-odd">Value<span class="colon">:</span></dt>