1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
|
"""
Documentation for the GameTypes Module.
=======================================
@group Base: PyObjectPlus, CValue, CPropValue, SCA_ILogicBrick, SCA_IObject, SCA_ISensor, SCA_IController, SCA_IActuator
@group Object: KX_GameObject, KX_LightObject, KX_Camera
@group Mesh: KX_MeshProxy, KX_PolyProxy, KX_VertexProxy
@group Shading: KX_PolygonMaterial, KX_BlenderMaterial, BL_Shader
@group Sensors: SCA_ActuatorSensor, SCA_AlwaysSensor, SCA_DelaySensor, SCA_JoystickSensor, SCA_KeyboardSensor, KX_MouseFocusSensor, SCA_MouseSensor, KX_NearSensor, KX_NetworkMessageSensor, SCA_PropertySensor, KX_RadarSensor, SCA_RandomSensor, KX_RaySensor, KX_TouchSensor
@group Actuators: SCA_2DFilterActuator, BL_ActionActuator, KX_SCA_AddObjectActuator, KX_CameraActuator, KX_CDActuator, KX_ConstraintActuator, KX_SCA_DynamicActuator, KX_SCA_EndObjectActuator, KX_GameActuator, KX_IpoActuator, KX_NetworkMessageActuator, KX_ObjectActuator, KX_ParentActuator, SCA_PropertyActuator, SCA_RandomActuator, KX_SCA_ReplaceMeshActuator, KX_SceneActuator, BL_ShapeActionActuator, KX_SoundActuator, KX_StateActuator, KX_TrackToActuator, KX_VisibilityActuator
@group Controllers: SCA_ANDController, SCA_NANDController, SCA_NORController, SCA_ORController, SCA_PythonController, SCA_XNORController, SCA_XORController
"""
import GameLogic
class PyObjectPlus:
"""
PyObjectPlus base class of most other types in the Game Engine.
@ivar invalid: Test if the object has been freed by the game engine and is no longer valid.
Normally this is not a problem but when storing game engine data in the GameLogic module,
KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data.
Calling an attribute or method on an invalid object will raise a SystemError.
The invalid attribute allows testing for this case without exception handling.
@type invalid: bool
"""
def isA(game_type):
"""
Check if this is a type or a subtype game_type.
@param game_type: the name of the type or the type its self from the L{GameTypes} module.
@type game_type: string or type
@return: True if this object is a type or a subtype of game_type.
@rtype: bool
"""
class CValue(PyObjectPlus):
"""
This class is a basis for other classes.
@ivar name: The name of this CValue derived object (read-only).
@type name: string
@group Deprecated: getName
"""
def getName():
"""
Returns the name of the CValue.
@deprecated: Use the L{name} attribute instead.
@note: in most cases the CValue's subclasses will override this function.
@rtype: string
"""
class CPropValue(CValue):
"""
This class has no python functions
"""
pass
class SCA_ILogicBrick(CValue):
"""
Base class for all logic bricks.
@ivar executePriority: This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
@type executePriority: int
@ivar owner: The game object this logic brick is attached to (read-only).
@type owner: L{KX_GameObject} or None in exceptional cases.
@ivar name: The name of this logic brick (read-only).
@type name: string
"""
#{ Deprecated
def getOwner():
"""
Gets the game object associated with this logic brick.
@deprecated: Use the L{owner} attribute instead.
@rtype: L{KX_GameObject}
"""
def setExecutePriority(priority):
"""
Sets the priority of this logic brick.
This determines the order controllers are evaluated, and actuators are activated.
Bricks with lower priority will be executed first.
@deprecated: Use the L{executePriority} attribute instead.
@type priority: integer
@param priority: the priority of this logic brick.
"""
def getExecutePriority():
"""
Gets the execution priority of this logic brick.
@deprecated: Use the L{executePriority} attribute instead.
@rtype: integer
@return: this logic bricks current priority.
"""
#}
class SCA_IObject(CValue):
"""
This class has no python functions
"""
pass
class SCA_ISensor(SCA_ILogicBrick):
"""
Base class for all sensor logic bricks.
@ivar usePosPulseMode: Flag to turn positive pulse mode on and off.
@type usePosPulseMode: boolean
@ivar useNegPulseMode: Flag to turn negative pulse mode on and off.
@type useNegPulseMode: boolean
@ivar frequency: The frequency for pulse mode sensors.
@type frequency: int
@ivar level: Option whether to detect level or edge transition when entering a state.
It makes a difference only in case of logic state transition (state actuator).
A level detector will immediately generate a pulse, negative or positive
depending on the sensor condition, as soon as the state is activated.
A edge detector will wait for a state change before generating a pulse.
note: mutually exclusive with L{tap}, enabling will disable L{tap}.
@type level: boolean
@ivar tap: When enabled only sensors that are just activated will send a positive event,
after this they will be detected as negative by the controllers.
This will make a key thats held act as if its only tapped for an instant.
note: mutually exclusive with L{level}, enabling will disable L{level}.
@type tap: boolean
@ivar invert: Flag to set if this sensor activates on positive or negative events.
@type invert: boolean
@ivar triggered: True if this sensor brick is in a positive state. (read-only)
@type triggered: boolean
@ivar positive: True if this sensor brick is in a positive state. (read-only)
@type positive: boolean
"""
def reset():
"""
Reset sensor internal state, effect depends on the type of sensor and settings.
The sensor is put in its initial state as if it was just activated.
"""
#{ Deprecated
def isPositive():
"""
True if this sensor brick is in a positive state.
@deprecated: use L{positive}
"""
def isTriggered():
"""
True if this sensor brick has triggered the current controller.
@deprecated: use L{triggered}
"""
def getUsePosPulseMode():
"""
True if the sensor is in positive pulse mode.
@deprecated: use L{usePosPulseMode}
"""
def setUsePosPulseMode(pulse):
"""
Sets positive pulse mode.
@type pulse: boolean
@param pulse: If True, will activate positive pulse mode for this sensor.
@deprecated: use L{usePosPulseMode}
"""
def getFrequency():
"""
The frequency for pulse mode sensors.
@rtype: integer
@return: the pulse frequency in 1/50 sec.
@deprecated: use L{frequency}
"""
def setFrequency(freq):
"""
Sets the frequency for pulse mode sensors.
@type freq: integer
@return: the pulse frequency in 1/50 sec.
@deprecated: use L{frequency}
"""
def getUseNegPulseMode():
"""
True if the sensor is in negative pulse mode.
@deprecated: use L{useNegPulseMode}
"""
def setUseNegPulseMode(pulse):
"""
Sets negative pulse mode.
@type pulse: boolean
@param pulse: If True, will activate negative pulse mode for this sensor.
@deprecated: use L{useNegPulseMode}
"""
def getInvert():
"""
True if this sensor activates on negative events.
@deprecated: use L{invert}
"""
def setInvert(invert):
"""
Sets if this sensor activates on positive or negative events.
@type invert: boolean
@param invert: true if activates on negative events; false if activates on positive events.
@deprecated: use L{invert}
"""
def getLevel():
"""
Returns whether this sensor is a level detector or a edge detector.
It makes a difference only in case of logic state transition (state actuator).
A level detector will immediately generate a pulse, negative or positive
depending on the sensor condition, as soon as the state is activated.
A edge detector will wait for a state change before generating a pulse.
@rtype: boolean
@return: true if sensor is level sensitive, false if it is edge sensitive
@deprecated: use L{level}
"""
def setLevel(level):
"""
Set whether to detect level or edge transition when entering a state.
@param level: Detect level instead of edge? (KX_TRUE, KX_FALSE)
@type level: boolean
@deprecated: use L{level}
"""
#}
class SCA_IController(SCA_ILogicBrick):
"""
Base class for all controller logic bricks.
@ivar state: the controllers state bitmask.
This can be used with the GameObject's state to test if the controller is active.
@type state: int bitmask
@ivar sensors: a list of sensors linked to this controller
- note: the sensors are not necessarily owned by the same object.
- note: when objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
@type sensors: sequence supporting index/string lookups and iteration.
@ivar actuators: a list of actuators linked to this controller.
- note: the sensors are not necessarily owned by the same object.
- note: when objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
@type actuators: sequence supporting index/string lookups and iteration.
@ivar useHighPriority: When set the controller executes always before all other controllers that dont have this set.
note: Order of execution between high priority controllers is not guaranteed.
@type useHighPriority: bool
"""
#{ Deprecated
def getState():
"""
Get the controllers state bitmask, this can be used with the GameObject's state to test if the the controller is active.
This for instance will always be true however you could compare with a previous state to see when the state was activated.
GameLogic.getCurrentController().state & GameLogic.getCurrentController().owner.state
@deprecated: Use the L{state} property
@rtype: int
"""
def getSensors():
"""
Gets a list of all sensors attached to this controller.
@deprecated: use the L{sensors} property
@rtype: list [L{SCA_ISensor}]
"""
def getSensor(name):
"""
Gets the named linked sensor.
@deprecated: use the L{sensors}[name] property
@type name: string
@rtype: L{SCA_ISensor}
"""
def getActuators():
"""
Gets a list of all actuators linked to this controller.
@deprecated: Use the L{actuators} property
@rtype: list [L{SCA_IActuator}]
"""
def getActuator(name):
"""
Gets the named linked actuator.
@deprecated: use the L{actuators}[name] property
@type name: string
@rtype: L{SCA_IActuator}
"""
#}
class SCA_IActuator(SCA_ILogicBrick):
"""
Base class for all actuator logic bricks.
"""
class BL_ActionActuator(SCA_IActuator):
"""
Action Actuators apply an action to an actor.
@ivar action: The name of the action to set as the current action.
@type action: string
@ivar channelNames: A list of channel names that may be used with L{setChannel} and L{getChannel}
@type channelNames: list of strings
@ivar frameStart: Specifies the starting frame of the animation.
@type frameStart: float
@ivar frameEnd: Specifies the ending frame of the animation.
@type frameEnd: float
@ivar blendIn: Specifies the number of frames of animation to generate when making transitions between actions.
@type blendIn: float
@ivar priority: Sets the priority of this actuator. Actuators will lower
priority numbers will override actuators with higher
numbers.
@type priority: integer
@ivar frame: Sets the current frame for the animation.
@type frame: float
@ivar propName: Sets the property to be used in FromProp playback mode.
@type propName: string
@ivar blendTime: Sets the internal frame timer. This property must be in
the range from 0.0 to blendIn.
@type blendTime: float
@ivar mode: The operation mode of the actuator. KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@type mode: integer
@ivar useContinue: The actions continue option, True or False.
When True, the action will always play from where last left off,
otherwise negative events to this actuator will reset it to its start frame.
@type useContinue: boolean
@ivar framePropName: The name of the property that is set to the current frame number.
@type framePropName: string
"""
def setChannel(channel, matrix):
"""
Alternative to the 2 arguments, 4 arguments (channel, matrix, loc, size, quat) are also supported.
@note: These values are relative to the bones rest position, currently the api has no way to get this info (which is annoying), but can be worked around by using bones with a rest pose that has no translation.
@param channel: A string specifying the name of the bone channel, error raised if not in L{channelNames}.
@type channel: string
@param matrix: A 4x4 matrix specifying the overriding transformation
as an offset from the bone's rest position.
@type matrix: list [[float]]
"""
def getChannel(channel):
"""
@param channel: A string specifying the name of the bone channel. error raised if not in L{channelNames}.
@type channel: string
@rtype: tuple
@return: (loc, size, quat)
"""
#{ Deprecated
def setAction(action, reset = True):
"""
Sets the current action.
@deprecated: use the L{action} property
@param action: The name of the action to set as the current action.
@type action: string
@param reset: Optional parameter indicating whether to reset the
blend timer or not. A value of 1 indicates that the
timer should be reset. A value of 0 will leave it
unchanged. If reset is not specified, the timer will
be reset.
"""
def setStart(start):
"""
Specifies the starting frame of the animation.
@deprecated: Use the L{frameStart} property
@param start: the starting frame of the animation
@type start: float
"""
def setEnd(end):
"""
Specifies the ending frame of the animation.
@deprecated: use the L{frameEnd} property
@param end: the ending frame of the animation
@type end: float
"""
def setBlendin(blendin):
"""
Specifies the number of frames of animation to generate
when making transitions between actions.
@deprecated: use the L{blendIn} property
@param blendin: the number of frames in transition.
@type blendin: float
"""
def setPriority(priority):
"""
Sets the priority of this actuator.
@deprecated: Use use the L{priority} property
@param priority: Specifies the new priority. Actuators will lower
priority numbers will override actuators with higher
numbers.
@type priority: integer
"""
def setFrame(frame):
"""
Sets the current frame for the animation.
@deprecated: use the L{frame} property
@param frame: Specifies the new current frame for the animation
@type frame: float
"""
def setProperty(prop):
"""
Sets the property to be used in FromProp playback mode.
@deprecated: use the L{property} property
@param prop: the name of the property to use.
@type prop: string.
"""
def setBlendtime(blendtime):
"""
Sets the internal frame timer.
Allows the script to directly modify the internal timer
used when generating transitions between actions.
@deprecated: use the L{blendTime} property
@param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
@type blendtime: float
"""
def setType(mode):
"""
Sets the operation mode of the actuator
@deprecated: use the L{type} property
@param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@type mode: integer
"""
def setContinue(cont):
"""
Set the actions continue option True or False. see getContinue.
@deprecated: use the L{useContinue} property
@param cont: The continue option.
@type cont: bool
"""
def getType():
"""
Returns the operation mode of the actuator
@deprecated: use the L{type} property
@rtype: integer
@return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
"""
def getContinue():
"""
When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.
@deprecated: use the L{useContinue} property
@rtype: bool
"""
def getAction():
"""
getAction() returns the name of the action associated with this actuator.
@deprecated: use the L{action} property
@rtype: string
"""
def getStart():
"""
Returns the starting frame of the action.
@deprecated: use the L{frameStart} property
@rtype: float
"""
def getEnd():
"""
Returns the last frame of the action.
@deprecated: use the L{frameEnd} property
@rtype: float
"""
def getBlendin():
"""
Returns the number of interpolation animation frames to be generated when this actuator is triggered.
@deprecated: use the L{blendIn} property
@rtype: float
"""
def getPriority():
"""
Returns the priority for this actuator. Actuators with lower Priority numbers will
override actuators with higher numbers.
@deprecated: use the L{priority} property
@rtype: integer
"""
def getFrame():
"""
Returns the current frame number.
@deprecated: use the L{frame} property
@rtype: float
"""
def getProperty():
"""
Returns the name of the property to be used in FromProp mode.
@deprecated: use the L{property} property
@rtype: string
"""
def setFrameProperty(prop):
"""
@deprecated: use the L{framePropName} property
@param prop: A string specifying the property of the object that will be updated with the action frame number.
@type prop: string
"""
def getFrameProperty():
"""
Returns the name of the property that is set to the current frame number.
@deprecated: use the L{framePropName} property
@rtype: string
"""
#}
class BL_Shader(PyObjectPlus):
"""
BL_Shader GLSL shaders.
TODO - Description
"""
def setUniformfv(name, fList):
"""
Set a uniform with a list of float values
@param name: the uniform name
@type name: string
@param fList: a list (2, 3 or 4 elements) of float values
@type fList: list[float]
"""
def delSource():
"""
Clear the shader. Use this method before the source is changed with L{setSource}.
"""
def getFragmentProg():
"""
Returns the fragment program.
@rtype: string
@return: The fragment program.
"""
def getVertexProg():
"""
Get the vertex program.
@rtype: string
@return: The vertex program.
"""
def isValid():
"""
Check if the shader is valid.
@rtype: bool
@return: True if the shader is valid
"""
def setAttrib(enum):
"""
Set attribute location. (The parameter is ignored a.t.m. and the value of "tangent" is always used.)
@param enum: attribute location value
@type enum: integer
"""
def setNumberOfPasses( max_pass ):
"""
Set the maximum number of passes. Not used a.t.m.
@param max_pass: the maximum number of passes
@type max_pass: integer
"""
def setSampler(name, index):
"""
Set uniform texture sample index.
@param name: Uniform name
@type name: string
@param index: Texture sample index.
@type index: integer
"""
def setSource(vertexProgram, fragmentProgram):
"""
Set the vertex and fragment programs
@param vertexProgram: Vertex program
@type vertexProgram: string
@param fragmentProgram: Fragment program
@type fragmentProgram: string
"""
def setUniform1f(name, fx):
"""
Set a uniform with 1 float value.
@param name: the uniform name
@type name: string
@param fx: Uniform value
@type fx: float
"""
def setUniform1i(name, ix):
"""
Set a uniform with an integer value.
@param name: the uniform name
@type name: string
@param ix: the uniform value
@type ix: integer
"""
def setUniform2f(name, fx, fy):
"""
Set a uniform with 2 float values
@param name: the uniform name
@type name: string
@param fx: first float value
@type fx: float
@param fy: second float value
@type fy: float
"""
def setUniform2i(name, ix, iy):
"""
Set a uniform with 2 integer values
@param name: the uniform name
@type name: string
@param ix: first integer value
@type ix: integer
@param iy: second integer value
@type iy: integer
"""
def setUniform3f(name, fx,fy,fz):
"""
Set a uniform with 3 float values.
@param name: the uniform name
@type name: string
@param fx: first float value
@type fx: float
@param fy: second float value
@type fy: float
@param fz: third float value
@type fz: float
"""
def setUniform3i(name, ix,iy,iz):
"""
Set a uniform with 3 integer values
@param name: the uniform name
@type name: string
@param ix: first integer value
@type ix: integer
@param iy: second integer value
@type iy: integer
@param iz: third integer value
@type iz: integer
"""
def setUniform4f(name, fx,fy,fz,fw):
"""
Set a uniform with 4 float values.
@param name: the uniform name
@type name: string
@param fx: first float value
@type fx: float
@param fy: second float value
@type fy: float
@param fz: third float value
@type fz: float
@param fw: fourth float value
@type fw: float
"""
def setUniform4i(name, ix,iy,iz, iw):
"""
Set a uniform with 4 integer values
@param name: the uniform name
@type name: string
@param ix: first integer value
@type ix: integer
@param iy: second integer value
@type iy: integer
@param iz: third integer value
@type iz: integer
@param iw: fourth integer value
@type iw: integer
"""
def setUniformDef(name, type):
"""
Define a new uniform
@param name: the uniform name
@type name: string
@param type: uniform type
@type type: UNI_NONE, UNI_INT, UNI_FLOAT, UNI_INT2, UNI_FLOAT2, UNI_INT3, UNI_FLOAT3, UNI_INT4, UNI_FLOAT4, UNI_MAT3, UNI_MAT4, UNI_MAX
"""
def setUniformMatrix3(name, mat, transpose):
"""
Set a uniform with a 3x3 matrix value
@param name: the uniform name
@type name: string
@param mat: A 3x3 matrix [[f,f,f], [f,f,f], [f,f,f]]
@type mat: 3x3 matrix
@param transpose: set to True to transpose the matrix
@type transpose: bool
"""
def setUniformMatrix4(name, mat, transpose):
"""
Set a uniform with a 4x4 matrix value
@param name: the uniform name
@type name: string
@param mat: A 4x4 matrix [[f,f,f,f], [f,f,f,f], [f,f,f,f], [f,f,f,f]]
@type mat: 4x4 matrix
@param transpose: set to True to transpose the matrix
@type transpose: bool
"""
def setUniformiv(name, iList):
"""
Set a uniform with a list of integer values
@param name: the uniform name
@type name: string
@param iList: a list (2, 3 or 4 elements) of integer values
@type iList: list[integer]
"""
def validate():
"""
Validate the shader object.
"""
class BL_ShapeActionActuator(SCA_IActuator):
"""
ShapeAction Actuators apply an shape action to an mesh object.\
@ivar action: The name of the action to set as the current shape action.
@type action: string
@ivar frameStart: Specifies the starting frame of the shape animation.
@type frameStart: float
@ivar frameEnd: Specifies the ending frame of the shape animation.
@type frameEnd: float
@ivar blendIn: Specifies the number of frames of animation to generate when making transitions between actions.
@type blendIn: float
@ivar priority: Sets the priority of this actuator. Actuators will lower
priority numbers will override actuators with higher
numbers.
@type priority: integer
@ivar frame: Sets the current frame for the animation.
@type frame: float
@ivar propName: Sets the property to be used in FromProp playback mode.
@type propName: string
@ivar blendTime: Sets the internal frame timer. This property must be in
the range from 0.0 to blendin.
@type blendTime: float
@ivar mode: The operation mode of the actuator.
KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER,
KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@type mode: integer
@ivar framePropName: The name of the property that is set to the current frame number.
@type framePropName: string
"""
#{ Deprecated
def setAction(action, reset = True):
"""
Sets the current action.
@deprecated: use the L{action} property
@param action: The name of the action to set as the current action.
@type action: string
@param reset: Optional parameter indicating whether to reset the
blend timer or not. A value of 1 indicates that the
timer should be reset. A value of 0 will leave it
unchanged. If reset is not specified, the timer will
be reset.
"""
def setStart(start):
"""
Specifies the starting frame of the animation.
@deprecated: use the L{frameStart} property
@param start: the starting frame of the animation
@type start: float
"""
def setEnd(end):
"""
Specifies the ending frame of the animation.
@deprecated: use the L{frameEnd} property
@param end: the ending frame of the animation
@type end: float
"""
def setBlendin(blendin):
"""
Specifies the number of frames of animation to generate
when making transitions between actions.
@deprecated: use the L{blendIn} property
@param blendin: the number of frames in transition.
@type blendin: float
"""
def setPriority(priority):
"""
Sets the priority of this actuator.
@deprecated: use the L{priority} property
@param priority: Specifies the new priority. Actuators will lower
priority numbers will override actuators with higher
numbers.
@type priority: integer
"""
def setFrame(frame):
"""
Sets the current frame for the animation.
@deprecated: use the L{frame} property
@param frame: Specifies the new current frame for the animation
@type frame: float
"""
def setProperty(prop):
"""
Sets the property to be used in FromProp playback mode.
@deprecated: use the L{property} property
@param prop: the name of the property to use.
@type prop: string.
"""
def setBlendtime(blendtime):
"""
Sets the internal frame timer.
Allows the script to directly modify the internal timer
used when generating transitions between actions.
@deprecated: use the L{blendTime} property
@param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
@type blendtime: float
"""
def setType(mode):
"""
Sets the operation mode of the actuator
@deprecated: use the L{type} property
@param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@type mode: integer
"""
def getType():
"""
Returns the operation mode of the actuator
@deprecated: use the L{type} property
@rtype: integer
@return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
"""
def getAction():
"""
getAction() returns the name of the action associated with this actuator.
@deprecated: use the L{action} property
@rtype: string
"""
def getStart():
"""
Returns the starting frame of the action.
@deprecated: use the L{frameStart} property
@rtype: float
"""
def getEnd():
"""
Returns the last frame of the action.
@deprecated: use the L{frameEnd} property
@rtype: float
"""
def getBlendin():
"""
Returns the number of interpolation animation frames to be generated when this actuator is triggered.
@deprecated: use the L{blendIn} property
@rtype: float
"""
def getPriority():
"""
Returns the priority for this actuator. Actuators with lower Priority numbers will
override actuators with higher numbers.
@deprecated: use the L{priority} property
@rtype: integer
"""
def getFrame():
"""
Returns the current frame number.
@deprecated: use the L{frame} property
@rtype: float
"""
def getProperty():
"""
Returns the name of the property to be used in FromProp mode.
@deprecated: use the L{property} property
@rtype: string
"""
def setFrameProperty(prop):
"""
@deprecated: use the L{framePropName} property
@param prop: A string specifying the property of the object that will be updated with the action frame number.
@type prop: string
"""
def getFrameProperty():
"""
Returns the name of the property that is set to the current frame number.
@deprecated: use the L{framePropName} property
@rtype: string
"""
#}
class CListValue(CPropValue):
"""
CListValue
This is a list like object used in the game engine internally that behaves similar to a python list in most ways.
As well as the normal index lookup.
C{val= clist[i]}
CListValue supports string lookups.
C{val= scene.objects["OBCube"]}
Other operations such as C{len(clist), list(clist), clist[0:10]} are also supported.
"""
def append(val):
"""
Add an item to the list (like pythons append)
Warning: Appending values to the list can cause crashes when the list is used internally by the game engine.
"""
def count(val):
"""
Count the number of instances of a value in the list.
@rtype: integer
@return: number of instances
"""
def index(val):
"""
Return the index of a value in the list.
@rtype: integer
@return: The index of the value in the list.
"""
def reverse():
"""
Reverse the order of the list.
"""
def get(key, default=None):
"""
Return the value matching key, or the default value if its not found.
@return: The key value or a default.
"""
def has_key(key):
"""
Return True if the key is found.
@rtype: boolean
@return: The key value or a default.
"""
def from_id(id):
"""
This is a funtion especially for the game engine to return a value with a spesific id.
Since object names are not always unique, the id of an object can be used to get an object from the CValueList.
Example.
C{myObID = id(gameObject)}
C{...}
C{ob= scene.objects.from_id(myObID)}
Where myObID is an int or long from the id function.
This has the advantage that you can store the id in places you could not store a gameObject.
Warning: the id is derived from a memory location and will be different each time the game engine starts.
"""
class KX_BlenderMaterial(PyObjectPlus): # , RAS_IPolyMaterial)
"""
KX_BlenderMaterial
"""
def getShader():
"""
Returns the material's shader.
@rtype: L{BL_Shader}
@return: the material's shader
"""
def setBlending(src, dest):
"""
Set the pixel color arithmetic functions.
@param src: Specifies how the red, green, blue,
and alpha source blending factors are computed.
@type src: GL_ZERO,
GL_ONE,
GL_SRC_COLOR,
GL_ONE_MINUS_SRC_COLOR,
GL_DST_COLOR,
GL_ONE_MINUS_DST_COLOR,
GL_SRC_ALPHA,
GL_ONE_MINUS_SRC_ALPHA,
GL_DST_ALPHA,
GL_ONE_MINUS_DST_ALPHA,
GL_SRC_ALPHA_SATURATE
@param dest: Specifies how the red, green, blue,
and alpha destination blending factors are computed.
@type dest: GL_ZERO,
GL_ONE,
GL_SRC_COLOR,
GL_ONE_MINUS_SRC_COLOR,
GL_DST_COLOR,
GL_ONE_MINUS_DST_COLOR,
GL_SRC_ALPHA,
GL_ONE_MINUS_SRC_ALPHA,
GL_DST_ALPHA,
GL_ONE_MINUS_DST_ALPHA,
GL_SRC_ALPHA_SATURATE
"""
def getMaterialIndex():
"""
Returns the material's index.
@rtype: integer
@return: the material's index
"""
class KX_CDActuator(SCA_IActuator):
"""
CD Controller actuator.
@ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 = max volume.
@type volume: float
@ivar track: the track selected to be played
@type track: integer
@ivar gain: the gain (volume) of the CD between 0.0 and 1.0.
@type gain: float
"""
def startCD():
"""
Starts the CD playing.
"""
def stopCD():
"""
Stops the CD playing.
"""
def pauseCD():
"""
Pauses the CD.
"""
def resumeCD():
"""
Resumes the CD after a pause.
"""
def playAll():
"""
Plays the CD from the beginning.
"""
def playTrack(trackNumber):
"""
Plays the track selected.
"""
#{ Deprecated
def setGain(gain):
"""
Sets the gain (volume) of the CD.
@deprecated: Use the L{volume} property.
@type gain: float
@param gain: the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
"""
def getGain():
"""
Gets the current gain (volume) of the CD.
@deprecated: Use the L{volume} property.
@rtype: float
@return: Between 0.0 (silent) and 1.0 (max volume)
"""
#}
class KX_CameraActuator(SCA_IActuator):
"""
Applies changes to a camera.
@ivar min: minimum distance to the target object maintained by the actuator
@type min: float
@ivar max: maximum distance to stay from the target object
@type max: float
@ivar height: height to stay above the target object
@type height: float
@ivar useXY: axis this actuator is tracking, true=X, false=Y
@type useXY: boolean
@ivar object: the object this actuator tracks.
@type object: KX_GameObject or None
@author: snail
"""
#{ Deprecated
def getObject(name_only = 1):
"""
Returns the name of the object this actuator tracks.
@deprecated: Use the L{object} attribute instead.
@type name_only: bool
@param name_only: optional argument, when 0 return a KX_GameObject
@rtype: string, KX_GameObject or None if no object is set
"""
def setObject(target):
"""
Sets the object this actuator tracks.
@deprecated: Use the L{object} attribute instead.
@param target: the object to track.
@type target: L{KX_GameObject}, string or None
"""
def getMin():
"""
Returns the minimum distance to target maintained by the actuator.
@deprecated: Use the L{min} attribute instead.
@rtype: float
"""
def setMin(distance):
"""
Sets the minimum distance to the target object maintained by the
actuator.
@deprecated: Use the L{min} attribute instead.
@param distance: The minimum distance to maintain.
@type distance: float
"""
def getMax():
"""
Gets the maximum distance to stay from the target object.
@deprecated: Use the L{max} attribute instead.
@rtype: float
"""
def setMax(distance):
"""
Sets the maximum distance to stay from the target object.
@deprecated: Use the L{max} attribute instead.
@param distance: The maximum distance to maintain.
@type distance: float
"""
def getHeight():
"""
Returns the height to stay above the target object.
@deprecated: Use the L{height} attribute instead.
@rtype: float
"""
def setHeight(height):
"""
Sets the height to stay above the target object.
@deprecated: Use the L{height} attribute instead.
@type height: float
@param height: The height to stay above the target object.
"""
def setXY(xaxis):
"""
Sets the axis to get behind.
@deprecated: Use the L{useXY} attribute instead.
@param xaxis: False to track Y axis, True to track X axis.
@type xaxis: boolean
"""
def getXY():
"""
Returns the axis this actuator is tracking.
@deprecated: Use the L{useXY} attribute instead.
@return: True if tracking X axis, False if tracking Y axis.
@rtype: boolean
"""
#}
class KX_ConstraintActuator(SCA_IActuator):
"""
A constraint actuator limits the position, rotation, distance or orientation of an object.
Properties:
@ivar damp: time constant of the constraint expressed in frame (not use by Force field constraint)
@type damp: integer
@ivar rotDamp: time constant for the rotation expressed in frame (only for the distance constraint)
0 = use damp for rotation as well
@type rotDamp: integer
@ivar direction: the reference direction in world coordinate for the orientation constraint
@type direction: 3-tuple of float: [x,y,z]
@ivar option: Binary combination of the following values:
Applicable to Distance constraint:
- KX_ACT_CONSTRAINT_NORMAL ( 64) : Activate alignment to surface
- KX_ACT_CONSTRAINT_DISTANCE ( 512) : Activate distance control
- KX_ACT_CONSTRAINT_LOCAL (1024) : direction of the ray is along the local axis
Applicable to Force field constraint:
- KX_ACT_CONSTRAINT_DOROTFH (2048) : Force field act on rotation as well
Applicable to both:
- KX_ACT_CONSTRAINT_MATERIAL ( 128) : Detect material rather than property
- KX_ACT_CONSTRAINT_PERMANENT ( 256) : No deactivation if ray does not hit target
@type option: integer
@ivar time: activation time of the actuator. The actuator disables itself after this many frame.
If set to 0, the actuator is not limited in time.
@type time: integer
@ivar propName: the name of the property or material for the ray detection of the distance constraint.
@type propName: string
@ivar min: The lower bound of the constraint
For the rotation and orientation constraint, it represents radiant
@type min: float
@ivar distance: the target distance of the distance constraint
@type distance: float
@ivar max: the upper bound of the constraint.
For rotation and orientation constraints, it represents radiant.
@type max: float
@ivar rayLength: the length of the ray of the distance constraint.
@type rayLength: float
@ivar limit: type of constraint, use one of the following constant:
KX_ACT_CONSTRAINT_LOCX ( 1) : limit X coord
KX_ACT_CONSTRAINT_LOCY ( 2) : limit Y coord
KX_ACT_CONSTRAINT_LOCZ ( 3) : limit Z coord
KX_ACT_CONSTRAINT_ROTX ( 4) : limit X rotation
KX_ACT_CONSTRAINT_ROTY ( 5) : limit Y rotation
KX_ACT_CONSTRAINT_ROTZ ( 6) : limit Z rotation
KX_ACT_CONSTRAINT_DIRPX ( 7) : set distance along positive X axis
KX_ACT_CONSTRAINT_DIRPY ( 8) : set distance along positive Y axis
KX_ACT_CONSTRAINT_DIRPZ ( 9) : set distance along positive Z axis
KX_ACT_CONSTRAINT_DIRNX (10) : set distance along negative X axis
KX_ACT_CONSTRAINT_DIRNY (11) : set distance along negative Y axis
KX_ACT_CONSTRAINT_DIRNZ (12) : set distance along negative Z axis
KX_ACT_CONSTRAINT_ORIX (13) : set orientation of X axis
KX_ACT_CONSTRAINT_ORIY (14) : set orientation of Y axis
KX_ACT_CONSTRAINT_ORIZ (15) : set orientation of Z axis
KX_ACT_CONSTRAINT_FHPX (16) : set force field along positive X axis
KX_ACT_CONSTRAINT_FHPY (17) : set force field along positive Y axis
KX_ACT_CONSTRAINT_FHPZ (18) : set force field along positive Z axis
KX_ACT_CONSTRAINT_FHNX (19) : set force field along negative X axis
KX_ACT_CONSTRAINT_FHNY (20) : set force field along negative Y axis
KX_ACT_CONSTRAINT_FHNZ (21) : set force field along negative Z axis
@type limit: integer
"""
#{ Deprecated
def setDamp(time):
"""
Sets the time this constraint is delayed.
@param time: The number of frames to delay.
Negative values are ignored.
@type time: integer
"""
def getDamp():
"""
Returns the damping time of the constraint.
@rtype: integer
"""
def setMin(lower):
"""
Sets the lower bound of the constraint.
For rotational and orientation constraints, lower is specified in degrees.
@type lower: float
"""
def getMin():
"""
Gets the lower bound of the constraint.
For rotational and orientation constraints, the lower bound is returned in radians.
@rtype: float
"""
def setMax(upper):
"""
Sets the upper bound of the constraint.
For rotational and orientation constraints, upper is specified in degrees.
@type upper: float
"""
def getMax():
"""
Gets the upper bound of the constraint.
For rotational and orientation constraints, the upper bound is returned in radians.
@rtype: float
"""
def setLimit(limit):
"""
Sets the type of constraint.
See module L{GameLogic} for valid constraint types.
@param limit:
Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ
Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ
Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ
Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ
"""
def getLimit():
"""
Gets the type of constraint.
See module L{GameLogic} for valid constraints.
@return:
Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ,
Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ,
Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ,
Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ
"""
def setRotDamp(duration):
"""
Sets the time constant of the orientation constraint.
@param duration: If the duration is negative, it is set to 0.
@type duration: integer
"""
def getRotDamp():
"""
Returns the damping time for application of the constraint.
@rtype: integer
"""
def setDirection(vector):
"""
Sets the reference direction in world coordinate for the orientation constraint
@type vector: 3-tuple
"""
def getDirection():
"""
Returns the reference direction of the orientation constraint in world coordinate.
@rtype: 3-tuple
"""
def setOption(option):
"""
Sets several options of the distance constraint.
@type option: integer
@param option: Binary combination of the following values:
64 : Activate alignment to surface
128 : Detect material rather than property
256 : No deactivation if ray does not hit target
512 : Activate distance control
"""
def getOption():
"""
Returns the option parameter.
@rtype: integer
"""
def setTime(duration):
"""
Sets the activation time of the actuator.
@type duration: integer
@param duration: The actuator disables itself after this many frame.
If set to 0 or negative, the actuator is not limited in time.
"""
def getTime():
"""
Returns the time parameter.
@rtype: integer
"""
def setProperty(property):
"""
Sets the name of the property or material for the ray detection of the distance constraint.
@type property: string
@param property: If empty, the ray will detect any collisioning object.
"""
def getProperty():
"""
Returns the property parameter.
@rtype: string
"""
def setDistance(distance):
"""
Sets the target distance in distance constraint.
@type distance: float
"""
def getDistance():
"""
Returns the distance parameter.
@rtype: float
"""
def setRayLength(length):
"""
Sets the maximum ray length of the distance constraint.
@type length: float
"""
def getRayLength():
"""
Returns the length of the ray
@rtype: float
"""
#}
class KX_ConstraintWrapper(PyObjectPlus):
"""
KX_ConstraintWrapper
"""
def getConstraintId(val):
"""
Returns the contraint's ID
@rtype: integer
@return: the constraint's ID
"""
class KX_GameActuator(SCA_IActuator):
"""
The game actuator loads a new .blend file, restarts the current .blend file or quits the game.
Properties:
@ivar fileName: the new .blend file to load
@type fileName: string.
@ivar mode: The mode of this actuator
@type mode: Constant in...
- L{GameLogic.KX_GAME_LOAD}
- L{GameLogic.KX_GAME_START}
- L{GameLogic.KX_GAME_RESTART}
- L{GameLogic.KX_GAME_QUIT}
- L{GameLogic.KX_GAME_SAVECFG}
- L{GameLogic.KX_GAME_LOADCFG}
"""
#{ Deprecated
def getFile():
"""
Returns the filename of the new .blend file to load.
@deprecated: use the L{fileName} property
@rtype: string
"""
def setFile(filename):
"""
Sets the new .blend file to load.
@deprecated: use the L{fileName} property
@param filename: The file name this actuator will load.
@type filename: string
"""
#}
class KX_GameObject(SCA_IObject):
"""
All game objects are derived from this class.
Properties assigned to game objects are accessible as attributes of this class.
- note: Calling ANY method or attribute on an object that has been removed from a scene will raise a SystemError, if an object may have been removed since last accessing it use the L{invalid} attribute to check.
@ivar name: The object's name. (read-only)
- note: Currently (Blender 2.49) the prefix "OB" is added to all objects name. This may change in blender 2.5.
@type name: string.
@ivar mass: The object's mass
- note: The object must have a physics controller for the mass to be applied, otherwise the mass value will be returned as 0.0
@type mass: float
@ivar linVelocityMin: Enforces the object keeps moving at a minimum velocity.
- note: Applies to dynamic and rigid body objects only.
- note: A value of 0.0 disables this option.
- note: While objects are stationary the minimum velocity will not be applied.
@type linVelocityMin: float
@ivar linVelocityMax: Clamp the maximum linear velocity to prevent objects moving beyond a set speed.
- note: Applies to dynamic and rigid body objects only.
- note: A value of 0.0 disables this option (rather then setting it stationary).
@type linVelocityMax: float
@ivar localInertia: the object's inertia vector in local coordinates. Read only.
@type localInertia: list [ix, iy, iz]
@ivar parent: The object's parent object. (read-only)
@type parent: L{KX_GameObject} or None
@ivar visible: visibility flag.
- note: Game logic will still run for invisible objects.
@type visible: boolean
@ivar occlusion: occlusion capability flag.
@type occlusion: boolean
@ivar position: The object's position.
deprecated: use L{localPosition} and L{worldPosition}
@type position: list [x, y, z] On write: local position, on read: world position
@ivar orientation: The object's orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector.
deprecated: use L{localOrientation} and L{worldOrientation}
@type orientation: 3x3 Matrix [[float]] On write: local orientation, on read: world orientation
@ivar scaling: The object's scaling factor. list [sx, sy, sz]
deprecated: use L{localScale} and L{worldScale}
@type scaling: list [sx, sy, sz] On write: local scaling, on read: world scaling
@ivar localOrientation: The object's local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector.
@type localOrientation: 3x3 Matrix [[float]]
@ivar worldOrientation: The object's world orientation.
@type worldOrientation: 3x3 Matrix [[float]]
@ivar localScale: The object's local scaling factor.
@type localScale: list [sx, sy, sz]
@ivar worldScale: The object's world scaling factor. Read-only
@type worldScale: list [sx, sy, sz]
@ivar localPosition: The object's local position.
@type localPosition: list [x, y, z]
@ivar worldPosition: The object's world position.
@type worldPosition: list [x, y, z]
@ivar timeOffset: adjust the slowparent delay at runtime.
@type timeOffset: float
@ivar state: the game object's state bitmask, using the first 30 bits, one bit must always be set.
@type state: int
@ivar meshes: a list meshes for this object.
- note: Most objects use only 1 mesh.
- note: Changes to this list will not update the KX_GameObject.
@type meshes: list of L{KX_MeshProxy}
@ivar sensors: a sequence of L{SCA_ISensor} objects with string/index lookups and iterator support.
- note: This attribute is experemental and may be removed (but probably wont be).
- note: Changes to this list will not update the KX_GameObject.
@type sensors: list
@ivar controllers: a sequence of L{SCA_IController} objects with string/index lookups and iterator support.
- note: This attribute is experemental and may be removed (but probably wont be).
- note: Changes to this list will not update the KX_GameObject.
@type controllers: list of L{SCA_ISensor}.
@ivar actuators: a list of L{SCA_IActuator} with string/index lookups and iterator support.
- note: This attribute is experemental and may be removed (but probably wont be).
- note: Changes to this list will not update the KX_GameObject.
@type actuators: list
@ivar attrDict: get the objects internal python attribute dictionary for direct (faster) access.
@type attrDict: dict
@ivar children: direct children of this object, (read-only).
@type children: L{CListValue} of L{KX_GameObject}'s
@ivar childrenRecursive: all children of this object including childrens children, (read-only).
@type childrenRecursive: L{CListValue} of L{KX_GameObject}'s
@group Deprecated: getPosition, setPosition, setWorldPosition, getOrientation, setOrientation, getState, setState, getParent, getVisible, getMass, getMesh, getChildren, getChildrenRecursive
@group Property Access: get, has_key, attrDict, getPropertyNames
"""
def endObject():
"""
Delete this object, can be used inpace of the EndObject Actuator.
The actual removal of the object from the scene is delayed.
"""
def replaceMesh(mesh):
"""
Replace the mesh of this object with a new mesh. This works the same was as the actuator.
@type mesh: L{KX_MeshProxy} or mesh name
"""
def getVisible():
"""
Gets the game object's visible flag.
@deprecated: use L{visible}
@rtype: boolean
"""
def setVisible(visible, recursive):
"""
Sets the game object's visible flag.
@type visible: boolean
@type recursive: boolean
@param recursive: optional argument to set all childrens visibility flag too.
"""
def setOcclusion(occlusion, recursive):
"""
Sets the game object's occlusion capability.
@type occlusion: boolean
@type recursive: boolean
@param recursive: optional argument to set all childrens occlusion flag too.
"""
def getState():
"""
Gets the game object's state bitmask.
@deprecated: use L{state}
@rtype: int
@return: the objects state.
"""
def setState(state):
"""
Sets the game object's state flag.
The bitmasks for states from 1 to 30 can be set with (1<<0, 1<<1, 1<<2 ... 1<<29)
@deprecated: use L{state}
@type state: integer
"""
def setPosition(pos):
"""
Sets the game object's position.
Global coordinates for root object, local for child objects.
@deprecated: use L{localPosition}
@type pos: [x, y, z]
@param pos: the new position, in local coordinates.
"""
def setWorldPosition(pos):
"""
Sets the game object's position in world coordinates regardless if the object is root or child.
@deprecated: use L{worldPosition}
@type pos: [x, y, z]
@param pos: the new position, in world coordinates.
"""
def getPosition():
"""
Gets the game object's position.
@deprecated: use L{worldPosition}
@rtype: list [x, y, z]
@return: the object's position in world coordinates.
"""
def setOrientation(orn):
"""
Sets the game object's orientation.
@deprecated: use L{localOrientation}
@type orn: 3x3 rotation matrix, or Quaternion.
@param orn: a rotation matrix specifying the new rotation.
@note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
"""
def alignAxisToVect(vect, axis, factor):
"""
Aligns any of the game object's axis along the given vector.
@type vect: 3d vector.
@param vect: a vector to align the axis.
@type axis: integer.
@param axis:The axis you want to align
- 0: X axis
- 1: Y axis
- 2: Z axis (default)
@type factor: float
@param factor: Only rotate a feaction of the distance to the target vector (0.0 - 1.0)
"""
def getAxisVect(vect):
"""
Returns the axis vector rotates by the objects worldspace orientation.
This is the equivalent if multiplying the vector by the orientation matrix.
@type vect: 3d vector.
@param vect: a vector to align the axis.
@rtype: 3d vector.
@return: The vector in relation to the objects rotation.
"""
def getOrientation():
"""
Gets the game object's orientation.
@deprecated: use L{worldOrientation}
@rtype: 3x3 rotation matrix
@return: The game object's rotation matrix
@note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
"""
def applyMovement(movement, local = 0):
"""
Sets the game object's movement.
@type movement: 3d vector.
@param movement: movement vector.
@type local: boolean
@param local: - False: you get the "global" movement ie: relative to world orientation (default).
- True: you get the "local" movement ie: relative to object orientation.
"""
def applyRotation(rotation, local = 0):
"""
Sets the game object's rotation.
@type rotation: 3d vector.
@param rotation: rotation vector.
@type local: boolean
@param local: - False: you get the "global" rotation ie: relative to world orientation (default).
- True: you get the "local" rotation ie: relative to object orientation.
"""
def applyForce(force, local = 0):
"""
Sets the game object's force.
This requires a dynamic object.
@type force: 3d vector.
@param force: force vector.
@type local: boolean
@param local: - False: you get the "global" force ie: relative to world orientation (default).
- True: you get the "local" force ie: relative to object orientation.
"""
def applyTorque(torque, local = 0):
"""
Sets the game object's torque.
This requires a dynamic object.
@type torque: 3d vector.
@param torque: torque vector.
@type local: boolean
@param local: - False: you get the "global" torque ie: relative to world orientation (default).
- True: you get the "local" torque ie: relative to object orientation.
"""
def getLinearVelocity(local = 0):
"""
Gets the game object's linear velocity.
This method returns the game object's velocity through it's centre of mass,
ie no angular velocity component.
@type local: boolean
@param local: - False: you get the "global" velocity ie: relative to world orientation (default).
- True: you get the "local" velocity ie: relative to object orientation.
@rtype: list [vx, vy, vz]
@return: the object's linear velocity.
"""
def setLinearVelocity(velocity, local = 0):
"""
Sets the game object's linear velocity.
This method sets game object's velocity through it's centre of mass,
ie no angular velocity component.
This requires a dynamic object.
@type velocity: 3d vector.
@param velocity: linear velocity vector.
@type local: boolean
@param local: - False: you get the "global" velocity ie: relative to world orientation (default).
- True: you get the "local" velocity ie: relative to object orientation.
"""
def getAngularVelocity(local = 0):
"""
Gets the game object's angular velocity.
@type local: boolean
@param local: - False: you get the "global" velocity ie: relative to world orientation (default).
- True: you get the "local" velocity ie: relative to object orientation.
@rtype: list [vx, vy, vz]
@return: the object's angular velocity.
"""
def setAngularVelocity(velocity, local = 0):
"""
Sets the game object's angular velocity.
This requires a dynamic object.
@type velocity: 3d vector.
@param velocity: angular velocity vector.
@type local: boolean
@param local: - False: you get the "global" velocity ie: relative to world orientation (default).
- True: you get the "local" velocity ie: relative to object orientation.
"""
def getVelocity(point):
"""
Gets the game object's velocity at the specified point.
Gets the game object's velocity at the specified point, including angular
components.
@type point: list [x, y, z]
@param point: the point to return the velocity for, in local coordinates. (optional: default = [0, 0, 0])
@rtype: list [vx, vy, vz]
@return: the velocity at the specified point.
"""
def getMass():
"""
Gets the game object's mass.
@deprecated: use L{mass}
@rtype: float
@return: the object's mass.
"""
def getReactionForce():
"""
Gets the game object's reaction force.
The reaction force is the force applied to this object over the last simulation timestep.
This also includes impulses, eg from collisions.
(B{This is not implimented for bullet physics at the moment})
@rtype: list [fx, fy, fz]
@return: the reaction force of this object.
"""
def applyImpulse(point, impulse):
"""
Applies an impulse to the game object.
This will apply the specified impulse to the game object at the specified point.
If point != getPosition(), applyImpulse will also change the object's angular momentum.
Otherwise, only linear momentum will change.
@type point: list [x, y, z]
@param point: the point to apply the impulse to (in world coordinates)
"""
def suspendDynamics():
"""
Suspends physics for this object.
"""
def restoreDynamics():
"""
Resumes physics for this object.
@Note: The objects linear velocity will be applied from when the dynamics were suspended.
"""
def enableRigidBody():
"""
Enables rigid body physics for this object.
Rigid body physics allows the object to roll on collisions.
@Note: This is not working with bullet physics yet.
"""
def disableRigidBody():
"""
Disables rigid body physics for this object.
@Note: This is not working with bullet physics yet. The angular is removed but rigid body physics can still rotate it later.
"""
def getParent():
"""
Gets this object's parent.
@deprecated: use L{parent}
@rtype: L{KX_GameObject}
@return: this object's parent object, or None if this object has no parent.
"""
def setParent(parent,compound,ghost):
"""
Sets this object's parent.
Control the shape status with the optional compound and ghost parameters:
compound=1: the object shape should be added to the parent compound shape (default)
compound=0: the object should keep its individual shape.
In that case you can control if it should be ghost or not:
ghost=1 if the object should be made ghost while parented (default)
ghost=0 if the object should be solid while parented
Note: if the object type is sensor, it stays ghost regardless of ghost parameter
@type parent: L{KX_GameObject}
@param parent: new parent object.
@type compound: int
@param compound: whether the shape should be added to the parent compound shape
@type ghost: int
@param ghost: whether the object should be ghost while parented
"""
def removeParent():
"""
Removes this objects parent.
"""
def getChildren():
"""
Return a list of immediate children of this object.
@rtype: L{CListValue} of L{KX_GameObject}
@return: a list of all this objects children.
"""
def getChildrenRecursive():
"""
Return a list of children of this object, including all their childrens children.
@rtype: L{CListValue} of L{KX_GameObject}
@return: a list of all this objects children recursivly.
"""
def getMesh(mesh):
"""
Gets the mesh object for this object.
@type mesh: integer
@param mesh: the mesh object to return (optional: default mesh = 0)
@rtype: L{KX_MeshProxy}
@return: the first mesh object associated with this game object, or None if this object has no meshs.
"""
def getPhysicsId():
"""
Returns the user data object associated with this game object's physics controller.
"""
def getPropertyNames():
"""
Gets a list of all property names.
@rtype: list
@return: All property names for this object.
"""
def getDistanceTo(other):
"""
Returns the distance to another object or point.
@param other: a point or another L{KX_GameObject} to measure the distance to.
@type other: L{KX_GameObject} or list [x, y, z]
@rtype: float
"""
def getVectTo(other):
"""
Returns the vector and the distance to another object or point.
The vector is normalized unless the distance is 0, in which a NULL vector is returned.
@param other: a point or another L{KX_GameObject} to get the vector and distance to.
@type other: L{KX_GameObject} or list [x, y, z]
@rtype: 3-tuple (float, 3-tuple (x,y,z), 3-tuple (x,y,z))
@return: (distance, globalVector(3), localVector(3))
"""
def rayCastTo(other,dist,prop):
"""
Look towards another point/object and find first object hit within dist that matches prop.
The ray is always casted from the center of the object, ignoring the object itself.
The ray is casted towards the center of another object or an explicit [x,y,z] point.
Use rayCast() if you need to retrieve the hit point
@param other: [x,y,z] or object towards which the ray is casted
@type other: L{KX_GameObject} or 3-tuple
@param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
@type dist: float
@param prop: property name that object must have; can be omitted => detect any object
@type prop: string
@rtype: L{KX_GameObject}
@return: the first object hit or None if no object or object does not match prop
"""
def rayCast(objto,objfrom,dist,prop,face,xray,poly):
"""
Look from a point/object to another point/object and find first object hit within dist that matches prop.
if poly is 0, returns a 3-tuple with object reference, hit point and hit normal or (None,None,None) if no hit.
if poly is 1, returns a 4-tuple with in addition a L{KX_PolyProxy} as 4th element.
Ex::
# shoot along the axis gun-gunAim (gunAim should be collision-free)
ob,point,normal = gun.rayCast(gunAim,None,50)
if ob:
# hit something
Notes:
The ray ignores the object on which the method is called.
It is casted from/to object center or explicit [x,y,z] points.
The face paremeter determines the orientation of the normal::
0 => hit normal is always oriented towards the ray origin (as if you casted the ray from outside)
1 => hit normal is the real face normal (only for mesh object, otherwise face has no effect)
The ray has X-Ray capability if xray parameter is 1, otherwise the first object hit (other than self object) stops the ray.
The prop and xray parameters interact as follow::
prop off, xray off: return closest hit or no hit if there is no object on the full extend of the ray.
prop off, xray on : idem.
prop on, xray off: return closest hit if it matches prop, no hit otherwise.
prop on, xray on : return closest hit matching prop or no hit if there is no object matching prop on the full extend of the ray.
The L{KX_PolyProxy} 4th element of the return tuple when poly=1 allows to retrieve information on the polygon hit by the ray.
If there is no hit or the hit object is not a static mesh, None is returned as 4th element.
The ray ignores collision-free objects and faces that dont have the collision flag enabled, you can however use ghost objects.
@param objto: [x,y,z] or object to which the ray is casted
@type objto: L{KX_GameObject} or 3-tuple
@param objfrom: [x,y,z] or object from which the ray is casted; None or omitted => use self object center
@type objfrom: L{KX_GameObject} or 3-tuple or None
@param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to to
@type dist: float
@param prop: property name that object must have; can be omitted or "" => detect any object
@type prop: string
@param face: normal option: 1=>return face normal; 0 or omitted => normal is oriented towards origin
@type face: int
@param xray: X-ray option: 1=>skip objects that don't match prop; 0 or omitted => stop on first object
@type xray: int
@param poly: polygon option: 1=>return value is a 4-tuple and the 4th element is a L{KX_PolyProxy}
@type poly: int
@rtype: 3-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz))
or 4-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), L{KX_PolyProxy})
@return: (object,hitpoint,hitnormal) or (object,hitpoint,hitnormal,polygon)
If no hit, returns (None,None,None) or (None,None,None,None)
If the object hit is not a static mesh, polygon is None
"""
def setCollisionMargin(margin):
"""
Set the objects collision margin.
note: If this object has no physics controller (a physics ID of zero), this function will raise RuntimeError.
@type margin: float
@param margin: the collision margin distance in blender units.
"""
def sendMessage(subject, body="", to=""):
"""
Sends a message.
@param subject: The subject of the message
@type subject: string
@param body: The body of the message (optional)
@type body: string
@param to: The name of the object to send the message to (optional)
@type to: string
"""
def reinstancePhysicsMesh(gameObject, meshObject):
"""
Updates the physics system with the changed mesh.
If no arguments are given the physics mesh will be re-created from the first mesh assigned to the game object.
@param gameObject: optional argument, set the physics shape from this gameObjets mesh.
@type gameObject: string, L{KX_GameObject} or None
@param meshObject: optional argument, set the physics shape from this mesh.
@type meshObject: string, L{KX_MeshProxy} or None
@note: if this object has instances the other instances will be updated too.
@note: the gameObject argument has an advantage that it can convert from a mesh with modifiers applied (such as subsurf).
@warning: only triangle mesh type objects are supported currently (not convex hull)
@warning: if the object is a part of a combound object it will fail (parent or child)
@warning: rebuilding the physics mesh can be slow, running many times per second will give a performance hit.
@rtype: boolean
@return: True if reinstance succeeded, False if it failed.
"""
def get(key, default=None):
"""
Return the value matching key, or the default value if its not found.
@return: The key value or a default.
"""
def has_key(key):
"""
Return True if the key is found.
@rtype: boolean
@return: The key value or a default.
"""
class KX_IpoActuator(SCA_IActuator):
"""
IPO actuator activates an animation.
@ivar frameStart: Start frame.
@type frameStart: float
@ivar frameEnd: End frame.
@type frameEnd: float
@ivar propName: Use this property to define the Ipo position
@type propName: string
@ivar framePropName: Assign this property this action current frame number
@type framePropName: string
@ivar mode: Play mode for the ipo. (In GameLogic.KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND, KX_IPOACT_FROM_PROP)
@type mode: int
@ivar useIpoAsForce: Apply Ipo as a global or local force depending on the local option (dynamic objects only)
@type useIpoAsForce: bool
@ivar useIpoAdd: Ipo is added to the current loc/rot/scale in global or local coordinate according to Local flag
@type useIpoAdd: bool
@ivar useIpoLocal: Let the ipo acts in local coordinates, used in Force and Add mode.
@type useIpoLocal: bool
@ivar useChildren: Update IPO on all children Objects as well
@type useChildren: bool
"""
#{ Deprecated
def set(mode, startframe, endframe, force):
"""
Sets the properties of the actuator.
@deprecated: use other attributes.
@param mode: "Play", "PingPong", "Flipper", "LoopStop", "LoopEnd" or "FromProp"
@type mode: string
@param startframe: first frame to use
@type startframe: integer
@param endframe: last frame to use
@type endframe: integer
@param force: special mode
@type force: integer (0=normal, 1=interpret location as force, 2=additive)
"""
def setProperty(property):
"""
Sets the name of the property to be used in FromProp mode.
@deprecated: use L{propName}
@type property: string
"""
def setStart(startframe):
"""
Sets the frame from which the IPO starts playing.
@deprecated: use L{frameStart}
@type startframe: integer
"""
def getStart():
"""
Returns the frame from which the IPO starts playing.
@deprecated: use L{frameStart}
@rtype: integer
"""
def setEnd(endframe):
"""
Sets the frame at which the IPO stops playing.
@deprecated: use L{frameEnd}
@type endframe: integer
"""
def getEnd():
"""
Returns the frame at which the IPO stops playing.
@deprecated: use L{frameEnd}
@rtype: integer
"""
def setIpoAsForce(force):
"""
Set whether to interpret the ipo as a force rather than a displacement.
@deprecated: use L{useIpoAsForce}
@type force: boolean
@param force: KX_TRUE or KX_FALSE
"""
def getIpoAsForce():
"""
Returns whether to interpret the ipo as a force rather than a displacement.
@deprecated: use L{useIpoAsForce}
@rtype: boolean
"""
def setIpoAdd(add):
"""
Set whether to interpret the ipo as additive rather than absolute.
@deprecated: use L{useIpoAdd}
@type add: boolean
@param add: KX_TRUE or KX_FALSE
"""
def getIpoAdd():
"""
Returns whether to interpret the ipo as additive rather than absolute.
@deprecated: use L{useIpoAdd}
@rtype: boolean
"""
def setType(mode):
"""
Sets the operation mode of the actuator.
@deprecated: use L{type}
@param mode: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
@type mode: string
"""
def getType():
"""
Returns the operation mode of the actuator.
@deprecated: use L{type}
@rtype: integer
@return: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
"""
def setForceIpoActsLocal(local):
"""
Set whether to apply the force in the object's local
coordinates rather than the world global coordinates.
@deprecated: use L{useIpoLocal}
@param local: Apply the ipo-as-force in the object's local
coordinates? (KX_TRUE, KX_FALSE)
@type local: boolean
"""
def getForceIpoActsLocal():
"""
Return whether to apply the force in the object's local
coordinates rather than the world global coordinates.
@deprecated: use L{useIpoLocal}
"""
#}
class KX_LightObject(KX_GameObject):
"""
A Light object.
Example:
# Turn on a red alert light.
import GameLogic
co = GameLogic.getCurrentController()
light = co.owner
light.energy = 1.0
light.colour = [1.0, 0.0, 0.0]
@group Constants: NORMAL, SPOT, SUN
@ivar SPOT: A spot light source. See attribute 'type'
@ivar SUN: A point light source with no attenuation. See attribute 'type'
@ivar NORMAL: A point light source. See attribute 'type'
@ivar type: The type of light - must be SPOT, SUN or NORMAL
@ivar layer: The layer mask that this light affects object on.
@type layer: bitfield
@ivar energy: The brightness of this light.
@type energy: float
@ivar distance: The maximum distance this light can illuminate. (SPOT and NORMAL lights only)
@type distance: float
@ivar colour: The colour of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]
@type colour: list [r, g, b]
@ivar color: Synonym for colour.
@ivar lin_attenuation: The linear component of this light's attenuation. (SPOT and NORMAL lights only)
@type lin_attenuation: float
@ivar quad_attenuation: The quadratic component of this light's attenuation (SPOT and NORMAL lights only)
@type quad_attenuation: float
@ivar spotsize: The cone angle of the spot light, in degrees. (float) (SPOT lights only)
0.0 <= spotsize <= 180.0. Spotsize = 360.0 is also accepted.
@ivar spotblend: Specifies the intensity distribution of the spot light. (float) (SPOT lights only)
Higher values result in a more focused light source.
0.0 <= spotblend <= 1.0.
"""
class KX_MeshProxy(SCA_IObject):
"""
A mesh object.
You can only change the vertex properties of a mesh object, not the mesh topology.
To use mesh objects effectively, you should know a bit about how the game engine handles them.
1. Mesh Objects are converted from Blender at scene load.
2. The Converter groups polygons by Material. This means they can be sent to the
renderer efficiently. A material holds:
1. The texture.
2. The Blender material.
3. The Tile properties
4. The face properties - (From the "Texture Face" panel)
5. Transparency & z sorting
6. Light layer
7. Polygon shape (triangle/quad)
8. Game Object
3. Verticies will be split by face if necessary. Verticies can only be shared between
faces if:
1. They are at the same position
2. UV coordinates are the same
3. Their normals are the same (both polygons are "Set Smooth")
4. They are the same colour
For example: a cube has 24 verticies: 6 faces with 4 verticies per face.
The correct method of iterating over every L{KX_VertexProxy} in a game object::
import GameLogic
co = GameLogic.getCurrentController()
obj = co.owner
m_i = 0
mesh = obj.getMesh(m_i) # There can be more than one mesh...
while mesh != None:
for mat in range(mesh.getNumMaterials()):
for v_index in range(mesh.getVertexArrayLength(mat)):
vertex = mesh.getVertex(mat, v_index)
# Do something with vertex here...
# ... eg: colour the vertex red.
vertex.colour = [1.0, 0.0, 0.0, 1.0]
m_i += 1
mesh = obj.getMesh(m_i)
@ivar materials:
@type materials: list of L{KX_BlenderMaterial} or L{KX_PolygonMaterial} types
@ivar numPolygons:
@type numPolygons: integer
@ivar numMaterials:
@type numMaterials: integer
"""
def getNumMaterials():
"""
Gets the number of materials associated with this object.
@rtype: integer
"""
def getMaterialName(matid):
"""
Gets the name of the specified material.
@type matid: integer
@param matid: the specified material.
@rtype: string
@return: the attached material name.
"""
def getTextureName(matid):
"""
Gets the name of the specified material's texture.
@type matid: integer
@param matid: the specified material
@rtype: string
@return: the attached material's texture name.
"""
def getVertexArrayLength(matid):
"""
Gets the length of the vertex array associated with the specified material.
There is one vertex array for each material.
@type matid: integer
@param matid: the specified material
@rtype: integer
@return: the number of verticies in the vertex array.
"""
def getVertex(matid, index):
"""
Gets the specified vertex from the mesh object.
@type matid: integer
@param matid: the specified material
@type index: integer
@param index: the index into the vertex array.
@rtype: L{KX_VertexProxy}
@return: a vertex object.
"""
def getNumPolygons():
"""
Returns the number of polygon in the mesh.
@rtype: integer
"""
def getPolygon(index):
"""
Gets the specified polygon from the mesh.
@type index: integer
@param index: polygon number
@rtype: L{KX_PolyProxy}
@return: a polygon object.
"""
class SCA_MouseSensor(SCA_ISensor):
"""
Mouse Sensor logic brick.
Properties:
@ivar position: current [x,y] coordinates of the mouse, in frame coordinates (pixels)
@type position: [integer,interger]
@ivar mode: sensor mode: 1=KX_MOUSESENSORMODE_LEFTBUTTON 2=KX_MOUSESENSORMODE_MIDDLEBUTTON
3=KX_MOUSESENSORMODE_RIGHTBUTTON 4=KX_MOUSESENSORMODE_WHEELUP
5=KX_MOUSESENSORMODE_WHEELDOWN 9=KX_MOUSESENSORMODE_MOVEMENT
@type mode: integer
"""
def getXPosition():
"""
Gets the x coordinate of the mouse.
@deprecated: use the L{position} property
@rtype: integer
@return: the current x coordinate of the mouse, in frame coordinates (pixels)
"""
def getYPosition():
"""
Gets the y coordinate of the mouse.
@deprecated: use the L{position} property
@rtype: integer
@return: the current y coordinate of the mouse, in frame coordinates (pixels).
"""
def getButtonStatus(button):
"""
Get the mouse button status.
@type button: int
@param button: value in GameLogic members KX_MOUSE_BUT_LEFT, KX_MOUSE_BUT_MIDDLE, KX_MOUSE_BUT_RIGHT
@rtype: integer
@return: value in GameLogic members KX_INPUT_NONE, KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED
"""
class KX_MouseFocusSensor(SCA_MouseSensor):
"""
The mouse focus sensor detects when the mouse is over the current game object.
The mouse focus sensor works by transforming the mouse coordinates from 2d device
space to 3d space then raycasting away from the camera.
@ivar raySource: The worldspace source of the ray (the view position)
@type raySource: list (vector of 3 floats)
@ivar rayTarget: The worldspace target of the ray.
@type rayTarget: list (vector of 3 floats)
@ivar rayDirection: The L{rayTarget} - L{raySource} normalized.
@type rayDirection: list (normalized vector of 3 floats)
@ivar hitObject: the last object the mouse was over.
@type hitObject: L{KX_GameObject} or None
@ivar hitPosition: The worldspace position of the ray intersecton.
@type hitPosition: list (vector of 3 floats)
@ivar hitNormal: the worldspace normal from the face at point of intersection.
@type hitNormal: list (normalized vector of 3 floats)
"""
#{ Deprecated
def getHitNormal():
"""
Returns the normal (in worldcoordinates) at the point of collision where the object was hit by this ray.
@deprecated: use the L{hitNormal} property
@rtype: list [x, y, z]
@return: the ray collision normal.
"""
def getHitObject():
"""
Returns the object that was hit by this ray or None.
@deprecated: use the L{hitObject} property
@rtype: L{KX_GameObject} or None
@return: the collision object.
"""
def getHitPosition():
"""
Returns the position (in worldcoordinates) at the point of collision where the object was hit by this ray.
@deprecated: use the L{hitPosition} property
@rtype: list [x, y, z]
@return: the ray collision position.
"""
def getRayDirection():
"""
Returns the normalized direction (in worldcoordinates) of the ray cast by the mouse.
@deprecated: use the L{rayDirection} property
@rtype: list [x, y, z]
@return: the ray direction.
"""
def getRaySource():
"""
Returns the position (in worldcoordinates) the ray was cast from by the mouse.
@deprecated: use the L{raySource} property
@rtype: list [x, y, z]
@return: the ray source.
"""
def getRayTarget():
"""
Returns the target of the ray (in worldcoordinates) that seeks the focus object.
@deprecated: use the L{rayTarget} property
@rtype: list [x, y, z]
@return: the ray target.
"""
#}
class KX_TouchSensor(SCA_ISensor):
"""
Touch sensor detects collisions between objects.
@ivar propName: The property or material to collide with.
@type propName: string
@ivar useMaterial: Determines if the sensor is looking for a property or material.
KX_True = Find material; KX_False = Find property
@type useMaterial: boolean
@ivar usePulseCollision: The last collided object.
@type usePulseCollision: bool
@ivar hitObject: The last collided object. (read-only)
@type hitObject: L{KX_GameObject} or None
@ivar hitObjectList: A list of colliding objects. (read-only)
@type hitObjectList: L{CListValue} of L{KX_GameObject}
"""
#{ Deprecated
def setProperty(name):
"""
Set the property or material to collide with. Use
setTouchMaterial() to switch between properties and
materials.
@deprecated: use the L{property} property
@type name: string
"""
def getProperty():
"""
Returns the property or material to collide with. Use
getTouchMaterial() to find out whether this sensor
looks for properties or materials.
@deprecated: use the L{property} property
@rtype: string
"""
def getHitObject():
"""
Returns the last object hit by this touch sensor.
@deprecated: use the L{hitObject} property
@rtype: L{KX_GameObject}
"""
def getHitObjectList():
"""
Returns a list of all objects hit in the last frame. (B{deprecated})
Only objects that have the requisite material/property are listed.
@deprecated: use the L{hitObjectList} property
@rtype: L{CListValue} of L{hitObjectList}
"""
def getTouchMaterial():
"""
Returns KX_TRUE if this sensor looks for a specific material,
KX_FALSE if it looks for a specific property. (B{deprecated})
@deprecated: use the L{useMaterial} property
"""
#}
class KX_NearSensor(KX_TouchSensor):
"""
A near sensor is a specialised form of touch sensor.
@ivar distance: The near sensor activates when an object is within this distance.
@type distance: float
@ivar resetDistance: The near sensor deactivates when the object exceeds this distance.
@type resetDistance: float
"""
class KX_NetworkMessageActuator(SCA_IActuator):
"""
Message Actuator
@ivar propName: Messages will only be sent to objects with the given property name.
@type propName: string
@ivar subject: The subject field of the message.
@type subject: string
@ivar body: The body of the message.
@type body: string
@ivar usePropBody: Send a property instead of a regular body message.
@type usePropBody: boolean
"""
#{Deprecated
def setToPropName(name):
"""
Messages will only be sent to objects with the given property name.
@deprecated: Use the L{propName} attribute instead.
@type name: string
"""
def setSubject(subject):
"""
Sets the subject field of the message.
@deprecated: Use the L{subject} attribute instead.
@type subject: string
"""
def setBodyType(bodytype):
"""
Sets the type of body to send.
@deprecated: Use the L{usePropBody} attribute instead.
@type bodytype: boolean
@param bodytype: True to send the value of a property, False to send the body text.
"""
def setBody(body):
"""
Sets the message body.
@deprecated: Use the L{body} attribute instead.
@type body: string
@param body: if the body type is True, this is the name of the property to send.
if the body type is False, this is the text to send.
"""
#}
class KX_NetworkMessageSensor(SCA_ISensor):
"""
The Message Sensor logic brick.
Currently only loopback (local) networks are supported.
@ivar subject: The subject the sensor is looking for.
@type subject: string
@ivar frameMessageCount: The number of messages received since the last frame.
(Read-only)
@type frameMessageCount: int
@ivar subjects: The list of message subjects received. (Read-only)
@type subjects: list of strings
@ivar bodies: The list of message bodies received. (Read-only)
@type bodies: list of strings
"""
#{ Deprecated
def setSubjectFilterText(subject):
"""
Change the message subject text that this sensor is listening to.
@deprecated: Use the L{subject} attribute instead.
@type subject: string
@param subject: the new message subject to listen for.
"""
def getFrameMessageCount():
"""
Get the number of messages received since the last frame.
@deprecated: Use the L{frameMessageCount} attribute instead.
@rtype: integer
"""
def getBodies():
"""
Gets the list of message bodies.
@deprecated: Use the L{bodies} attribute instead.
@rtype: list
"""
def getSubject():
"""
Gets the message subject this sensor is listening for from the Subject: field.
@deprecated: Use the L{subject} attribute instead.
@rtype: string
"""
def getSubjects():
"""
Gets the list of message subjects received.
@deprecated: Use the L{subjects} attribute instead.
@rtype: list
"""
#}
class KX_ObjectActuator(SCA_IActuator):
"""
The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement,
velocity, or angular velocity to an object.
Servo control allows to regulate force to achieve a certain speed target.
@ivar force: The force applied by the actuator
@type force: list [x, y, z]
@ivar useLocalForce: A flag specifying if the force is local
@type useLocalForce: bool
@ivar torque: The torque applied by the actuator
@type torque: list [x, y, z]
@ivar useLocalTorque: A flag specifying if the torque is local
@type useLocalTorque: bool
@ivar dLoc: The displacement vector applied by the actuator
@type dLoc: list [x, y, z]
@ivar useLocalDLoc: A flag specifying if the dLoc is local
@type useLocalDLoc: bool
@ivar dRot: The angular displacement vector applied by the actuator
- note: Since the displacement is applied every frame, you must adjust the displacement
based on the frame rate, or you game experience will depend on the player's computer
speed.
@type dRot: list [x, y, z]
@ivar useLocalDRot: A flag specifying if the dRot is local
@type useLocalDRot: bool
@ivar linV: The linear velocity applied by the actuator
@type linV: list [x, y, z]
@ivar useLocalLinV: A flag specifying if the linear velocity is local
- note: This is the target speed for servo controllers
@type useLocalLinV: bool
@ivar angV: The angular velocity applied by the actuator
@type angV: list [x, y, z]
@ivar useLocalAngV: A flag specifying if the angular velocity is local
@type useLocalAngV: bool
@ivar damping: The damping parameter of the servo controller
@type damping: short
@ivar forceLimitX: The min/max force limit along the X axis and activates or deactivates the limits in the servo controller
@type forceLimitX: list [min(float), max(float), bool]
@ivar forceLimitY: The min/max force limit along the Y axis and activates or deactivates the limits in the servo controller
@type forceLimitY: list [min(float), max(float), bool]
@ivar forceLimitZ: The min/max force limit along the Z axis and activates or deactivates the limits in the servo controller
@type forceLimitZ: list [min(float), max(float), bool]
@ivar pid: The PID coefficients of the servo controller
@type pid: list of floats [proportional, integral, derivate]
@ivar reference: The object that is used as reference to compute the velocity for the servo controller.
@type reference: KX_GameObject or None
@group Deprecated: getForce, setForce, getTorque, setTorque, getDLoc, setDLoc, getDRot, setDRot, getLinearVelocity, setLinearVelocity, getAngularVelocity,
setAngularVelocity, getDamping, setDamping, getForceLimitX, setForceLimitX, getForceLimitY, setForceLimitY, getForceLimitZ, setForceLimitZ,
getPID, setPID
"""
def getForce():
"""
Returns the force applied by the actuator.
@deprecated: Use L{force} and L{useLocalForce} instead.
@rtype: list [fx, fy, fz, local]
@return: A four item list, containing the vector force, and a flag specifying whether the force is local.
"""
def setForce(fx, fy, fz, local):
"""
Sets the force applied by the actuator.
@deprecated: Use L{force} and L{useLocalForce} instead.
@type fx: float
@param fx: the x component of the force.
@type fy: float
@param fy: the z component of the force.
@type fz: float
@param fz: the z component of the force.
@type local: boolean
@param local: - False: the force is applied in world coordinates.
- True: the force is applied in local coordinates.
"""
def getTorque():
"""
Returns the torque applied by the actuator.
@deprecated: Use L{torque} and L{useLocalTorque} instead.
@rtype: list [S{Tau}x, S{Tau}y, S{Tau}z, local]
@return: A four item list, containing the vector torque, and a flag specifying whether
the torque is applied in local coordinates (True) or world coordinates (False)
"""
def setTorque(tx, ty, tz, local):
"""
Sets the torque applied by the actuator.
@deprecated: Use L{torque} and L{useLocalTorque} instead.
@type tx: float
@param tx: the x component of the torque.
@type ty: float
@param ty: the z component of the torque.
@type tz: float
@param tz: the z component of the torque.
@type local: boolean
@param local: - False: the torque is applied in world coordinates.
- True: the torque is applied in local coordinates.
"""
def getDLoc():
"""
Returns the displacement vector applied by the actuator.
@deprecated: Use L{dLoc} and L{useLocalDLoc} instead.
@rtype: list [dx, dy, dz, local]
@return: A four item list, containing the vector displacement, and whether
the displacement is applied in local coordinates (True) or world
coordinates (False)
"""
def setDLoc(dx, dy, dz, local):
"""
Sets the displacement vector applied by the actuator.
Since the displacement is applied every frame, you must adjust the displacement
based on the frame rate, or you game experience will depend on the player's computer
speed.
@deprecated: Use L{dLoc} and L{useLocalDLoc} instead.
@type dx: float
@param dx: the x component of the displacement vector.
@type dy: float
@param dy: the z component of the displacement vector.
@type dz: float
@param dz: the z component of the displacement vector.
@type local: boolean
@param local: - False: the displacement vector is applied in world coordinates.
- True: the displacement vector is applied in local coordinates.
"""
def getDRot():
"""
Returns the angular displacement vector applied by the actuator.
@deprecated: Use L{dRot} and L{useLocalDRot} instead.
@rtype: list [dx, dy, dz, local]
@return: A four item list, containing the angular displacement vector, and whether
the displacement is applied in local coordinates (True) or world coordinates (False)
"""
def setDRot(dx, dy, dz, local):
"""
Sets the angular displacement vector applied by the actuator.
Since the displacement is applied every frame, you must adjust the displacement
based on the frame rate, or you game experience will depend on the player's computer
speed.
@deprecated: Use L{dRot} and L{useLocalDRot} instead.
@type dx: float
@param dx: the x component of the angular displacement vector.
@type dy: float
@param dy: the z component of the angular displacement vector.
@type dz: float
@param dz: the z component of the angular displacement vector.
@type local: boolean
@param local: - False: the angular displacement vector is applied in world coordinates.
- True: the angular displacement vector is applied in local coordinates.
"""
def getLinearVelocity():
"""
Returns the linear velocity applied by the actuator.
For the servo control actuator, this is the target speed.
@deprecated: Use L{linV} and L{useLocalLinV} instead.
@rtype: list [vx, vy, vz, local]
@return: A four item list, containing the vector velocity, and whether the velocity is applied in local coordinates (True) or world coordinates (False)
"""
def setLinearVelocity(vx, vy, vz, local):
"""
Sets the linear velocity applied by the actuator.
For the servo control actuator, sets the target speed.
@deprecated: Use L{linV} and L{useLocalLinV} instead.
@type vx: float
@param vx: the x component of the velocity vector.
@type vy: float
@param vy: the z component of the velocity vector.
@type vz: float
@param vz: the z component of the velocity vector.
@type local: boolean
@param local: - False: the velocity vector is in world coordinates.
- True: the velocity vector is in local coordinates.
"""
def getAngularVelocity():
"""
Returns the angular velocity applied by the actuator.
@deprecated: Use L{angV} and L{useLocalAngV} instead.
@rtype: list [S{omega}x, S{omega}y, S{omega}z, local]
@return: A four item list, containing the vector velocity, and whether
the velocity is applied in local coordinates (True) or world
coordinates (False)
"""
def setAngularVelocity(wx, wy, wz, local):
"""
Sets the angular velocity applied by the actuator.
@deprecated: Use L{angV} and L{useLocalAngV} instead.
@type wx: float
@param wx: the x component of the velocity vector.
@type wy: float
@param wy: the z component of the velocity vector.
@type wz: float
@param wz: the z component of the velocity vector.
@type local: boolean
@param local: - False: the velocity vector is applied in world coordinates.
- True: the velocity vector is applied in local coordinates.
"""
def getDamping():
"""
Returns the damping parameter of the servo controller.
@deprecated: Use L{damping} instead.
@rtype: integer
@return: the time constant of the servo controller in frame unit.
"""
def setDamping(damp):
"""
Sets the damping parameter of the servo controller.
@deprecated: Use L{damping} instead.
@type damp: integer
@param damp: the damping parameter in frame unit.
"""
def getForceLimitX():
"""
Returns the min/max force limit along the X axis used by the servo controller.
@deprecated: Use L{forceLimitX} instead.
@rtype: list [min, max, enabled]
@return: A three item list, containing the min and max limits of the force as float
and whether the limits are active(true) or inactive(true)
"""
def setForceLimitX(min, max, enable):
"""
Sets the min/max force limit along the X axis and activates or deactivates the limits in the servo controller.
@deprecated: Use L{forceLimitX} instead.
@type min: float
@param min: the minimum value of the force along the X axis.
@type max: float
@param max: the maximum value of the force along the X axis.
@type enable: boolean
@param enable: - True: the force will be limited to the min/max
- False: the force will not be limited
"""
def getForceLimitY():
"""
Returns the min/max force limit along the Y axis used by the servo controller.
@deprecated: Use L{forceLimitY} instead.
@rtype: list [min, max, enabled]
@return: A three item list, containing the min and max limits of the force as float
and whether the limits are active(true) or inactive(true)
"""
def setForceLimitY(min, max, enable):
"""
Sets the min/max force limit along the Y axis and activates or deactivates the limits in the servo controller.
@deprecated: Use L{forceLimitY} instead.
@type min: float
@param min: the minimum value of the force along the Y axis.
@type max: float
@param max: the maximum value of the force along the Y axis.
@type enable: boolean
@param enable: - True: the force will be limited to the min/max
- False: the force will not be limited
"""
def getForceLimitZ():
"""
Returns the min/max force limit along the Z axis used by the servo controller.
@deprecated: Use L{forceLimitZ} instead.
@rtype: list [min, max, enabled]
@return: A three item list, containing the min and max limits of the force as float
and whether the limits are active(true) or inactive(true)
"""
def setForceLimitZ(min, max, enable):
"""
Sets the min/max force limit along the Z axis and activates or deactivates the limits in the servo controller.
@deprecated: Use L{forceLimitZ} instead.
@type min: float
@param min: the minimum value of the force along the Z axis.
@type max: float
@param max: the maximum value of the force along the Z axis.
@type enable: boolean
@param enable: - True: the force will be limited to the min/max
- False: the force will not be limited
"""
def getPID():
"""
Returns the PID coefficient of the servo controller.
@deprecated: Use L{pid} instead.
@rtype: list [P, I, D]
@return: A three item list, containing the PID coefficient as floats:
P : proportional coefficient
I : Integral coefficient
D : Derivate coefficient
"""
def setPID(P, I, D):
"""
Sets the PID coefficients of the servo controller.
@deprecated: Use L{pid} instead.
@type P: flat
@param P: proportional coefficient
@type I: float
@param I: Integral coefficient
@type D: float
@param D: Derivate coefficient
"""
class KX_ParentActuator(SCA_IActuator):
"""
The parent actuator can set or remove an objects parent object.
@ivar object: the object this actuator sets the parent too.
@type object: KX_GameObject or None
@ivar mode: The mode of this actuator
@type mode: int from 0 to 1 L{GameLogic.Parent Actuator}
@ivar compound: Whether the object shape should be added to the parent compound shape when parenting
Effective only if the parent is already a compound shape
@type compound: bool
@ivar ghost: whether the object should be made ghost when parenting
Effective only if the shape is not added to the parent compound shape
@type ghost: bool
"""
def setObject(object):
"""
Sets the object to set as parent.
Object can be either a L{KX_GameObject} or the name of the object.
@deprecated: Use the L{object} property.
@type object: L{KX_GameObject}, string or None
"""
def getObject(name_only = 1):
"""
Returns the name of the object to change to.
@deprecated: Use the L{object} property.
@type name_only: bool
@param name_only: optional argument, when 0 return a KX_GameObject
@rtype: string, KX_GameObject or None if no object is set
"""
class KX_PhysicsObjectWrapper(PyObjectPlus):
"""
KX_PhysicsObjectWrapper
"""
def setActive(active):
"""
Set the object to be active.
@param active: set to True to be active
@type active: bool
"""
def setAngularVelocity(x, y, z, local):
"""
Set the angular velocity of the object.
@param x: angular velocity for the x-axis
@type x: float
@param y: angular velocity for the y-axis
@type y: float
@param z: angular velocity for the z-axis
@type z: float
@param local: set to True for local axis
@type local: bool
"""
def setLinearVelocity(x, y, z, local):
"""
Set the linear velocity of the object.
@param x: linear velocity for the x-axis
@type x: float
@param y: linear velocity for the y-axis
@type y: float
@param z: linear velocity for the z-axis
@type z: float
@param local: set to True for local axis
@type local: bool
"""
def setPosition(x, y, z):
"""
Set the position of the object
@param x: x coordinate
@type x: float
@param y: y coordinate
@type y: float
@param z: z coordinate
@type z: float
"""
class KX_PolyProxy(SCA_IObject):
"""
A polygon holds the index of the vertex forming the poylgon.
Note:
The polygon attributes are read-only, you need to retrieve the vertex proxy if you want
to change the vertex settings.
@ivar matname: The name of polygon material, empty if no material.
@type matname: string
@ivar material: The material of the polygon
@type material: L{KX_PolygonMaterial} or L{KX_BlenderMaterial}
@ivar texture: The texture name of the polygon.
@type texture: string
@ivar matid: The material index of the polygon, use this to retrieve vertex proxy from mesh proxy
@type matid: integer
@ivar v1: vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
@type v1: integer
@ivar v2: vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
@type v2: integer
@ivar v3: vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
@type v3: integer
@ivar v4: vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex
use this to retrieve vertex proxy from mesh proxy
@type v4: integer
@ivar visible: visible state of the polygon: 1=visible, 0=invisible
@type visible: integer
@ivar collide: collide state of the polygon: 1=receives collision, 0=collision free.
@type collide: integer
"""
def getMaterialName():
"""
Returns the polygon material name with MA prefix
@rtype: string
@return: material name
"""
def getMaterial():
"""
Returns the polygon material
@rtype: L{KX_PolygonMaterial} or L{KX_BlenderMaterial}
"""
def getTextureName():
"""
Returns the polygon texture name
@rtype: string
@return: texture name
"""
def getMaterialIndex():
"""
Returns the material bucket index of the polygon.
This index and the ones returned by getVertexIndex() are needed to retrieve the vertex proxy from L{KX_MeshProxy}.
@rtype: integer
@return: the material index in the mesh
"""
def getNumVertex():
"""
Returns the number of vertex of the polygon.
@rtype: integer
@return: number of vertex, 3 or 4.
"""
def isVisible():
"""
Returns whether the polygon is visible or not
@rtype: integer
@return: 0=invisible, 1=visible
"""
def isCollider():
"""
Returns whether the polygon is receives collision or not
@rtype: integer
@return: 0=collision free, 1=receives collision
"""
def getVertexIndex(vertex):
"""
Returns the mesh vertex index of a polygon vertex
This index and the one returned by getMaterialIndex() are needed to retrieve the vertex proxy from L{KX_MeshProxy}.
@type vertex: integer
@param vertex: index of the vertex in the polygon: 0->3
@rtype: integer
@return: mesh vertex index
"""
def getMesh():
"""
Returns a mesh proxy
@rtype: L{KX_MeshProxy}
@return: mesh proxy
"""
class KX_PolygonMaterial:
"""
This is the interface to materials in the game engine.
Materials define the render state to be applied to mesh objects.
Warning: Some of the methods/variables are CObjects. If you mix these up,
you will crash blender.
This example requires:
- PyOpenGL http://pyopengl.sourceforge.net/
- GLEWPy http://glewpy.sourceforge.net/
Example::
import GameLogic
import OpenGL
from OpenGL.GL import *
from OpenGL.GLU import *
import glew
from glew import *
glewInit()
vertex_shader = \"\"\"
void main(void)
{
gl_Position = ftransform();
}
\"\"\"
fragment_shader =\"\"\"
void main(void)
{
gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);
}
\"\"\"
class MyMaterial:
def __init__(self):
self.pass_no = 0
# Create a shader
self.m_program = glCreateProgramObjectARB()
# Compile the vertex shader
self.shader(GL_VERTEX_SHADER_ARB, (vertex_shader))
# Compile the fragment shader
self.shader(GL_FRAGMENT_SHADER_ARB, (fragment_shader))
# Link the shaders together
self.link()
def PrintInfoLog(self, tag, object):
\"\"\"
PrintInfoLog prints the GLSL compiler log
\"\"\"
print "Tag: def PrintGLError(self, tag = ""):
def PrintGLError(self, tag = ""):
\"\"\"
Prints the current GL error status
\"\"\"
if len(tag):
print tag
err = glGetError()
if err != GL_NO_ERROR:
print "GL Error: %s\\n"%(gluErrorString(err))
def shader(self, type, shaders):
\"\"\"
shader compiles a GLSL shader and attaches it to the current
program.
type should be either GL_VERTEX_SHADER_ARB or GL_FRAGMENT_SHADER_ARB
shaders should be a sequence of shader source to compile.
\"\"\"
# Create a shader object
shader_object = glCreateShaderObjectARB(type)
# Add the source code
glShaderSourceARB(shader_object, len(shaders), shaders)
# Compile the shader
glCompileShaderARB(shader_object)
# Print the compiler log
self.PrintInfoLog("vertex shader", shader_object)
# Check if compiled, and attach if it did
compiled = glGetObjectParameterivARB(shader_object, GL_OBJECT_COMPILE_STATUS_ARB)
if compiled:
glAttachObjectARB(self.m_program, shader_object)
# Delete the object (glAttachObjectARB makes a copy)
glDeleteObjectARB(shader_object)
# print the gl error log
self.PrintGLError()
def link(self):
\"\"\"
Links the shaders together.
\"\"\"
# clear error indicator
glGetError()
glLinkProgramARB(self.m_program)
self.PrintInfoLog("link", self.m_program)
linked = glGetObjectParameterivARB(self.m_program, GL_OBJECT_LINK_STATUS_ARB)
if not linked:
print "Shader failed to link"
return
glValidateProgramARB(self.m_program)
valid = glGetObjectParameterivARB(self.m_program, GL_OBJECT_VALIDATE_STATUS_ARB)
if not valid:
print "Shader failed to validate"
return
def activate(self, rasty, cachingInfo, mat):
self.pass_no+=1
if (self.pass_no == 1):
glDisable(GL_COLOR_MATERIAL)
glUseProgramObjectARB(self.m_program)
return True
glEnable(GL_COLOR_MATERIAL)
glUseProgramObjectARB(0)
self.pass_no = 0
return False
obj = GameLogic.getCurrentController().owner
mesh = obj.meshes[0]
for mat in mesh.materials:
mat.setCustomMaterial(MyMaterial())
print mat.texture
@ivar texture: Texture name
@type texture: string (read-only)
@ivar gl_texture: OpenGL texture handle (eg for glBindTexture(GL_TEXTURE_2D, gl_texture)
@type gl_texture: integer (read-only)
@ivar material: Material name
@type material: string (read-only)
@ivar tface: Texture face properties
@type tface: CObject (read-only)
@ivar tile: Texture is tiling
@type tile: boolean
@ivar tilexrep: Number of tile repetitions in x direction.
@type tilexrep: integer
@ivar tileyrep: Number of tile repetitions in y direction.
@type tileyrep: integer
@ivar drawingmode: Drawing mode for the material.
- 2 (drawingmode & 4) Textured
- 4 (drawingmode & 16) Light
- 14 (drawingmode & 16384) 3d Polygon Text
@type drawingmode: bitfield
@ivar transparent: This material is transparent. All meshes with this
material will be rendered after non transparent meshes from back
to front.
@type transparent: boolean
@ivar zsort: Transparent polygons in meshes with this material will be sorted back to
front before rendering.
Non-Transparent polygons will be sorted front to back before rendering.
@type zsort: boolean
@ivar lightlayer: Light layers this material affects.
@type lightlayer: bitfield.
@ivar triangle: Mesh data with this material is triangles. It's probably not safe to change this.
@type triangle: boolean
@ivar diffuse: The diffuse colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0]
@type diffuse: list [r, g, b]
@ivar specular: The specular colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0]
@type specular: list [r, g, b]
@ivar shininess: The shininess (specular exponent) of the material. 0.0 <= shininess <= 128.0
@type shininess: float
@ivar specularity: The amount of specular of the material. 0.0 <= specularity <= 1.0
@type specularity: float
"""
def updateTexture(tface, rasty):
"""
Updates a realtime animation.
@param tface: Texture face (eg mat.tface)
@type tface: CObject
@param rasty: Rasterizer
@type rasty: CObject
"""
def setTexture(tface):
"""
Sets texture render state.
Example::
mat.setTexture(mat.tface)
@param tface: Texture face
@type tface: CObject
"""
def activate(rasty, cachingInfo):
"""
Sets material parameters for this object for rendering.
Material Parameters set:
1. Texture
2. Backface culling
3. Line drawing
4. Specular Colour
5. Shininess
6. Diffuse Colour
7. Polygon Offset.
@param rasty: Rasterizer instance.
@type rasty: CObject
@param cachingInfo: Material cache instance.
@type cachingInfo: CObject
"""
def setCustomMaterial(material):
"""
Sets the material state setup object.
Using this method, you can extend or completely replace the gameengine material
to do your own advanced multipass effects.
Use this method to register your material class. Instead of the normal material,
your class's activate method will be called just before rendering the mesh.
This should setup the texture, material, and any other state you would like.
It should return True to render the mesh, or False if you are finished. You should
clean up any state Blender does not set before returning False.
Activate Method Definition::
def activate(self, rasty, cachingInfo, material):
Example::
class PyMaterial:
def __init__(self):
self.pass_no = -1
def activate(self, rasty, cachingInfo, material):
# Activate the material here.
#
# The activate method will be called until it returns False.
# Every time the activate method returns True the mesh will
# be rendered.
#
# rasty is a CObject for passing to material.updateTexture()
# and material.activate()
# cachingInfo is a CObject for passing to material.activate()
# material is the KX_PolygonMaterial instance this material
# was added to
# default material properties:
self.pass_no += 1
if self.pass_no == 0:
material.activate(rasty, cachingInfo)
# Return True to do this pass
return True
# clean up and return False to finish.
self.pass_no = -1
return False
# Create a new Python Material and pass it to the renderer.
mat.setCustomMaterial(PyMaterial())
@param material: The material object.
@type material: instance
"""
class KX_RadarSensor(KX_NearSensor):
"""
Radar sensor is a near sensor with a conical sensor object.
@ivar coneOrigin: The origin of the cone with which to test. The origin
is in the middle of the cone.
(read-only)
@type coneOrigin: list of floats [x, y, z]
@ivar coneTarget: The center of the bottom face of the cone with which to test.
(read-only)
@type coneTarget: list of floats [x, y, z]
@ivar distance: The height of the cone with which to test.
@type distance: float
@ivar angle: The angle of the cone (in degrees) with which to test.
@type angle: float from 0 to 360
@ivar axis: The axis on which the radar cone is cast
@type axis: int from 0 to 5
KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z,
KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
"""
#{Deprecated
#--The following methods are deprecated, please use properties instead.
def getConeOrigin():
"""
Returns the origin of the cone with which to test. The origin
is in the middle of the cone.
@deprecated: Use the L{coneOrigin} property.
@rtype: list [x, y, z]
"""
def getConeTarget():
"""
Returns the center of the bottom face of the cone with which to test.
@deprecated: Use the L{coneTarget} property.
@rtype: list [x, y, z]
"""
#}
def getConeHeight():
"""
Returns the height of the cone with which to test.
@rtype: float
"""
class KX_RaySensor(SCA_ISensor):
"""
A ray sensor detects the first object in a given direction.
@ivar propName: The property the ray is looking for.
@type propName: string
@ivar range: The distance of the ray.
@type range: float
@ivar useMaterial: Whether or not to look for a material (false = property)
@type useMaterial: boolean
@ivar useXRay: Whether or not to use XRay.
@type useXRay: boolean
@ivar hitObject: The game object that was hit by the ray. (Read-only)
@type hitObject: KX_GameObject
@ivar hitPosition: The position (in worldcoordinates) where the object was hit by the ray. (Read-only)
@type hitPosition: list [x, y, z]
@ivar hitNormal: The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (Read-only)
@type hitNormal: list [x, y, z]
@ivar rayDirection: The direction from the ray (in worldcoordinates). (Read-only)
@type rayDirection: list [x, y, z]
@ivar axis: The axis the ray is pointing on.
@type axis: int from 0 to 5
KX_RAY_AXIS_POS_X, KX_RAY_AXIS_POS_Y, KX_RAY_AXIS_POS_Z,
KX_RAY_AXIS_NEG_X, KX_RAY_AXIS_NEG_Y, KX_RAY_AXIS_NEG_Z
"""
#{ Deprecated
def getHitObject():
"""
Returns the game object that was hit by this ray.
@deprecated: Use the L{hitObject} attribute instead.
@rtype: KX_GameObject
"""
def getHitPosition():
"""
Returns the position (in worldcoordinates) where the object was hit by this ray.
@deprecated: Use the L{hitPosition} attribute instead.
@rtype: list [x, y, z]
"""
def getHitNormal():
"""
Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
@deprecated: Use the L{hitNormal} attribute instead.
@rtype: list [nx, ny, nz]
"""
def getRayDirection():
"""
Returns the direction from the ray (in worldcoordinates)
@deprecated: Use the L{rayDirection} attribute instead.
@rtype: list [dx, dy, dz]
"""
#}
class KX_SCA_AddObjectActuator(SCA_IActuator):
"""
Edit Object Actuator (in Add Object Mode)
@ivar object: the object this actuator adds.
@type object: KX_GameObject or None
@ivar objectLastCreated: the last added object from this actuator (read-only).
@type objectLastCreated: KX_GameObject or None
@ivar time: the lifetime of added objects, in frames. Set to 0 to disable automatic deletion.
@type time: integer
@ivar linearVelocity: the initial linear velocity of added objects.
@type linearVelocity: list [vx, vy, vz]
@ivar angularVelocity: the initial angular velocity of added objects.
@type angularVelocity: list [vx, vy, vz]
@warning: An Add Object actuator will be ignored if at game start, the linked object doesn't exist
(or is empty) or the linked object is in an active layer.
This will genereate a warning in the console:
C{ERROR: GameObject I{OBName} has a AddObjectActuator I{ActuatorName} without object (in 'nonactive' layer)}
"""
#{Deprecated
def setObject(object):
"""
Sets the game object to add.
A copy of the object will be added to the scene when the actuator is activated.
If the object does not exist, this function is ignored.
object can either be a L{KX_GameObject} or the name of an object or None.
@deprecated: use the L{object} property
@type object: L{KX_GameObject}, string or None
"""
def getObject(name_only = 0):
"""
Returns the name of the game object to be added.
Returns None if no game object has been assigned to be added.
@deprecated: use the L{object} property
@type name_only: bool
@param name_only: optional argument, when 0 return a KX_GameObject
@rtype: string, KX_GameObject or None if no object is set
"""
def setTime(time):
"""
Sets the lifetime of added objects, in frames.
If time == 0, the object will last forever.
@deprecated: use the L{time} property
@type time: integer
@param time: The minimum value for time is 0.
"""
def getTime():
"""
Returns the lifetime of the added object, in frames.
@deprecated: use the L{time} property
@rtype: integer
"""
def setLinearVelocity(vx, vy, vz):
"""
Sets the initial linear velocity of added objects.
@deprecated: use the L{linearVelocity} property
@type vx: float
@param vx: the x component of the initial linear velocity.
@type vy: float
@param vy: the y component of the initial linear velocity.
@type vz: float
@param vz: the z component of the initial linear velocity.
"""
def getLinearVelocity():
"""
Returns the initial linear velocity of added objects.
@deprecated: use the L{linearVelocity} property
@rtype: list [vx, vy, vz]
"""
def setAngularVelocity(vx, vy, vz):
"""
Sets the initial angular velocity of added objects.
@deprecated: use the L{angularVelocity} property
@type vx: float
@param vx: the x component of the initial angular velocity.
@type vy: float
@param vy: the y component of the initial angular velocity.
@type vz: float
@param vz: the z component of the initial angular velocity.
"""
def getAngularVelocity():
"""
Returns the initial angular velocity of added objects.
@deprecated: use the L{angularVelocity} property
@rtype: list [vx, vy, vz]
"""
def getLastCreatedObject():
"""
Returns the last object created by this actuator.
@deprecated: use the L{objectLastCreated} property
@rtype: L{KX_GameObject}
@return: A L{KX_GameObject} or None if no object has been created.
"""
#}
def instantAddObject():
"""
Returns the last object created by this actuator. The object can then be accessed from L{objectLastCreated}.
@rtype: None
"""
class KX_SCA_DynamicActuator(SCA_IActuator):
"""
Dynamic Actuator.
@ivar mode: the type of operation of the actuator, 0-4
KX_DYN_RESTORE_DYNAMICS, KX_DYN_DISABLE_DYNAMICS,
KX_DYN_ENABLE_RIGID_BODY, KX_DYN_DISABLE_RIGID_BODY, KX_DYN_SET_MASS
@type mode: integer
@ivar mass: the mass value for the KX_DYN_SET_MASS operation
@type mass: float
"""
#{ Deprecated
def setOperation(operation):
"""
Set the type of operation when the actuator is activated:
- 0 = restore dynamics
- 1 = disable dynamics
- 2 = enable rigid body
- 3 = disable rigid body
- 4 = set mass
@deprecated: Use the L{mode} attribute instead.
"""
def getOperation():
"""
return the type of operation
@deprecated: Use the L{mode} attribute instead.
"""
#}
class KX_SCA_EndObjectActuator(SCA_IActuator):
"""
Edit Object Actuator (in End Object mode)
This actuator has no python methods.
"""
class KX_SCA_ReplaceMeshActuator(SCA_IActuator):
"""
Edit Object actuator, in Replace Mesh mode.
Example::
# Level-of-detail
# Switch a game object's mesh based on its depth in the camera view.
# +----------+ +-----------+ +-------------------------------------+
# | Always +-----+ Python +-----+ Edit Object (Replace Mesh) LOD.Mesh |
# +----------+ +-----------+ +-------------------------------------+
import GameLogic
# List detail meshes here
# Mesh (name, near, far)
# Meshes overlap so that they don't 'pop' when on the edge of the distance.
meshes = ((".Hi", 0.0, -20.0),
(".Med", -15.0, -50.0),
(".Lo", -40.0, -100.0)
)
co = GameLogic.getCurrentController()
obj = co.owner
act = co.actuators["LOD." + obj.name]
cam = GameLogic.getCurrentScene().active_camera
def Depth(pos, plane):
return pos[0]*plane[0] + pos[1]*plane[1] + pos[2]*plane[2] + plane[3]
# Depth is negative and decreasing further from the camera
depth = Depth(obj.position, cam.world_to_camera[2])
newmesh = None
curmesh = None
# Find the lowest detail mesh for depth
for mesh in meshes:
if depth < mesh[1] and depth > mesh[2]:
newmesh = mesh
if "ME" + obj.name + mesh[0] == act.getMesh():
curmesh = mesh
if newmesh != None and "ME" + obj.name + newmesh[0] != act.getMesh():
# The mesh is a different mesh - switch it.
# Check the current mesh is not a better fit.
if curmesh == None or curmesh[1] < depth or curmesh[2] > depth:
act.mesh = obj.getName() + newmesh[0]
GameLogic.addActiveActuator(act, True)
@warning: Replace mesh actuators will be ignored if at game start, the
named mesh doesn't exist.
This will generate a warning in the console:
C{ERROR: GameObject I{OBName} ReplaceMeshActuator I{ActuatorName} without object}
@ivar mesh: L{KX_MeshProxy} or the name of the mesh that will replace the current one
Set to None to disable actuator
@type mesh: L{KX_MeshProxy} or None if no mesh is set
"""
def setMesh(name):
"""
Sets the name of the mesh that will replace the current one.
When the name is None it will unset the mesh value so no action is taken.
@deprecated: Use the L{mesh} attribute instead.
@type name: string or None
"""
def getMesh():
"""
Returns the name of the mesh that will replace the current one.
Returns None if no mesh has been scheduled to be added.
@deprecated: Use the L{mesh} attribute instead.
@rtype: string or None
"""
def instantReplaceMesh():
"""
Immediately replace mesh without delay.
@rtype: None
"""
class KX_Scene(PyObjectPlus):
"""
An active scene that gives access to objects, cameras, lights and scene attributes.
The activity culling stuff is supposed to disable logic bricks when their owner gets too far
from the active camera. It was taken from some code lurking at the back of KX_Scene - who knows
what it does!
Example::
import GameLogic
# get the scene
scene = GameLogic.getCurrentScene()
# print all the objects in the scene
for obj in scene.objects:
print obj.name
# get an object named 'Cube'
obj = scene.objects["OBCube"]
# get the first object in the scene.
obj = scene.objects[0]
Example::
# Get the depth of an object in the camera view.
import GameLogic
obj = GameLogic.getCurrentController().owner
cam = GameLogic.getCurrentScene().active_camera
# Depth is negative and decreasing further from the camera
depth = obj.position[0]*cam.world_to_camera[2][0] + obj.position[1]*cam.world_to_camera[2][1] + obj.position[2]*cam.world_to_camera[2][2] + cam.world_to_camera[2][3]
@bug: All attributes are read only at the moment.
@ivar name: The scene's name, (read-only).
@type name: string
@ivar objects: A list of objects in the scene, (read-only).
@type objects: L{CListValue} of L{KX_GameObject}
@ivar objectsInactive: A list of objects on background layers (used for the addObject actuator), (read-only).
@type objectsInactive: L{CListValue} of L{KX_GameObject}
@ivar lights: A list of lights in the scene, (read-only).
@type lights: L{CListValue} of L{KX_LightObject}
@ivar cameras: A list of cameras in the scene, (read-only).
@type cameras: L{CListValue} of L{KX_Camera}
@ivar active_camera: The current active camera.
note: this can be set directly from python to avoid using the L{KX_SceneActuator}.
@type active_camera: L{KX_Camera}
@ivar suspended: True if the scene is suspended, (read-only).
@type suspended: boolean
@ivar activity_culling: True if the scene is activity culling
@type activity_culling: boolean
@ivar activity_culling_radius: The distance outside which to do activity culling. Measured in manhattan distance.
@type activity_culling_radius: float
@ivar dbvt_culling: True when Dynamic Bounding box Volume Tree is set (read-only).
@type dbvt_culling: bool
@group Deprecated: getLightList, getObjectList, getName
"""
def getLightList():
"""
Returns the list of lights in the scene.
@deprecated: Use the L{lights} attribute instead.
@rtype: list [L{KX_LightObject}]
"""
def getObjectList():
"""
Returns the list of objects in the scene.
@deprecated: Use the L{objects} attribute instead.
@rtype: list [L{KX_GameObject}]
"""
def getName():
"""
Returns the name of the scene.
@deprecated: Use the L{name} attribute instead.
@rtype: string
"""
def addObject(object, other, time=0):
"""
Adds an object to the scene like the Add Object Actuator would, and returns the created object.
@param object: The object to add
@type object: L{KX_GameObject} or string
@param other: The object's center to use when adding the object
@type other: L{KX_GameObject} or string
@param time: The lifetime of the added object, in frames. A time of 0 means the object will last forever.
@type time: int
@rtype: L{KX_GameObject}
"""
class KX_SceneActuator(SCA_IActuator):
"""
Scene Actuator logic brick.
@warning: Scene actuators that use a scene name will be ignored if at game start, the
named scene doesn't exist or is empty
This will generate a warning in the console:
C{ERROR: GameObject I{OBName} has a SceneActuator I{ActuatorName} (SetScene) without scene}
@ivar scene: the name of the scene to change to/overlay/underlay/remove/suspend/resume
@type scene: string.
@ivar camera: the camera to change to.
When setting the attribute, you can use either a L{KX_Camera} or the name of the camera.
@type camera: L{KX_Camera} on read, string or L{KX_Camera} on write
@ivar useRestart: Set flag to True to restart the sene
@type useRestart: bool
@ivar mode: The mode of the actuator
@type mode: int from 0 to 5 L{GameLogic.Scene Actuator}
"""
#{ Deprecated
def setUseRestart(flag):
"""
Set flag to True to restart the scene.
@deprecated: Use the L{useRestart} attribute instead.
@type flag: boolean
"""
def setScene(scene):
"""
Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
@deprecated: use the L{scene} attribute instead.
@type scene: string
"""
def setCamera(camera):
"""
Sets the camera to change to.
Camera can be either a L{KX_Camera} or the name of the camera.
@deprecated: use the L{camera} attribute instead.
@type camera: L{KX_Camera} or string
"""
def getUseRestart():
"""
Returns True if the scene will be restarted.
@deprecated: use the L{useRestart} attribute instead.
@rtype: boolean
"""
def getScene():
"""
Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
Returns an empty string ("") if no scene has been set.
@deprecated: use the L{scene} attribute instead.
@rtype: string
"""
def getCamera():
"""
Returns the name of the camera to change to.
@deprecated: use the L{camera} attribute instead.
@rtype: string
"""
#}
class KX_SoundActuator(SCA_IActuator):
"""
Sound Actuator.
The L{startSound()}, L{pauseSound()} and L{stopSound()} do not require
the actuator to be activated - they act instantly provided that the actuator has
been activated once at least.
@ivar fileName: The filename of the sound this actuator plays.
@type fileName: string
@ivar volume: The volume (gain) of the sound.
@type volume: float
@ivar pitch: The pitch of the sound.
@type pitch: float
@ivar rollOffFactor: The roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
@type rollOffFactor: float
@ivar looping: The loop mode of the actuator.
@type looping: integer
@ivar position: The position of the sound as a list: [x, y, z].
@type position: float array
@ivar velocity: The velocity of the emitter as a list: [x, y, z]. The relative velocity to the observer determines the pitch. List of 3 floats: [x, y, z].
@type velocity: float array
@ivar orientation: The orientation of the sound. When setting the orientation you can also use quaternion [float,float,float,float] or euler angles [float,float,float]
@type orientation: 3x3 matrix [[float]]
@ivar mode: The operation mode of the actuator. You can use one of the following constants:
- KX_SOUNDACT_PLAYSTOP (1)
- KX_SOUNDACT_PLAYEND (2)
- KX_SOUNDACT_LOOPSTOP (3)
- KX_SOUNDACT_LOOPEND (4)
- KX_SOUNDACT_LOOPBIDIRECTIONAL (5)
- KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP (6)
@type mode: integer
"""
#{ Play Methods
def startSound():
"""
Starts the sound.
"""
def pauseSound():
"""
Pauses the sound.
"""
def stopSound():
"""
Stops the sound.
"""
#}
#{ Deprecated
def setFilename(filename):
"""
Sets the filename of the sound this actuator plays.
@deprecated: Use the L{fileName} attribute instead.
@type filename: string
"""
def getFilename():
"""
Returns the filename of the sound this actuator plays.
@deprecated: Use the L{fileName} attribute instead.
@rtype: string
"""
def setGain(gain):
"""
Sets the gain (volume) of the sound
@deprecated: Use the L{volume} attribute instead.
@type gain: float
@param gain: 0.0 (quiet) <= gain <= 1.0 (loud)
"""
def getGain():
"""
Gets the gain (volume) of the sound.
@deprecated: Use the L{volume} attribute instead.
@rtype: float
"""
def setPitch(pitch):
"""
Sets the pitch of the sound.
@deprecated: Use the L{pitch} attribute instead.
@type pitch: float
"""
def getPitch():
"""
Returns the pitch of the sound.
@deprecated: Use the L{pitch} attribute instead.
@rtype: float
"""
def setRollOffFactor(rolloff):
"""
Sets the rolloff factor for the sounds.
Rolloff defines the rate of attenuation as the sound gets further away.
Higher rolloff factors shorten the distance at which the sound can be heard.
@deprecated: Use the L{rollOffFactor} attribute instead.
@type rolloff: float
"""
def getRollOffFactor():
"""
Returns the rolloff factor for the sound.
@deprecated: Use the L{rollOffFactor} attribute instead.
@rtype: float
"""
def setLooping(loop):
"""
Sets the loop mode of the actuator.
@bug: There are no constants defined for this method!
@param loop: - Play Stop 1
- Play End 2
- Loop Stop 3
- Loop End 4
- Bidirection Stop 5
- Bidirection End 6
@deprecated: Use the L{looping} attribute instead.
@type loop: integer
"""
def getLooping():
"""
Returns the current loop mode of the actuator.
@deprecated: Use the L{looping} attribute instead.
@rtype: integer
"""
def setPosition(x, y, z):
"""
Sets the position this sound will come from.
@deprecated: Use the L{position} attribute instead.
@type x: float
@param x: The x coordinate of the sound.
@type y: float
@param y: The y coordinate of the sound.
@type z: float
@param z: The z coordinate of the sound.
"""
def setVelocity(vx, vy, vz):
"""
Sets the velocity this sound is moving at.
The sound's pitch is determined from the velocity.
@deprecated: Use the L{velocity} attribute instead.
@type vx: float
@param vx: The vx coordinate of the sound.
@type vy: float
@param vy: The vy coordinate of the sound.
@type vz: float
@param vz: The vz coordinate of the sound.
"""
def setOrientation(o11, o12, o13, o21, o22, o23, o31, o32, o33):
"""
Sets the orientation of the sound.
The nine parameters specify a rotation matrix::
| o11, o12, o13 |
| o21, o22, o23 |
| o31, o32, o33 |
@deprecated: Use the L{orientation} attribute instead.
"""
def setType(mode):
"""
Sets the operation mode of the actuator.
@deprecated: Use the L{type} attribute instead.
@param mode: KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP
@type mode: integer
"""
def getType():
"""
Returns the operation mode of the actuator.
@deprecated: Use the L{type} attribute instead.
@rtype: integer
@return: KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP
"""
#}
class KX_StateActuator(SCA_IActuator):
"""
State actuator changes the state mask of parent object.
Property:
@ivar operation: type of bit operation to be applied on object state mask.
You can use one of the following constant:
- KX_STATE_OP_CPY (0) : Copy state mask
- KX_STATE_OP_SET (1) : Add bits to state mask
- KX_STATE_OP_CLR (2) : Substract bits to state mask
- KX_STATE_OP_NEG (3) : Invert bits to state mask
@type operation: integer
@ivar mask: value that defines the bits that will be modified by the operation.
The bits that are 1 in the mask will be updated in the object state,
the bits that are 0 are will be left unmodified expect for the Copy operation
which copies the mask to the object state
@type mask: integer
"""
def setOperation(op):
"""
Set the type of bit operation to be applied on object state mask.
Use setMask() to specify the bits that will be modified.
@deprecated: Use the L{operation} attribute instead.
@param op: bit operation (0=Copy, 1=Add, 2=Substract, 3=Invert)
@type op: integer
"""
def setMask(mask):
"""
Set the value that defines the bits that will be modified by the operation.
The bits that are 1 in the value will be updated in the object state,
the bits that are 0 are will be left unmodified expect for the Copy operation
which copies the value to the object state.
@deprecated: Use the L{mask} attribute instead.
@param mask: bits that will be modified
@type mask: integer
"""
class KX_TrackToActuator(SCA_IActuator):
"""
Edit Object actuator in Track To mode.
@warning: Track To Actuators will be ignored if at game start, the
object to track to is invalid.
This will generate a warning in the console:
C{ERROR: GameObject I{OBName} no object in EditObjectActuator I{ActuatorName}}
@ivar object: the object this actuator tracks.
@type object: KX_GameObject or None
@ivar time: the time in frames with which to delay the tracking motion
@type time: integer
@ivar use3D: the tracking motion to use 3D
@type use3D: boolean
"""
#{ Deprecated
def setObject(object):
"""
Sets the object to track.
@deprecated: Use the L{object} attribute instead.
@type object: L{KX_GameObject}, string or None
@param object: Either a reference to a game object or the name of the object to track.
"""
def getObject(name_only):
"""
Returns the name of the object to track.
@deprecated: Use the L{object} attribute instead.
@type name_only: bool
@param name_only: optional argument, when 0 return a KX_GameObject
@rtype: string, KX_GameObject or None if no object is set
"""
def setTime(time):
"""
Sets the time in frames with which to delay the tracking motion.
@deprecated: Use the L{time} attribute instead.
@type time: integer
"""
def getTime():
"""
Returns the time in frames with which the tracking motion is delayed.
@deprecated: Use the L{time} attribute instead.
@rtype: integer
"""
def setUse3D(use3d):
"""
DEPRECATED: Use the property.
Sets the tracking motion to use 3D.
@deprecated: Use the L{use3D} attribute instead.
@type use3d: boolean
@param use3d: - True: allow the tracking motion to extend in the z-direction.
- False: lock the tracking motion to the x-y plane.
"""
def getUse3D():
"""
Returns True if the tracking motion will track in the z direction.
@deprecated: Use the L{use3D} attribute instead.
@rtype: boolean
"""
#}
class KX_VehicleWrapper(PyObjectPlus):
"""
KX_VehicleWrapper
TODO - description
"""
def addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering):
"""
Add a wheel to the vehicle
@param wheel: The object to use as a wheel.
@type wheel: L{KX_GameObject} or a KX_GameObject name
@param attachPos: The position that this wheel will attach to.
@type attachPos: vector of 3 floats
@param attachDir: The direction this wheel points.
@type attachDir: vector of 3 floats
@param axleDir: The direction of this wheels axle.
@type axleDir: vector of 3 floats
@param suspensionRestLength: TODO - Description
@type suspensionRestLength: float
@param wheelRadius: The size of the wheel.
@type wheelRadius: float
"""
def applyBraking(force, wheelIndex):
"""
Apply a braking force to the specified wheel
@param force: the brake force
@type force: float
@param wheelIndex: index of the wheel where the force needs to be applied
@type wheelIndex: integer
"""
def applyEngineForce(force, wheelIndex):
"""
Apply an engine force to the specified wheel
@param force: the engine force
@type force: float
@param wheelIndex: index of the wheel where the force needs to be applied
@type wheelIndex: integer
"""
def getConstraintId():
"""
Get the constraint ID
@rtype: integer
@return: the constraint id
"""
def getConstraintType():
"""
Returns the constraint type.
@rtype: integer
@return: constraint type
"""
def getNumWheels():
"""
Returns the number of wheels.
@rtype: integer
@return: the number of wheels for this vehicle
"""
def getWheelOrientationQuaternion(wheelIndex):
"""
Returns the wheel orientation as a quaternion.
@param wheelIndex: the wheel index
@type wheelIndex: integer
@rtype: TODO - type should be quat as per method name but from the code it looks like a matrix
@return: TODO Description
"""
def getWheelPosition(wheelIndex):
"""
Returns the position of the specified wheel
@param wheelIndex: the wheel index
@type wheelIndex: integer
@rtype: list[x, y, z]
@return: position vector
"""
def getWheelRotation(wheelIndex):
"""
Returns the rotation of the specified wheel
@param wheelIndex: the wheel index
@type wheelIndex: integer
@rtype: float
@return: the wheel rotation
"""
def setRollInfluence(rollInfluece, wheelIndex):
"""
Set the specified wheel's roll influence.
The higher the roll influence the more the vehicle will tend to roll over in corners.
@param rollInfluece: the wheel roll influence
@type rollInfluece: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
def setSteeringValue(steering, wheelIndex):
"""
Set the specified wheel's steering
@param steering: the wheel steering
@type steering: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
def setSuspensionCompression(compression, wheelIndex):
"""
Set the specified wheel's compression
@param compression: the wheel compression
@type compression: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
def setSuspensionDamping(damping, wheelIndex):
"""
Set the specified wheel's damping
@param damping: the wheel damping
@type damping: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
def setSuspensionStiffness(stiffness, wheelIndex):
"""
Set the specified wheel's stiffness
@param stiffness: the wheel stiffness
@type stiffness: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
def setTyreFriction(friction, wheelIndex):
"""
Set the specified wheel's tyre friction
@param friction: the tyre friction
@type friction: float
@param wheelIndex: the wheel index
@type wheelIndex: integer
"""
class KX_VertexProxy(SCA_IObject):
"""
A vertex holds position, UV, colour and normal information.
Note:
The physics simulation is NOT currently updated - physics will not respond
to changes in the vertex position.
@ivar XYZ: The position of the vertex.
@type XYZ: list [x, y, z]
@ivar UV: The texture coordinates of the vertex.
@type UV: list [u, v]
@ivar normal: The normal of the vertex
@type normal: list [nx, ny, nz]
@ivar colour: The colour of the vertex.
Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
@type colour: list [r, g, b, a]
@ivar color: Synonym for colour.
@group Position: x, y, z
@ivar x: The x coordinate of the vertex.
@type x: float
@ivar y: The y coordinate of the vertex.
@type y: float
@ivar z: The z coordinate of the vertex.
@type z: float
@group Texture Coordinates: u, v
@ivar u: The u texture coordinate of the vertex.
@type u: float
@ivar v: The v texture coordinate of the vertex.
@type v: float
@ivar u2: The second u texture coordinate of the vertex.
@type u2: float
@ivar v2: The second v texture coordinate of the vertex.
@type v2: float
@group Colour: r, g, b, a
@ivar r: The red component of the vertex colour. 0.0 <= r <= 1.0
@type r: float
@ivar g: The green component of the vertex colour. 0.0 <= g <= 1.0
@type g: float
@ivar b: The blue component of the vertex colour. 0.0 <= b <= 1.0
@type b: float
@ivar a: The alpha component of the vertex colour. 0.0 <= a <= 1.0
@type a: float
"""
def getXYZ():
"""
Gets the position of this vertex.
@rtype: list [x, y, z]
@return: this vertexes position in local coordinates.
"""
def setXYZ(pos):
"""
Sets the position of this vertex.
@type pos: list [x, y, z]
@param pos: the new position for this vertex in local coordinates.
"""
def getUV():
"""
Gets the UV (texture) coordinates of this vertex.
@rtype: list [u, v]
@return: this vertexes UV (texture) coordinates.
"""
def setUV(uv):
"""
Sets the UV (texture) coordinates of this vertex.
@type uv: list [u, v]
"""
def getUV2():
"""
Gets the 2nd UV (texture) coordinates of this vertex.
@rtype: list [u, v]
@return: this vertexes UV (texture) coordinates.
"""
def setUV2(uv, unit):
"""
Sets the 2nd UV (texture) coordinates of this vertex.
@type uv: list [u, v]
@param unit: optional argument, FLAT==1, SECOND_UV==2, defaults to SECOND_UV
@param unit: int
"""
def getRGBA():
"""
Gets the colour of this vertex.
The colour is represented as four bytes packed into an integer value. The colour is
packed as RGBA.
Since Python offers no way to get each byte without shifting, you must use the struct module to
access colour in an machine independent way.
Because of this, it is suggested you use the r, g, b and a attributes or the colour attribute instead.
Example::
import struct;
col = struct.unpack('4B', struct.pack('I', v.getRGBA()))
# col = (r, g, b, a)
# black = ( 0, 0, 0, 255)
# white = (255, 255, 255, 255)
@rtype: integer
@return: packed colour. 4 byte integer with one byte per colour channel in RGBA format.
"""
def setRGBA(col):
"""
Sets the colour of this vertex.
See getRGBA() for the format of col, and its relevant problems. Use the r, g, b and a attributes
or the colour attribute instead.
setRGBA() also accepts a four component list as argument col. The list represents the colour as [r, g, b, a]
with black = [0.0, 0.0, 0.0, 1.0] and white = [1.0, 1.0, 1.0, 1.0]
Example::
v.setRGBA(0xff0000ff) # Red
v.setRGBA(0xff00ff00) # Green on little endian, transparent purple on big endian
v.setRGBA([1.0, 0.0, 0.0, 1.0]) # Red
v.setRGBA([0.0, 1.0, 0.0, 1.0]) # Green on all platforms.
@type col: integer or list [r, g, b, a]
@param col: the new colour of this vertex in packed RGBA format.
"""
def getNormal():
"""
Gets the normal vector of this vertex.
@rtype: list [nx, ny, nz]
@return: normalised normal vector.
"""
def setNormal(normal):
"""
Sets the normal vector of this vertex.
@type normal: sequence of floats [r, g, b]
@param normal: the new normal of this vertex.
"""
class KX_VisibilityActuator(SCA_IActuator):
"""
Visibility Actuator.
@ivar visibility: whether the actuator makes its parent object visible or invisible
@type visibility: boolean
@ivar useOcclusion: whether the actuator makes its parent object an occluder or not
@type useOcclusion: boolean
@ivar useRecursion: whether the visibility/occlusion should be propagated to all children of the object
@type useRecursion: boolean
"""
#{ Deprecated
def set(visible):
"""
Sets whether the actuator makes its parent object visible or invisible.
@deprecated: Use the L{visibility} attribute instead.
@param visible: - True: Makes its parent visible.
- False: Makes its parent invisible.
"""
#}
class SCA_2DFilterActuator(SCA_IActuator):
"""
Create, enable and disable 2D filters
Properties:
The following properties don't have an immediate effect.
You must active the actuator to get the result.
The actuator is not persistent: it automatically stops itself after setting up the filter
but the filter remains active. To stop a filter you must activate the actuator with 'type'
set to RAS_2DFILTER_DISABLED or RAS_2DFILTER_NOFILTER.
@ivar shaderText: shader source code for custom shader
@type shaderText: string
@ivar disableMotionBlur: action on motion blur: 0=enable, 1=disable
@type disableMotionBlur: integer
@ivar mode: type of 2D filter, use one of the following constants:
RAS_2DFILTER_ENABLED (-2) : enable the filter that was previously disabled
RAS_2DFILTER_DISABLED (-1) : disable the filter that is currently active
RAS_2DFILTER_NOFILTER (0) : disable and destroy the filter that is currently active
RAS_2DFILTER_MOTIONBLUR (1) : create and enable preset filters
RAS_2DFILTER_BLUR (2)
RAS_2DFILTER_SHARPEN (3)
RAS_2DFILTER_DILATION (4)
RAS_2DFILTER_EROSION (5)
RAS_2DFILTER_LAPLACIAN (6)
RAS_2DFILTER_SOBEL (7)
RAS_2DFILTER_PREWITT (8)
RAS_2DFILTER_GRAYSCALE (9)
RAS_2DFILTER_SEPIA (10)
RAS_2DFILTER_INVERT (11)
RAS_2DFILTER_CUSTOMFILTER (12) : customer filter, the code code is set via shaderText property
@type mode: integer
@ivar passNumber: order number of filter in the stack of 2D filters. Filters are executed in increasing order of passNb.
Only be one filter can be defined per passNb.
@type passNumber: integer (0-100)
@ivar value: argument for motion blur filter
@type value: float (0.0-100.0)
"""
class SCA_ANDController(SCA_IController):
"""
An AND controller activates only when all linked sensors are activated.
There are no special python methods for this controller.
"""
class SCA_ActuatorSensor(SCA_ISensor):
"""
Actuator sensor detect change in actuator state of the parent object.
It generates a positive pulse if the corresponding actuator is activated
and a negative pulse if the actuator is deactivated.
Properties:
@ivar actuator: the name of the actuator that the sensor is monitoring.
@type actuator: string
"""
#{Deprecated
def getActuator():
"""
Return the Actuator with which the sensor operates.
@deprecated: Use the L{actuator} attribute instead.
@rtype: string
"""
def setActuator(name):
"""
Sets the Actuator with which to operate. If there is no Actuator
of this name, the function has no effect.
@deprecated: Use the L{actuator} attribute instead.
@param name: actuator name
@type name: string
"""
#}
class SCA_AlwaysSensor(SCA_ISensor):
"""
This sensor is always activated.
"""
class SCA_DelaySensor(SCA_ISensor):
"""
The Delay sensor generates positive and negative triggers at precise time,
expressed in number of frames. The delay parameter defines the length
of the initial OFF period. A positive trigger is generated at the end of this period.
The duration parameter defines the length of the ON period following the OFF period.
There is a negative trigger at the end of the ON period. If duration is 0, the sensor
stays ON and there is no negative trigger.
The sensor runs the OFF-ON cycle once unless the repeat option is set: the
OFF-ON cycle repeats indefinately (or the OFF cycle if duration is 0).
Use SCA_ISensor::reset() at any time to restart sensor.
Properties:
@ivar delay: length of the initial OFF period as number of frame, 0 for immediate trigger.
@type delay: integer.
@ivar duration: length of the ON period in number of frame after the initial OFF period.
If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.
@type duration: integer
@ivar repeat: 1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
@type repeat: integer
"""
#{Deprecated
def setDelay(delay):
"""
Set the initial delay before the positive trigger.
@deprecated: Use the L{delay} attribute instead.
@param delay: length of the initial OFF period as number of frame, 0 for immediate trigger
@type delay: integer
"""
def setDuration(duration):
"""
Set the duration of the ON pulse after initial delay and the generation of the positive trigger.
If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.
@deprecated: Use the L{duration} attribute instead.
@param duration: length of the ON period in number of frame after the initial OFF period
@type duration: integer
"""
def setRepeat(repeat):
"""
Set if the sensor repeat mode.
@deprecated: Use the L{repeat} attribute instead.
@param repeat: 1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
@type repeat: integer
"""
def getDelay():
"""
Return the delay parameter value.
@deprecated: Use the L{delay} attribute instead.
@rtype: integer
"""
def getDuration():
"""
Return the duration parameter value
@deprecated: Use the L{duration} attribute instead.
@rtype: integer
"""
def getRepeat():
"""
Return the repeat parameter value
@deprecated: Use the L{repeat} attribute instead.
@rtype: KX_TRUE or KX_FALSE
"""
#}
class SCA_JoystickSensor(SCA_ISensor):
"""
This sensor detects player joystick events.
Properties:
@ivar axisValues: (read-only) The state of the joysticks axis as a list of values L{numAxis} long.
each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
left:[-32767, 0, ...], right:[32767, 0, ...], up:[0, -32767, ...], down:[0, 32767, ...]
@type axisValues: list of ints
@ivar axisSingle: (read-only) like L{axisValues} but returns a single axis value that is set by the sensor.
Only use this for "Single Axis" type sensors otherwise it will raise an error.
@type axisSingle: int
@ivar hatValues: (read-only) The state of the joysticks hats as a list of values L{numHats} long.
each spesifying the direction of the hat from 1 to 12, 0 when inactive.
Hat directions are as follows...
- 0:None
- 1:Up
- 2:Right
- 4:Down
- 8:Left
- 3:Up - Right
- 6:Down - Right
- 12:Down - Left
- 9:Up - Left
@type hatValues: list of ints
@ivar hatSingle: (read-only) like L{hatValues} but returns a single hat direction value that is set by the sensor.
@type hatSingle: int
@ivar numAxis: (read-only) The number of axes for the joystick at this index.
@type numAxis: integer
@ivar numButtons: (read-only) The number of buttons for the joystick at this index.
@type numButtons: integer
@ivar numHats: (read-only) The number of hats for the joystick at this index.
@type numHats: integer
@ivar connected: (read-only) True if a joystick is connected at this joysticks index.
@type connected: boolean
@ivar index: The joystick index to use (from 0 to 7). The first joystick is always 0.
@type index: integer
@ivar threshold: Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
@type threshold: integer
@ivar button: The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
@type button: integer
@ivar axis: The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]
axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control.
axisDirection: 0=right, 1=up, 2=left, 3=down
@type axis: [integer, integer]
@ivar hat: The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]
hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat (4 max).
hatDirection: 1-12
@type hat: [integer, integer]
"""
def getButtonActiveList():
"""
Returns a list containing the indicies of the currently pressed buttons.
@rtype: list
"""
def getButtonStatus(buttonIndex):
"""
Returns a bool of the current pressed state of the specified button.
@param buttonIndex: the button index, 0=first button
@type buttonIndex: integer
@rtype: bool
"""
#{Deprecated
def getIndex():
"""
Returns the joystick index to use (from 1 to 8).
@deprecated: Use the L{index} attribute instead.
@rtype: integer
"""
def setIndex(index):
"""
Sets the joystick index to use.
@deprecated: Use the L{index} attribute instead.
@param index: The index of this joystick sensor, Clamped between 1 and 8.
@type index: integer
@note: This is only useful when you have more then 1 joystick connected to your computer - multiplayer games.
"""
def getAxis():
"""
Returns the current axis this sensor reacts to. See L{getAxisValue()<SCA_JoystickSensor.getAxisValue>} for the current axis state.
@deprecated: Use the L{axis} attribute instead.
@rtype: list
@return: 2 values returned are [axisIndex, axisDirection] - see L{setAxis()<SCA_JoystickSensor.setAxis>} for their purpose.
@note: When the "All Events" toggle is set, this option has no effect.
"""
def setAxis(axisIndex, axisDirection):
"""
@deprecated: Use the L{axis} attribute instead.
@param axisIndex: Set the axis index to use when detecting axis movement.
@type axisIndex: integer from 1 to 2
@param axisDirection: Set the axis direction used for detecting motion. 0:right, 1:up, 2:left, 3:down.
@type axisDirection: integer from 0 to 3
@note: When the "All Events" toggle is set, this option has no effect.
"""
def getAxisValue():
"""
Returns the state of the joysticks axis. See differs to L{getAxis()<SCA_JoystickSensor.getAxis>} returning the current state of the joystick.
@deprecated: Use the L{axisValues} attribute instead.
@rtype: list
@return: 4 values, each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
left:[-32767, 0, ...], right:[32767, 0, ...], up:[0, -32767, ...], down:[0, 32767, ...]
@note: Some gamepads only set the axis on and off like a button.
"""
def getThreshold():
"""
Get the axis threshold. See L{setThreshold()<SCA_JoystickSensor.setThreshold>} for details.
@deprecated: Use the L{threshold} attribute instead.
@rtype: integer
"""
def setThreshold(threshold):
"""
Set the axis threshold.
@deprecated: Use the L{threshold} attribute instead.
@param threshold: Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
@type threshold: integer
"""
def getButton():
"""
Returns the button index the sensor reacts to. See L{getButtonValue()<SCA_JoystickSensor.getButtonValue>} for a list of pressed buttons.
@deprecated: Use the L{button} attribute instead.
@rtype: integer
@note: When the "All Events" toggle is set, this option has no effect.
"""
def setButton(index):
"""
Sets the button index the sensor reacts to when the "All Events" option is not set.
@deprecated: Use the L{button} attribute instead.
@note: When the "All Events" toggle is set, this option has no effect.
"""
def getButtonValue():
"""
Returns a list containing the indicies of the currently pressed buttons.
@deprecated: Use the L{getButtonActiveList} method instead.
@rtype: list
"""
def getHat():
"""
Returns the current hat direction this sensor is set to.
[hatNumber, hatDirection].
@deprecated: Use the L{hat} attribute instead.
@rtype: list
@note: When the "All Events" toggle is set, this option has no effect.
"""
def setHat(index,direction):
"""
Sets the hat index the sensor reacts to when the "All Events" option is not set.
@deprecated: Use the L{hat} attribute instead.
@type index: integer
"""
def getNumAxes():
"""
Returns the number of axes for the joystick at this index.
@deprecated: Use the L{numAxis} attribute instead.
@rtype: integer
"""
def getNumButtons():
"""
Returns the number of buttons for the joystick at this index.
@deprecated: Use the L{numButtons} attribute instead.
@rtype: integer
"""
def getNumHats():
"""
Returns the number of hats for the joystick at this index.
@deprecated: Use the L{numHats} attribute instead.
@rtype: integer
"""
def isConnected():
"""
Returns True if a joystick is detected at this joysticks index.
@deprecated: Use the L{connected} attribute instead.
@rtype: bool
"""
#}
class SCA_KeyboardSensor(SCA_ISensor):
"""
A keyboard sensor detects player key presses.
See module L{GameKeys} for keycode values.
@ivar key: The key code this sensor is looking for.
@type key: keycode from L{GameKeys} module
@ivar hold1: The key code for the first modifier this sensor is looking for.
@type hold1: keycode from L{GameKeys} module
@ivar hold2: The key code for the second modifier this sensor is looking for.
@type hold2: keycode from L{GameKeys} module
@ivar toggleProperty: The name of the property that indicates whether or not to log keystrokes as a string.
@type toggleProperty: string
@ivar targetProperty: The name of the property that receives keystrokes in case in case a string is logged.
@type targetProperty: string
@ivar useAllKeys: Flag to determine whether or not to accept all keys.
@type useAllKeys: boolean
@ivar events: a list of pressed keys that have either been pressed, or just released, or are active this frame. (read-only).
- 'keycode' matches the values in L{GameKeys}.
- 'status' uses...
- L{GameLogic.KX_INPUT_NONE}
- L{GameLogic.KX_INPUT_JUST_ACTIVATED}
- L{GameLogic.KX_INPUT_ACTIVE}
- L{GameLogic.KX_INPUT_JUST_RELEASED}
@type events: list [[keycode, status], ...]
"""
def getKeyStatus(keycode):
"""
Get the status of a key.
@rtype: key state L{GameLogic} members (KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED)
@return: The state of the given key
@type keycode: integer
@param keycode: The code that represents the key you want to get the state of
"""
#{Deprecated
def getKey():
"""
Returns the key code this sensor is looking for.
@deprecated: Use the L{key} attribute instead.
@rtype: keycode from L{GameKeys} module
"""
def setKey(keycode):
"""
Set the key this sensor should listen for.
@deprecated: Use the L{key} attribute instead.
@type keycode: keycode from L{GameKeys} module
"""
def getHold1():
"""
Returns the key code for the first modifier this sensor is looking for.
@deprecated: Use the L{hold1} attribute instead.
@rtype: keycode from L{GameKeys} module
"""
def setHold1(keycode):
"""
Sets the key code for the first modifier this sensor should look for.
@deprecated: Use the L{hold1} attribute instead.
@type keycode: keycode from L{GameKeys} module
"""
def getHold2():
"""
Returns the key code for the second modifier this sensor is looking for.
@deprecated: Use the L{hold2} attribute instead.
@rtype: keycode from L{GameKeys} module
"""
def setHold2(keycode):
"""
Sets the key code for the second modifier this sensor should look for.
@deprecated: Use the L{hold2} attribute instead.
@type keycode: keycode from L{GameKeys} module
"""
def getPressedKeys():
"""
Get a list of keys that have either been pressed, or just released this frame.
@deprecated: Use the L{events} attribute instead.
@rtype: list of key status. [[keycode, status]]
"""
def getCurrentlyPressedKeys():
"""
Get a list of currently pressed keys that have either been pressed, or just released
@deprecated: Use the L{events} attribute instead.
@rtype: list of key status. [[keycode, status]]
"""
#}
class SCA_NANDController(SCA_IController):
"""
An NAND controller activates when all linked sensors are not active.
There are no special python methods for this controller.
"""
class SCA_NORController(SCA_IController):
"""
An NOR controller activates only when all linked sensors are de-activated.
There are no special python methods for this controller.
"""
class SCA_ORController(SCA_IController):
"""
An OR controller activates when any connected sensor activates.
There are no special python methods for this controller.
"""
class SCA_PropertyActuator(SCA_IActuator):
"""
Property Actuator
Properties:
@ivar propName: the property on which to operate.
@type propName: string
@ivar value: the value with which the actuator operates.
@type value: string
@ivar mode: TODO - add constants to game logic dict!.
@type mode: int
"""
#{ Deprecated
def setProperty(prop):
"""
Set the property on which to operate.
If there is no property of this name, the call is ignored.
@deprecated: Use the L{propName} attribute instead.
@type prop: string
@param prop: The name of the property to set.
"""
def getProperty():
"""
Returns the name of the property on which to operate.
@deprecated: Use the L{propName} attribute instead.
@rtype: string
"""
def setValue(value):
"""
Set the value with which the actuator operates.
If the value is not compatible with the type of the
property, the subsequent action is ignored.
@deprecated: Use the L{value} attribute instead.
@type value: string
"""
def getValue():
"""
Gets the value with which this actuator operates.
@deprecated: Use the L{value} attribute instead.
@rtype: string
"""
#}
class SCA_PropertySensor(SCA_ISensor):
"""
Activates when the game object property matches.
Properties:
@ivar mode: type of check on the property:
KX_PROPSENSOR_EQUAL(1), KX_PROPSENSOR_NOTEQUAL(2), KX_PROPSENSOR_INTERVAL(3),
KX_PROPSENSOR_CHANGED(4), KX_PROPSENSOR_EXPRESSION(5)
@type mode: integer
@ivar propName: the property the sensor operates.
@type propName: string
@ivar value: the value with which the sensor compares to the value of the property.
@type value: string
"""
#{ Deprecated
def getType():
"""
Gets when to activate this sensor.
@deprecated: Use the L{mode} attribute instead.
@return: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL,
KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED,
or KX_PROPSENSOR_EXPRESSION.
"""
def setType(checktype):
"""
Set the type of check to perform.
@deprecated: Use the L{mode} attribute instead.
@type checktype: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL,
KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED,
or KX_PROPSENSOR_EXPRESSION.
"""
def getProperty():
"""
Return the property with which the sensor operates.
@deprecated: Use the L{propName} attribute instead.
@rtype: string
@return: the name of the property this sensor is watching.
"""
def setProperty(name):
"""
Sets the property with which to operate. If there is no property
of that name, this call is ignored.
@deprecated: Use the L{propName} attribute instead.
@type name: string.
"""
def getValue():
"""
Return the value with which the sensor compares to the value of the property.
@deprecated: Use the L{value} attribute instead.
@rtype: string
@return: the value of the property this sensor is watching.
"""
def setValue(value):
"""
Set the value with which the sensor operates. If the value
is not compatible with the type of the property, the subsequent
action is ignored.
@deprecated: Use the L{value} attribute instead.
@type value: string
"""
#}
class SCA_PythonController(SCA_IController):
"""
A Python controller uses a Python script to activate it's actuators,
based on it's sensors.
Properties:
@ivar script: The value of this variable depends on the execution methid.
- When 'Script' execution mode is set this value contains the entire python script as a single string (not the script name as you might expect) which can be modified to run different scripts.
- When 'Module' execution mode is set this value will contain a single line string - module name and function "module.func" or "package.modile.func" where the module names are python textblocks or external scripts.
note: once this is set the script name given for warnings will remain unchanged.
@type script: string
@ivar mode: the execution mode for this controller (read-only).
- Script: 0, Execite the L{script} as a python code.
- Module: 1, Execite the L{script} as a module and function.
@type mode: int
@group Deprecated: getScript, setScript
"""
def activate(actuator):
"""
Activates an actuator attached to this controller.
@type actuator: actuator or the actuator name as a string
"""
def deactivate(actuator):
"""
Deactivates an actuator attached to this controller.
@type actuator: actuator or the actuator name as a string
"""
def getScript():
"""
Gets the Python script body this controller executes.
@deprecated: Use the L{script} attribute instead.
@rtype: string
"""
def setScript(script_body):
"""
Sets the Python script string this controller executes.
@deprecated: Use the L{script} attribute instead.
@type script_body: string.
"""
class SCA_RandomActuator(SCA_IActuator):
"""
Random Actuator
Properties:
@ivar seed: Seed of the random number generator.
Equal seeds produce equal series. If the seed is 0,
the generator will produce the same value on every call.
@type seed: integer
@ivar para1: the first parameter of the active distribution.
Refer to the documentation of the generator types for the meaning
of this value.
@type para1: float, read-only
@ivar para2: the second parameter of the active distribution.
Refer to the documentation of the generator types for the meaning
of this value.
@type para2: float, read-only
@ivar distribution: distribution type:
KX_RANDOMACT_BOOL_CONST, KX_RANDOMACT_BOOL_UNIFORM, KX_RANDOMACT_BOOL_BERNOUILLI,
KX_RANDOMACT_INT_CONST, KX_RANDOMACT_INT_UNIFORM, KX_RANDOMACT_INT_POISSON,
KX_RANDOMACT_FLOAT_CONST, KX_RANDOMACT_FLOAT_UNIFORM, KX_RANDOMACT_FLOAT_NORMAL,
KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
@type distribution: integer, read-only
@ivar propName: the name of the property to set with the random value.
If the generator and property types do not match, the assignment is ignored.
@type propName: string
"""
def setBoolConst(value):
"""
Sets this generator to produce a constant boolean value.
@param value: The value to return.
@type value: boolean
"""
def setBoolUniform():
"""
Sets this generator to produce a uniform boolean distribution.
The generator will generate True or False with 50% chance.
"""
def setBoolBernouilli(value):
"""
Sets this generator to produce a Bernouilli distribution.
@param value: Specifies the proportion of False values to produce.
- 0.0: Always generate True
- 1.0: Always generate False
@type value: float
"""
def setIntConst(value):
"""
Sets this generator to always produce the given value.
@param value: the value this generator produces.
@type value: integer
"""
def setIntUniform(lower_bound, upper_bound):
"""
Sets this generator to produce a random value between the given lower and
upper bounds (inclusive).
@type lower_bound: integer
@type upper_bound: integer
"""
def setIntPoisson(value):
"""
Generate a Poisson-distributed number.
This performs a series of Bernouilli tests with parameter value.
It returns the number of tries needed to achieve succes.
@type value: float
"""
def setFloatConst(value):
"""
Always generate the given value.
@type value: float
"""
def setFloatUniform(lower_bound, upper_bound):
"""
Generates a random float between lower_bound and upper_bound with a
uniform distribution.
@type lower_bound: float
@type upper_bound: float
"""
def setFloatNormal(mean, standard_deviation):
"""
Generates a random float from the given normal distribution.
@type mean: float
@param mean: The mean (average) value of the generated numbers
@type standard_deviation: float
@param standard_deviation: The standard deviation of the generated numbers.
"""
def setFloatNegativeExponential(half_life):
"""
Generate negative-exponentially distributed numbers.
The half-life 'time' is characterized by half_life.
@type half_life: float
"""
#{ Deprecated
def setSeed(seed):
"""
Sets the seed of the random number generator.
Equal seeds produce equal series. If the seed is 0,
the generator will produce the same value on every call.
@deprecated: Use the L{seed} attribute instead.
@type seed: integer
"""
def getSeed():
"""
Returns the initial seed of the generator.
@deprecated: Use the L{seed} attribute instead.
@rtype: integer
"""
def getPara1():
"""
Returns the first parameter of the active distribution.
Refer to the documentation of the generator types for the meaning
of this value.
@deprecated: Use the L{para1} attribute instead.
@rtype: float
"""
def getPara2():
"""
Returns the second parameter of the active distribution.
Refer to the documentation of the generator types for the meaning
of this value.
@deprecated: Use the L{para2} attribute instead.
@rtype: float
"""
def getDistribution():
"""
Returns the type of random distribution.
@deprecated: Use the L{distribution} attribute instead.
@rtype: distribution type
@return: KX_RANDOMACT_BOOL_CONST, KX_RANDOMACT_BOOL_UNIFORM, KX_RANDOMACT_BOOL_BERNOUILLI,
KX_RANDOMACT_INT_CONST, KX_RANDOMACT_INT_UNIFORM, KX_RANDOMACT_INT_POISSON,
KX_RANDOMACT_FLOAT_CONST, KX_RANDOMACT_FLOAT_UNIFORM, KX_RANDOMACT_FLOAT_NORMAL,
KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
"""
def setProperty(property):
"""
Set the property to which the random value is assigned.
If the generator and property types do not match, the assignment is ignored.
@deprecated: Use the L{propName} attribute instead.
@type property: string
@param property: The name of the property to set.
"""
def getProperty():
"""
Returns the name of the property to set.
@deprecated: Use the L{propName} attribute instead.
@rtype: string
"""
#}
class SCA_RandomSensor(SCA_ISensor):
"""
This sensor activates randomly.
@ivar lastDraw: The seed of the random number generator.
@type lastDraw: int
@ivar seed: The seed of the random number generator.
@type seed: int
"""
def setSeed(seed):
"""
Sets the seed of the random number generator.
If the seed is 0, the generator will produce the same value on every call.
@type seed: integer.
"""
def getSeed():
"""
Returns the initial seed of the generator. Equal seeds produce equal random
series.
@rtype: integer
"""
def getLastDraw():
"""
Returns the last random number generated.
@rtype: integer
"""
class SCA_XNORController(SCA_IController):
"""
An XNOR controller activates when all linked sensors are the same (activated or inative).
There are no special python methods for this controller.
"""
class SCA_XORController(SCA_IController):
"""
An XOR controller activates when there is the input is mixed, but not when all are on or off.
There are no special python methods for this controller.
"""
class KX_Camera(KX_GameObject):
"""
A Camera object.
@group Constants: INSIDE, INTERSECT, OUTSIDE
@ivar INSIDE: see sphereInsideFrustum() and boxInsideFrustum()
@ivar INTERSECT: see sphereInsideFrustum() and boxInsideFrustum()
@ivar OUTSIDE: see sphereInsideFrustum() and boxInsideFrustum()
@ivar lens: The camera's lens value.
@type lens: float
@ivar near: The camera's near clip distance.
@type near: float
@ivar far: The camera's far clip distance.
@type far: float
@ivar perspective: True if this camera has a perspective transform, False for an orthographic projection.
@type perspective: boolean
@ivar frustum_culling: True if this camera is frustum culling.
@type frustum_culling: boolean
@ivar projection_matrix: This camera's 4x4 projection matrix.
@type projection_matrix: 4x4 Matrix [[float]]
@ivar modelview_matrix: This camera's 4x4 model view matrix. (read-only)
Regenerated every frame from the camera's position and orientation.
@type modelview_matrix: 4x4 Matrix [[float]]
@ivar camera_to_world: This camera's camera to world transform. (read-only)
Regenerated every frame from the camera's position and orientation.
@type camera_to_world: 4x4 Matrix [[float]]
@ivar world_to_camera: This camera's world to camera transform. (read-only)
Regenerated every frame from the camera's position and orientation.
This is camera_to_world inverted.
@type world_to_camera: 4x4 Matrix [[float]]
@ivar useViewport: True when the camera is used as a viewport, set True to enable a viewport for this camera.
@type useViewport: bool
@group Deprecated: enableViewport, getProjectionMatrix, setProjectionMatrix
"""
def sphereInsideFrustum(centre, radius):
"""
Tests the given sphere against the view frustum.
@note: when the camera is first initialized the result will be invalid because the projection matrix has not been set.
@param centre: The centre of the sphere (in world coordinates.)
@type centre: list [x, y, z]
@param radius: the radius of the sphere
@type radius: float
@return: INSIDE, OUTSIDE or INTERSECT
Example::
import GameLogic
co = GameLogic.getCurrentController()
cam = co.owner
# A sphere of radius 4.0 located at [x, y, z] = [1.0, 1.0, 1.0]
if (cam.sphereInsideFrustum([1.0, 1.0, 1.0], 4) != cam.OUTSIDE):
# Sphere is inside frustum !
# Do something useful !
else:
# Sphere is outside frustum
"""
def boxInsideFrustum(box):
"""
Tests the given box against the view frustum.
Example::
import GameLogic
co = GameLogic.getCurrentController()
cam = co.owner
# Box to test...
box = []
box.append([-1.0, -1.0, -1.0])
box.append([-1.0, -1.0, 1.0])
box.append([-1.0, 1.0, -1.0])
box.append([-1.0, 1.0, 1.0])
box.append([ 1.0, -1.0, -1.0])
box.append([ 1.0, -1.0, 1.0])
box.append([ 1.0, 1.0, -1.0])
box.append([ 1.0, 1.0, 1.0])
if (cam.boxInsideFrustum(box) != cam.OUTSIDE):
# Box is inside/intersects frustum !
# Do something useful !
else:
# Box is outside the frustum !
@note: when the camera is first initialized the result will be invalid because the projection matrix has not been set.
@return: INSIDE, OUTSIDE or INTERSECT
@type box: list
@param box: Eight (8) corner points of the box (in world coordinates.)
"""
def pointInsideFrustum(point):
"""
Tests the given point against the view frustum.
Example::
import GameLogic
co = GameLogic.getCurrentController()
cam = co.owner
# Test point [0.0, 0.0, 0.0]
if (cam.pointInsideFrustum([0.0, 0.0, 0.0])):
# Point is inside frustum !
# Do something useful !
else:
# Box is outside the frustum !
@note: when the camera is first initialized the result will be invalid because the projection matrix has not been set.
@rtype: boolean
@return: True if the given point is inside this camera's viewing frustum.
@type point: [x, y, z]
@param point: The point to test (in world coordinates.)
"""
def getCameraToWorld():
"""
Returns the camera-to-world transform.
@rtype: matrix (4x4 list)
@return: the camera-to-world transform matrix.
"""
def getWorldToCamera():
"""
Returns the world-to-camera transform.
This returns the inverse matrix of getCameraToWorld().
@rtype: matrix (4x4 list)
@return: the world-to-camera transform matrix.
"""
def getProjectionMatrix():
"""
Returns the camera's projection matrix.
@deprecated: Use the L{projection_matrix} attribute instead.
@rtype: matrix (4x4 list)
@return: the camera's projection matrix.
"""
def setProjectionMatrix(matrix):
"""
Sets the camera's projection matrix.
You should use normalised device coordinates for the clipping planes:
left = -1.0, right = 1.0, top = 1.0, bottom = -1.0, near = cam.near, far = cam.far
Example::
import GameLogic
def Scale(matrix, size):
for y in range(4):
for x in range(4):
matrix[y][x] = matrix[y][x] * size[y]
return matrix
# Generate a perspective projection matrix
def Perspective(cam):
return [[cam.near, 0.0 , 0.0 , 0.0 ],
[0.0 , cam.near, 0.0 , 0.0 ],
[0.0 , 0.0 , -(cam.far+cam.near)/(cam.far-cam.near), -2.0*cam.far*cam.near/(cam.far - cam.near)],
[0.0 , 0.0 , -1.0 , 0.0 ]]
# Generate an orthographic projection matrix
# You will need to scale the camera
def Orthographic(cam):
return [[1.0/cam.scaling[0], 0.0 , 0.0 , 0.0 ],
[0.0 , 1.0/cam.scaling[1], 0.0 , 0.0 ],
[0.0 , 0.0 , -2.0/(cam.far-cam.near), -(cam.far+cam.near)/(cam.far-cam.near)],
[0.0 , 0.0 , 0.0 , 1.0 ]]
# Generate an isometric projection matrix
def Isometric(cam):
return Scale([[0.707, 0.0 , 0.707, 0.0],
[0.408, 0.816,-0.408, 0.0],
[0.0 , 0.0 , 0.0 , 0.0],
[0.0 , 0.0 , 0.0 , 1.0]],
[1.0/cam.scaling[0], 1.0/cam.scaling[1], 1.0/cam.scaling[2], 1.0])
co = GameLogic.getCurrentController()
cam = co.owner
cam.setProjectionMatrix(Perspective(cam)))
@deprecated: Use the L{projection_matrix} attribute instead.
@type matrix: 4x4 matrix.
@param matrix: The new projection matrix for this camera.
"""
def enableViewport(viewport):
"""
Use this camera to draw a viewport on the screen (for split screen games or overlay scenes). The viewport region is defined with L{setViewport}.
@deprecated: Use the L{useViewport} attribute instead.
@type viewport: bool
@param viewport: the new viewport status
"""
def setOnTop():
"""
Set this cameras viewport ontop of all other viewport.
"""
def setViewport(left, bottom, right, top):
"""
Sets the region of this viewport on the screen in pixels.
Use L{Rasterizer.getWindowHeight} L{Rasterizer.getWindowWidth} to calculate values relative to the entire display.
@type left: int
@type bottom: int
@type right: int
@type top: int
"""
def getScreenPosition(arg):
"""
Gets the position of an object projected on screen space.
Example:
# For an object in the middle of the screen, coord = [0.5,0.5]
coord = camera.getScreenPosition(object)
@param arg: L{KX_GameObject}, object name or list [x, y, z]
@rtype: list [x, y]
@return: the object's position in screen coordinates.
"""
def getScreenVect(x, y):
"""
Gets the vector from the camera position in the screen coordinate direction.
Example:
# Gets the vector of the camera front direction:
m_vect = camera.getScreenVect(0.5,0.5)
@type x: float
@type y: float
@rtype: 3d vector
@return: the vector from a screen coordinate.
"""
def getScreenRay(x, y, dist, property):
"""
Look towards a screen coordinate (x,y) and find first object hit within dist that matches prop.
The ray is similar to KX_GameObject->rayCastTo.
Example:
# Gets an object with a property "wall" in front of the camera within a distance of 100:
target = camera.getScreenRay(0.5,0.5,100,"wall")
@type x: float
@type y: float
@param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
@type dist: float
@param property: property name that object must have; can be omitted => detect any object
@type property: string
@rtype: L{KX_GameObject}
@return: the first object hit or None if no object or object does not match prop
"""
# Util func to extract all attrs
"""
import types
attrs = []
for name, val in locals().items():
if name.startswith('__'):
continue
if type(val) == types.ClassType:
for line in val.__doc__.split('\n'):
if '@ivar' in line:
attrs.append(name + '::' + line.split()[1].replace(':', ''))
for a in attrs:
print a
"""
# Util func to construct a mapping from deprecated attrs to new ones.
"""
import types
import re
import pprint
depAttrs = {}
for name, val in locals().items():
if name.startswith('__'):
continue
if type(val) == types.ClassType:
print "\t# %s" % name
# Inspect each attribute.
for attrName in dir(val):
if attrName.startswith('__'):
continue
attr = getattr(val, attrName)
# Check whether this attribute is deprecated by searching each line.
newAttrName = None
for line in attr.__doc__.split('\n'):
match = re.search(r'@deprecated.*L{(\w+)}', line)
if match:
newAttrName = match.group(1)
break
if not newAttrName:
continue
# Store the mappings to new attributes in a list (because there
# could be collisions).
if not depAttrs.has_key(attrName):
depAttrs[attrName] = {}
mapping = depAttrs[attrName]
for line in val.__doc__.split('\n'):
if ("@type %s:" % newAttrName) in line:
# The attribute is being replaced in this class (i.e. the
# deprecated attribute wasn't inherited from a parent). We
# have a winner!
funcType = None
if 'sequence' in line:
funcType = 'Keyed'
else:
funcType = 'Simple'
if attrName.startswith('get') or attrName.startswith('is'):
func = "replace%sGetter" % funcType
elif attrName.startswith('set') or attrName.startswith('enable'):
func = "replace%sSetter" % funcType
else:
func = 'UNKNOWN'
# Another mapping, from a conversion tuple to lists of class
# names.
conversion = (func, newAttrName)
if not mapping.has_key(conversion):
mapping[conversion] = []
mapping[conversion].append(name)
break
pprint.pprint(depAttrs, width = 100)
"""
|