7d20aa31a36d22afa395bdf1535ba924936bb266
[blender.git] / doc / python_api / rst / bge.logic.rst
1
2 Game Logic (bge.logic)
3 ======================
4
5 ************
6 Introduction
7 ************
8
9 Module to access logic functions, imported automatically into the python controllers namespace.
10
11 .. module:: bge.logic
12
13 .. code-block:: python
14
15    # To get the controller thats running this python script:
16    cont = bge.logic.getCurrentController() # bge.logic is automatically imported
17    
18    # To get the game object this controller is on:
19    obj = cont.owner
20
21 :class:`~bge.types.KX_GameObject` and :class:`~bge.types.KX_Camera` or :class:`~bge.types.KX_LightObject` methods are available depending on the type of object
22
23 .. code-block:: python
24
25    # To get a sensor linked to this controller.
26    # "sensorname" is the name of the sensor as defined in the Blender interface.
27    # +---------------------+  +--------+
28    # | Sensor "sensorname" +--+ Python +
29    # +---------------------+  +--------+
30    sens = cont.sensors["sensorname"]
31
32    # To get a sequence of all sensors:
33    sensors = co.sensors
34
35 See the sensor's reference for available methods:
36
37 .. hlist::
38    :columns: 3
39
40    * :class:`~bge.types.KX_MouseFocusSensor`
41    * :class:`~bge.types.KX_NearSensor`
42    * :class:`~bge.types.KX_NetworkMessageSensor`
43    * :class:`~bge.types.KX_RadarSensor`
44    * :class:`~bge.types.KX_RaySensor`
45    * :class:`~bge.types.KX_TouchSensor`
46    * :class:`~bge.types.SCA_DelaySensor`
47    * :class:`~bge.types.SCA_JoystickSensor`
48    * :class:`~bge.types.SCA_KeyboardSensor`
49    * :class:`~bge.types.SCA_MouseSensor`
50    * :class:`~bge.types.SCA_PropertySensor`
51    * :class:`~bge.types.SCA_RandomSensor`
52
53 You can also access actuators linked to the controller
54
55 .. code-block:: python
56
57    # To get an actuator attached to the controller:
58    #                          +--------+  +-------------------------+
59    #                          + Python +--+ Actuator "actuatorname" |
60    #                          +--------+  +-------------------------+
61    actuator = co.actuators["actuatorname"]
62    
63    # Activate an actuator
64    controller.activate(actuator)
65
66 See the actuator's reference for available methods
67
68 .. hlist::
69    :columns: 3
70    
71    * :class:`~bge.types.BL_ActionActuator`
72    * :class:`~bge.types.KX_CameraActuator`
73    * :class:`~bge.types.KX_ConstraintActuator`
74    * :class:`~bge.types.KX_GameActuator`
75    * :class:`~bge.types.KX_NetworkMessageActuator`
76    * :class:`~bge.types.KX_ObjectActuator`
77    * :class:`~bge.types.KX_ParentActuator`
78    * :class:`~bge.types.KX_SCA_AddObjectActuator`
79    * :class:`~bge.types.KX_SCA_DynamicActuator`
80    * :class:`~bge.types.KX_SCA_EndObjectActuator`
81    * :class:`~bge.types.KX_SCA_ReplaceMeshActuator`
82    * :class:`~bge.types.KX_SceneActuator`
83    * :class:`~bge.types.KX_SoundActuator`
84    * :class:`~bge.types.KX_StateActuator`
85    * :class:`~bge.types.KX_TrackToActuator`
86    * :class:`~bge.types.KX_VisibilityActuator`
87    * :class:`~bge.types.SCA_2DFilterActuator`
88    * :class:`~bge.types.SCA_PropertyActuator`
89    * :class:`~bge.types.SCA_RandomActuator`
90
91 Most logic brick's methods are accessors for the properties available in the logic buttons.
92 Consult the logic bricks documentation for more information on how each logic brick works.
93
94 There are also methods to access the current :class:`bge.types.KX_Scene`
95
96 .. code-block:: python
97
98    # Get the current scene
99    scene = bge.logic.getCurrentScene()
100
101    # Get the current camera
102    cam = scene.active_camera
103
104 Matricies as used by the game engine are **row major**
105 ``matrix[row][col] = float``
106
107 :class:`bge.types.KX_Camera` has some examples using matrices.
108
109 *********
110 Variables
111 *********
112
113 .. data:: globalDict
114
115    A dictionary that is saved between loading blend files so you can use it to store inventory and other variables you want to store between scenes and blend files.
116    It can also be written to a file and loaded later on with the game load/save actuators.
117
118    .. note:: only python built in types such as int/string/bool/float/tuples/lists can be saved, GameObjects, Actuators etc will not work as expected.
119
120 .. data:: keyboard
121
122    The current keyboard wrapped in an :class:`~bge.types.SCA_PythonKeyboard` object.
123
124 .. data:: mouse
125
126    The current mouse wrapped in an :class:`~bge.types.SCA_PythonMouse` object.
127
128 *****************
129 General functions
130 *****************
131
132 .. function:: getCurrentController()
133
134    Gets the Python controller associated with this Python script.
135    
136    :rtype: :class:`bge.types.SCA_PythonController`
137
138 .. function:: getCurrentScene()
139
140    Gets the current Scene.
141    
142    :rtype: :class:`bge.types.KX_Scene`
143
144 .. function:: getSceneList()
145
146    Gets a list of the current scenes loaded in the game engine.
147    
148    :rtype: list of :class:`bge.types.KX_Scene`
149    
150    .. note:: Scenes in your blend file that have not been converted wont be in this list. This list will only contain scenes such as overlays scenes.
151
152 .. function:: loadGlobalDict()
153
154    Loads bge.logic.globalDict from a file.
155
156 .. function:: saveGlobalDict()
157
158    Saves bge.logic.globalDict to a file.
159
160 .. function:: startGame(blend)
161
162    Loads the blend file.
163    
164    :arg blend: The name of the blend file
165    :type blend: string
166
167 .. function:: endGame()
168
169    Ends the current game.
170
171 .. function:: restartGame()
172
173    Restarts the current game by reloading the .blend file (the last saved version, not what is currently running).
174    
175 .. function:: LibLoad(blend, type, data, load_actions=False, verbose=False, load_scripts=True)
176    
177    Converts the all of the datablocks of the given type from the given blend.
178    
179    :arg blend: The path to the blend file (or the name to use for the library if data is supplied)
180    :type blend: string
181    :arg type: The datablock type (currently only "Action", "Mesh" and "Scene" are supported)
182    :type type: string
183    :arg data: Binary data from a blend file (optional)
184    :type data: bytes
185    :arg load_actions: Search for and load all actions in a given Scene and not just the "active" actions (Scene type only)
186    :type load_actions: bool
187    :arg verbose: Whether or not to print debugging information (e.g., "SceneName: Scene")
188    :type verbose: bool
189    :arg load_scripts: Whether or not to load text datablocks as well (can be disabled for some extra security)
190    :type load_scripts: bool
191    
192 .. function:: LibNew(name, type, data)
193
194    Uses existing datablock data and loads in as a new library.
195    
196    :arg name: A unique library name used for removal later
197    :type name: string
198    :arg type: The datablock type (currently only "Mesh" is supported)
199    :type type: string
200    :arg data: A list of names of the datablocks to load
201    :type data: list of strings
202    
203 .. function:: LibFree(name)
204
205    Frees a library, removing all objects and meshes from the currently active scenes.
206
207    :arg name: The name of the library to free (the name used in LibNew)
208    :type name: string
209    
210 .. function:: LibList()
211
212    Returns a list of currently loaded libraries.
213    
214    :rtype: list [str]
215
216 .. function:: addScene(name, overlay=1)
217
218    Loads a scene into the game engine.
219
220    .. note::
221
222       This function is not effective immediately, the scene is queued
223       and added on the next logic cycle where it will be available
224       from `getSceneList`
225
226    :arg name: The name of the scene
227    :type name: string
228    :arg overlay: Overlay or underlay (optional)
229    :type overlay: integer
230
231 .. function:: sendMessage(subject, body="", to="", message_from="")
232
233    Sends a message to sensors in any active scene.
234    
235    :arg subject: The subject of the message
236    :type subject: string
237    :arg body: The body of the message (optional)
238    :type body: string
239    :arg to: The name of the object to send the message to (optional)
240    :type to: string
241    :arg message_from: The name of the object that the message is coming from (optional)
242    :type message_from: string
243
244 .. function:: setGravity(gravity)
245
246    Sets the world gravity.
247    
248    :type gravity: list [fx, fy, fz]
249
250 .. function:: getSpectrum()
251
252    Returns a 512 point list from the sound card.
253    This only works if the fmod sound driver is being used.
254    
255    :rtype: list [float], len(getSpectrum()) == 512
256
257 .. function:: getMaxLogicFrame()
258
259    Gets the maximum number of logic frames per render frame.
260    
261    :return: The maximum number of logic frames per render frame
262    :rtype: integer
263
264 .. function:: setMaxLogicFrame(maxlogic)
265
266    Sets the maximum number of logic frames that are executed per render frame.
267    This does not affect the physic system that still runs at full frame rate.   
268     
269    :arg maxlogic: The new maximum number of logic frames per render frame. Valid values: 1..5
270    :type maxlogic: integer
271
272 .. function:: getMaxPhysicsFrame()
273
274    Gets the maximum number of physics frames per render frame.
275    
276    :return: The maximum number of physics frames per render frame
277    :rtype: integer
278
279 .. function:: setMaxPhysicsFrame(maxphysics)
280
281    Sets the maximum number of physics timestep that are executed per render frame.
282    Higher value allows physics to keep up with realtime even if graphics slows down the game.
283    Physics timestep is fixed and equal to 1/tickrate (see setLogicTicRate)
284    maxphysics/ticrate is the maximum delay of the renderer that physics can compensate.
285     
286    :arg maxphysics: The new maximum number of physics timestep per render frame. Valid values: 1..5.
287    :type maxphysics: integer
288
289 .. function:: getLogicTicRate()
290
291    Gets the logic update frequency.
292    
293    :return: The logic frequency in Hz
294    :rtype: float
295
296 .. function:: setLogicTicRate(ticrate)
297
298    Sets the logic update frequency.
299    
300    The logic update frequency is the number of times logic bricks are executed every second.
301    The default is 60 Hz.
302    
303    :arg ticrate: The new logic update frequency (in Hz).
304    :type ticrate: float
305
306 .. function:: getPhysicsTicRate()
307
308    Gets the physics update frequency
309    
310    :return: The physics update frequency in Hz
311    :rtype: float
312    
313    .. warning: Not implimented yet
314
315 .. function:: setPhysicsTicRate(ticrate)
316
317    Sets the physics update frequency
318    
319    The physics update frequency is the number of times the physics system is executed every second.
320    The default is 60 Hz.
321    
322    :arg ticrate: The new update frequency (in Hz).
323    :type ticrate: float
324
325    .. warning: Not implimented yet
326
327 .. function:: getExitKey()
328
329    Gets the key used to exit the game engine
330
331    :return: The key (defaults to :mod:`bge.events.ESCKEY`)
332    :rtype: int
333
334 .. function:: setExitKey(key)
335
336    Sets the key used to exit the game engine
337
338    :arg key: A key constant from :mod:`bge.events`
339    :type key: int
340
341 .. function:: NextFrame()
342
343    Render next frame (if Python has control)
344
345 *****************
346 Utility functions
347 *****************
348
349 .. function:: expandPath(path)
350
351    Converts a blender internal path into a proper file system path.
352
353    Use / as directory separator in path
354    You can use '//' at the start of the string to define a relative path;
355    Blender replaces that string by the directory of the startup .blend or runtime file
356    to make a full path name (doesn't change during the game, even if you load other .blend).
357    The function also converts the directory separator to the local file system format.
358
359    :arg path: The path string to be converted/expanded.
360    :type path: string
361    :return: The converted string
362    :rtype: string
363
364 .. function:: getAverageFrameRate()
365
366    Gets the estimated/average framerate for all the active scenes, not only the current scene.
367
368    :return: The estimated average framerate in frames per second
369    :rtype: float
370
371 .. function:: getBlendFileList(path = "//")
372
373    Returns a list of blend files in the same directory as the open blend file, or from using the option argument.
374
375    :arg path: Optional directory argument, will be expanded (like expandPath) into the full path.
376    :type path: string
377    :return: A list of filenames, with no directory prefix
378    :rtype: list
379
380 .. function:: getRandomFloat()
381
382    Returns a random floating point value in the range [0 - 1)
383
384 .. function:: PrintGLInfo()
385
386    Prints GL Extension Info into the console
387
388 .. function:: PrintMemInfo()
389
390    Prints engine statistics into the console
391    
392 *********
393 Constants
394 *********
395
396 .. data:: KX_TRUE
397
398    True value used by some modules.
399
400 .. data:: KX_FALSE
401
402    False value used by some modules.
403
404 =======
405 Sensors
406 ======= 
407
408 .. _sensor-status:
409
410 -------------
411 Sensor Status
412 -------------
413
414 .. data:: KX_SENSOR_INACTIVE
415 .. data:: KX_SENSOR_JUST_ACTIVATED
416 .. data:: KX_SENSOR_ACTIVE
417 .. data:: KX_SENSOR_JUST_DEACTIVATED
418
419 ---------------
420 Armature Sensor
421 ---------------
422
423 .. _armaturesensor-type:
424
425 See :class:`bge.types.KX_ArmatureSensor.type`
426
427 .. data:: KX_ARMSENSOR_STATE_CHANGED
428
429   Detect that the constraint is changing state (active/inactive)
430
431   :value: 0
432   
433 .. data:: KX_ARMSENSOR_LIN_ERROR_BELOW
434
435   Detect that the constraint linear error is above a threshold
436   
437   :value: 1
438   
439 .. data:: KX_ARMSENSOR_LIN_ERROR_ABOVE
440
441   Detect that the constraint linear error is below a threshold
442
443   :value: 2
444   
445 .. data:: KX_ARMSENSOR_ROT_ERROR_BELOW
446
447   Detect that the constraint rotation error is above a threshold
448   
449   :value: 3
450   
451 .. data:: KX_ARMSENSOR_ROT_ERROR_ABOVE
452
453   Detect that the constraint rotation error is below a threshold
454   
455   :value: 4
456   
457
458 .. _logic-property-sensor:
459
460 ---------------
461 Property Sensor
462 ---------------
463
464 .. data:: KX_PROPSENSOR_EQUAL
465
466    Activate when the property is equal to the sensor value.
467
468    :value: 1
469
470 .. data:: KX_PROPSENSOR_NOTEQUAL
471
472    Activate when the property is not equal to the sensor value.
473    
474    :value: 2
475
476 .. data:: KX_PROPSENSOR_INTERVAL
477
478    Activate when the property is between the specified limits.
479    
480    :value: 3
481    
482 .. data:: KX_PROPSENSOR_CHANGED
483
484    Activate when the property changes   
485
486    :value: 4
487
488 .. data:: KX_PROPSENSOR_EXPRESSION
489
490    Activate when the expression matches
491    
492    :value: 5
493
494 ------------
495 Radar Sensor
496 ------------
497
498 See :class:`bge.types.KX_RadarSensor`
499
500 .. data:: KX_RADAR_AXIS_POS_X
501 .. data:: KX_RADAR_AXIS_POS_Y
502 .. data:: KX_RADAR_AXIS_POS_Z
503 .. data:: KX_RADAR_AXIS_NEG_X
504 .. data:: KX_RADAR_AXIS_NEG_Y
505 .. data:: KX_RADAR_AXIS_NEG_Z
506
507 ----------
508 Ray Sensor
509 ----------
510
511 See :class:`bge.types.KX_RaySensor`
512
513 .. data:: KX_RAY_AXIS_POS_X
514 .. data:: KX_RAY_AXIS_POS_Y
515 .. data:: KX_RAY_AXIS_POS_Z
516 .. data:: KX_RAY_AXIS_NEG_X
517 .. data:: KX_RAY_AXIS_NEG_Y
518 .. data:: KX_RAY_AXIS_NEG_Z
519
520
521 =========
522 Actuators
523 =========
524
525 .. _action-actuator:
526
527 ---------------
528 Action Actuator
529 ---------------
530
531 See :class:`bge.types.BL_ActionActuator`
532
533 .. data:: KX_ACTIONACT_PLAY
534 .. data:: KX_ACTIONACT_PINGPONG
535 .. data:: KX_ACTIONACT_FLIPPER
536 .. data:: KX_ACTIONACT_LOOPSTOP
537 .. data:: KX_ACTIONACT_LOOPEND
538 .. data:: KX_ACTIONACT_PROPERTY
539
540 -----------------
541 Armature Actuator
542 -----------------
543
544  .. _armatureactuator-constants-type:
545    
546 See :class:`bge.types.BL_ArmatureActuator.type`
547
548 .. data:: KX_ACT_ARMATURE_RUN
549
550   Just make sure the armature will be updated on the next graphic frame.
551   This is the only persistent mode of the actuator:
552   it executes automatically once per frame until stopped by a controller
553   
554   :value: 0
555
556 .. data:: KX_ACT_ARMATURE_ENABLE
557
558   Enable the constraint.
559
560   :value: 1
561
562 .. data:: KX_ACT_ARMATURE_DISABLE
563
564   Disable the constraint (runtime constraint values are not updated).
565
566   :value: 2
567
568 .. data:: KX_ACT_ARMATURE_SETTARGET
569
570   Change target and subtarget of constraint.
571   
572   :value: 3
573
574 .. data:: KX_ACT_ARMATURE_SETWEIGHT
575
576   Change weight of constraint (IK only).
577
578   :value: 4
579
580 .. data:: KX_ACT_ARMATURE_SETINFLUENCE
581
582   Change influence of constraint.
583
584   :value: 5
585
586 -------------------
587 Constraint Actuator
588 -------------------
589
590 .. _constraint-actuator-option:
591
592 See :class:`bge.types.KX_ConstraintActuator.option`
593
594 * Applicable to Distance constraint:
595
596 .. data:: KX_CONSTRAINTACT_NORMAL
597
598      Activate alignment to surface
599    
600 .. data:: KX_CONSTRAINTACT_DISTANCE
601
602      Activate distance control
603
604 .. data:: KX_CONSTRAINTACT_LOCAL
605
606      Direction of the ray is along the local axis
607
608 * Applicable to Force field constraint:
609
610 .. data:: KX_CONSTRAINTACT_DOROTFH
611
612      Force field act on rotation as well
613
614 * Applicable to both:
615
616 .. data:: KX_CONSTRAINTACT_MATERIAL
617
618      Detect material rather than property
619    
620 .. data:: KX_CONSTRAINTACT_PERMANENT
621
622      No deactivation if ray does not hit target
623
624 .. _constraint-actuator-limit:
625
626 See :class:`bge.types.KX_ConstraintActuator.limit`
627
628 .. data:: KX_CONSTRAINTACT_LOCX
629
630    Limit X coord.
631    
632 .. data:: KX_CONSTRAINTACT_LOCY
633
634    Limit Y coord
635
636 .. data:: KX_CONSTRAINTACT_LOCZ
637
638    Limit Z coord
639    
640 .. data:: KX_CONSTRAINTACT_ROTX
641
642    Limit X rotation
643
644 .. data:: KX_CONSTRAINTACT_ROTY
645
646    Limit Y rotation
647    
648 .. data:: KX_CONSTRAINTACT_ROTZ
649
650    Limit Z rotation
651    
652 .. data:: KX_CONSTRAINTACT_DIRNX
653
654    Set distance along negative X axis
655
656 .. data:: KX_CONSTRAINTACT_DIRNY
657
658    Set distance along negative Y axis
659    
660 .. data:: KX_CONSTRAINTACT_DIRNZ
661
662    Set distance along negative Z axis
663    
664 .. data:: KX_CONSTRAINTACT_DIRPX
665
666    Set distance along positive X axis
667
668 .. data:: KX_CONSTRAINTACT_DIRPY
669
670    Set distance along positive Y axis
671    
672 .. data:: KX_CONSTRAINTACT_DIRPZ
673
674    Set distance along positive Z axis
675    
676 .. data:: KX_CONSTRAINTACT_ORIX
677
678    Set orientation of X axis
679    
680 .. data:: KX_CONSTRAINTACT_ORIY
681
682    Set orientation of Y axis
683    
684 .. data:: KX_CONSTRAINTACT_ORIZ
685
686    Set orientation of Z axis
687    
688 .. data:: KX_CONSTRAINTACT_FHNX
689
690    Set force field along negative X axis
691    
692 .. data:: KX_CONSTRAINTACT_FHNY
693
694    Set force field along negative Y axis
695    
696 .. data:: KX_CONSTRAINTACT_FHNZ
697
698    Set force field along negative Z axis
699    
700 .. data:: KX_CONSTRAINTACT_FHPX
701
702    Set force field along positive X axis
703
704 .. data:: KX_CONSTRAINTACT_FHPY
705
706    Set force field along positive Y axis
707    
708 .. data:: KX_CONSTRAINTACT_FHPZ
709
710    Set force field along positive Z axis
711
712 ----------------
713 Dynamic Actuator
714 ----------------
715
716 See :class:`bge.types.KX_SCA_DynamicActuator`
717
718 .. data:: KX_DYN_RESTORE_DYNAMICS
719 .. data:: KX_DYN_DISABLE_DYNAMICS
720 .. data:: KX_DYN_ENABLE_RIGID_BODY
721 .. data:: KX_DYN_DISABLE_RIGID_BODY
722 .. data:: KX_DYN_SET_MASS
723
724 .. _game-actuator:
725
726 -------------
727 Game Actuator
728 -------------
729
730 See :class:`bge.types.KX_GameActuator`
731
732 .. data:: KX_GAME_LOAD
733 .. data:: KX_GAME_START
734 .. data:: KX_GAME_RESTART
735 .. data:: KX_GAME_QUIT
736 .. data:: KX_GAME_SAVECFG
737 .. data:: KX_GAME_LOADCFG
738
739 ---------------
740 Parent Actuator
741 ---------------
742
743 .. data:: KX_PARENT_REMOVE
744 .. data:: KX_PARENT_SET
745
746 .. _logic-random-distributions:
747
748 --------------------
749 Random Distributions
750 --------------------
751
752 See :class:`bge.types.SCA_RandomActuator`
753
754 .. data:: KX_RANDOMACT_BOOL_CONST
755 .. data:: KX_RANDOMACT_BOOL_UNIFORM
756 .. data:: KX_RANDOMACT_BOOL_BERNOUILLI
757 .. data:: KX_RANDOMACT_INT_CONST
758 .. data:: KX_RANDOMACT_INT_UNIFORM
759 .. data:: KX_RANDOMACT_INT_POISSON
760 .. data:: KX_RANDOMACT_FLOAT_CONST
761 .. data:: KX_RANDOMACT_FLOAT_UNIFORM
762 .. data:: KX_RANDOMACT_FLOAT_NORMAL
763 .. data:: KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
764
765 --------------
766 Scene Actuator
767 --------------
768
769 See :class:`bge.types.KX_SceneActuator`
770
771 .. data:: KX_SCENE_RESTART
772 .. data:: KX_SCENE_SET_SCENE
773 .. data:: KX_SCENE_SET_CAMERA
774 .. data:: KX_SCENE_ADD_FRONT_SCENE
775 .. data:: KX_SCENE_ADD_BACK_SCENE
776 .. data:: KX_SCENE_REMOVE_SCENE
777 .. data:: KX_SCENE_SUSPEND
778 .. data:: KX_SCENE_RESUME
779
780 .. _logic-sound-actuator:
781
782 --------------
783 Sound Actuator
784 --------------
785       
786 See :class:`bge.types.KX_SoundActuator`
787
788 .. data:: KX_SOUNDACT_PLAYSTOP
789
790    :value: 1
791    
792 .. data:: KX_SOUNDACT_PLAYEND
793
794    :value: 2
795    
796 .. data:: KX_SOUNDACT_LOOPSTOP
797
798    :value: 3
799    
800 .. data:: KX_SOUNDACT_LOOPEND
801
802    :value: 4
803    
804 .. data:: KX_SOUNDACT_LOOPBIDIRECTIONAL
805
806    :value: 5
807    
808 .. data:: KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP
809
810    :value: 6
811
812 -----------------
813 Steering Actuator
814 -----------------
815
816 .. _logic-steering-actuator:
817
818 See :class:`bge.types.KX_SteeringActuator.behavior`
819
820 .. data:: KX_STEERING_SEEK
821
822    :value: 1
823
824 .. data:: KX_STEERING_FLEE
825
826    :value: 2
827
828 .. data:: KX_STEERING_PATHFOLLOWING
829
830    :value: 3
831
832
833 =======
834 Various
835 =======
836
837 ---------
838 2D Filter
839 ---------
840
841 .. data:: RAS_2DFILTER_BLUR
842
843    :value: 2
844    
845 .. data:: RAS_2DFILTER_CUSTOMFILTER
846
847    Customer filter, the code code is set via shaderText property.
848    
849    :value: 12
850    
851 .. data:: RAS_2DFILTER_DILATION
852
853    :value: 4
854    
855 .. data:: RAS_2DFILTER_DISABLED
856
857    Disable the filter that is currently active
858
859    :value: -1
860    
861 .. data:: RAS_2DFILTER_ENABLED
862
863    Enable the filter that was previously disabled
864
865    :value: -2
866    
867 .. data:: RAS_2DFILTER_EROSION
868
869    :value: 5
870    
871 .. data:: RAS_2DFILTER_GRAYSCALE
872
873    :value: 9
874    
875 .. data:: RAS_2DFILTER_INVERT
876
877    :value: 11
878    
879 .. data:: RAS_2DFILTER_LAPLACIAN
880
881    :value: 6
882    
883 .. data:: RAS_2DFILTER_MOTIONBLUR
884
885    Create and enable preset filters
886
887    :value: 1
888    
889 .. data:: RAS_2DFILTER_NOFILTER
890
891    Disable and destroy the filter that is currently active
892
893    :value: 0
894    
895 .. data:: RAS_2DFILTER_PREWITT
896
897    :value: 8
898    
899 .. data:: RAS_2DFILTER_SEPIA
900
901    :value: 10
902    
903 .. data:: RAS_2DFILTER_SHARPEN
904
905    :value: 3
906    
907 .. data:: RAS_2DFILTER_SOBEL
908
909    :value: 7
910
911 ----------------
912 Armature Channel
913 ----------------
914 .. _armaturechannel-constants-rotation-mode:
915
916 See :class:`bge.types.BL_ArmatureChannel.rotation_mode`
917
918 .. note:
919   euler mode are named as in Blender UI but the actual axis order is reversed
920
921 .. data:: ROT_MODE_QUAT
922
923   Use quaternion in rotation attribute to update bone rotation.
924
925   :value: 0
926
927 .. data:: ROT_MODE_XYZ
928
929   Use euler_rotation and apply angles on bone's Z, Y, X axis successively.
930
931   :value: 1
932
933 .. data:: ROT_MODE_XZY
934
935   Use euler_rotation and apply angles on bone's Y, Z, X axis successively.
936
937   :value: 2
938
939 .. data:: ROT_MODE_YXZ
940
941   Use euler_rotation and apply angles on bone's Z, X, Y axis successively.
942
943   :value: 3
944
945 .. data:: ROT_MODE_YZX
946
947   Use euler_rotation and apply angles on bone's X, Z, Y axis successively.
948
949   :value: 4
950
951 .. data:: ROT_MODE_ZXY
952
953   Use euler_rotation and apply angles on bone's Y, X, Z axis successively.
954
955   :value: 5
956
957 .. data:: ROT_MODE_ZYX
958
959   Use euler_rotation and apply angles on bone's X, Y, Z axis successively.
960
961   :value: 6
962
963
964 -------------------
965 Armature Constraint
966 -------------------
967 .. _armatureconstraint-constants-type:
968
969 See :class:`bge.types.BL_ArmatureConstraint.type`
970
971 .. data:: CONSTRAINT_TYPE_TRACKTO
972 .. data:: CONSTRAINT_TYPE_KINEMATIC
973 .. data:: CONSTRAINT_TYPE_ROTLIKE
974 .. data:: CONSTRAINT_TYPE_LOCLIKE
975 .. data:: CONSTRAINT_TYPE_MINMAX
976 .. data:: CONSTRAINT_TYPE_SIZELIKE
977 .. data:: CONSTRAINT_TYPE_LOCKTRACK
978 .. data:: CONSTRAINT_TYPE_STRETCHTO
979 .. data:: CONSTRAINT_TYPE_CLAMPTO
980 .. data:: CONSTRAINT_TYPE_TRANSFORM
981 .. data:: CONSTRAINT_TYPE_DISTLIMIT
982
983 .. _armatureconstraint-constants-ik-type:
984
985 See :class:`bge.types.BL_ArmatureConstraint.ik_type`
986   
987 .. data:: CONSTRAINT_IK_COPYPOSE
988
989    constraint is trying to match the position and eventually the rotation of the target.
990
991    :value: 0
992
993 .. data:: CONSTRAINT_IK_DISTANCE
994
995    Constraint is maintaining a certain distance to target subject to ik_mode
996
997    :value: 1
998
999 .. _armatureconstraint-constants-ik-flag:
1000
1001 See :class:`bge.types.BL_ArmatureConstraint.ik_flag`
1002
1003 .. data:: CONSTRAINT_IK_FLAG_TIP
1004
1005    Set when the constraint operates on the head of the bone and not the tail
1006
1007    :value: 1
1008
1009 .. data:: CONSTRAINT_IK_FLAG_ROT
1010
1011    Set when the constraint tries to match the orientation of the target
1012
1013    :value: 2
1014
1015 .. data:: CONSTRAINT_IK_FLAG_STRETCH
1016
1017    Set when the armature is allowed to stretch (only the bones with stretch factor > 0.0)
1018
1019    :value: 16
1020    
1021 .. data:: CONSTRAINT_IK_FLAG_POS
1022
1023    Set when the constraint tries to match the position of the target.
1024
1025    :value: 32
1026
1027 .. _armatureconstraint-constants-ik-mode:
1028
1029 See :class:`bge.types.BL_ArmatureConstraint.ik_mode`
1030
1031 .. data:: CONSTRAINT_IK_MODE_INSIDE
1032
1033    The constraint tries to keep the bone within ik_dist of target
1034
1035    :value: 0
1036
1037 .. data:: CONSTRAINT_IK_MODE_OUTSIDE
1038
1039    The constraint tries to keep the bone outside ik_dist of the target
1040
1041    :value: 1
1042    
1043 .. data:: CONSTRAINT_IK_MODE_ONSURFACE
1044
1045    The constraint tries to keep the bone exactly at ik_dist of the target.
1046
1047    :value: 2
1048
1049 .. _input-status:
1050
1051 ----------------
1052 Blender Material
1053 ----------------
1054
1055 .. data:: BL_DST_ALPHA
1056 .. data:: BL_DST_COLOR
1057 .. data:: BL_ONE
1058 .. data:: BL_ONE_MINUS_DST_ALPHA
1059 .. data:: BL_ONE_MINUS_DST_COLOR
1060 .. data:: BL_ONE_MINUS_SRC_ALPHA
1061 .. data:: BL_ONE_MINUS_SRC_COLOR
1062 .. data:: BL_SRC_ALPHA
1063 .. data:: BL_SRC_ALPHA_SATURATE
1064 .. data:: BL_SRC_COLOR
1065 .. data:: BL_ZERO
1066
1067 ------------
1068 Input Status
1069 ------------
1070
1071 See :class:`bge.types.SCA_PythonKeyboard`, :class:`bge.types.SCA_PythonMouse`, :class:`bge.types.SCA_MouseSensor`, :class:`bge.types.SCA_KeyboardSensor`
1072
1073 .. data:: KX_INPUT_NONE
1074 .. data:: KX_INPUT_JUST_ACTIVATED
1075 .. data:: KX_INPUT_ACTIVE
1076 .. data:: KX_INPUT_JUST_RELEASED
1077
1078 -------------
1079 KX_GameObject
1080 -------------
1081 .. _gameobject-playaction-mode:
1082
1083 See :class:`bge.types.KX_GameObject.playAction`
1084
1085 .. data:: KX_ACTION_MODE_PLAY
1086
1087    Play the action once.
1088    
1089    :value: 0
1090
1091 .. data:: KX_ACTION_MODE_LOOP
1092
1093    Loop the action (repeat it).
1094    
1095    :value: 1
1096
1097 .. data:: KX_ACTION_MODE_PING_PONG
1098
1099    Play the action one direct then back the other way when it has completed.
1100    
1101    :value: 2
1102
1103
1104 -------------
1105 Mouse Buttons
1106 -------------
1107
1108 See :class:`bge.types.SCA_MouseSensor`
1109
1110 .. data:: KX_MOUSE_BUT_LEFT
1111 .. data:: KX_MOUSE_BUT_MIDDLE
1112 .. data:: KX_MOUSE_BUT_RIGHT
1113
1114 --------------------------
1115 Navigation Mesh Draw Modes
1116 --------------------------
1117
1118 .. _navmesh-draw-mode:
1119
1120 .. data:: RM_WALLS
1121
1122    Draw only the walls.
1123
1124 .. data:: RM_POLYS
1125
1126    Draw only polygons.
1127  
1128 .. data:: RM_TRIS
1129
1130    Draw triangle mesh.
1131    
1132 ------
1133 Shader
1134 ------
1135
1136 .. data:: VIEWMATRIX
1137 .. data:: VIEWMATRIX_INVERSE
1138 .. data:: VIEWMATRIX_INVERSETRANSPOSE
1139 .. data:: VIEWMATRIX_TRANSPOSE
1140 .. data:: MODELMATRIX
1141 .. data:: MODELMATRIX_INVERSE
1142 .. data:: MODELMATRIX_INVERSETRANSPOSE
1143 .. data:: MODELMATRIX_TRANSPOSE
1144 .. data:: MODELVIEWMATRIX
1145 .. data:: MODELVIEWMATRIX_INVERSE
1146 .. data:: MODELVIEWMATRIX_INVERSETRANSPOSE
1147 .. data:: MODELVIEWMATRIX_TRANSPOSE
1148 .. data:: CAM_POS
1149
1150    Current camera position
1151
1152 .. data:: CONSTANT_TIMER
1153
1154    User a timer for the uniform value.
1155
1156 .. data:: SHD_TANGENT
1157
1158 ------
1159 States
1160 ------
1161
1162 See :class:`bge.types.KX_StateActuator`
1163
1164 .. data:: KX_STATE1
1165 .. data:: KX_STATE2
1166 .. data:: KX_STATE3
1167 .. data:: KX_STATE4
1168 .. data:: KX_STATE5
1169 .. data:: KX_STATE6
1170 .. data:: KX_STATE7
1171 .. data:: KX_STATE8
1172 .. data:: KX_STATE9
1173 .. data:: KX_STATE10
1174 .. data:: KX_STATE11
1175 .. data:: KX_STATE12
1176 .. data:: KX_STATE13
1177 .. data:: KX_STATE14
1178 .. data:: KX_STATE15
1179 .. data:: KX_STATE16
1180 .. data:: KX_STATE17
1181 .. data:: KX_STATE18
1182 .. data:: KX_STATE19
1183 .. data:: KX_STATE20
1184 .. data:: KX_STATE21
1185 .. data:: KX_STATE22
1186 .. data:: KX_STATE23
1187 .. data:: KX_STATE24
1188 .. data:: KX_STATE25
1189 .. data:: KX_STATE26
1190 .. data:: KX_STATE27
1191 .. data:: KX_STATE28
1192 .. data:: KX_STATE29
1193 .. data:: KX_STATE30
1194
1195 .. _state-actuator-operation:
1196
1197 See :class:`bge.types.KX_StateActuator.operation`
1198
1199 .. data:: KX_STATE_OP_CLR
1200
1201    Substract bits to state mask
1202
1203    :value: 0
1204
1205 .. data:: KX_STATE_OP_CPY
1206
1207    Copy state mask
1208
1209    :value: 1
1210    
1211 .. data:: KX_STATE_OP_NEG
1212
1213    Invert bits to state mask
1214
1215    :value: 2
1216
1217 .. data:: KX_STATE_OP_SET
1218
1219    Add bits to state mask
1220
1221    :value: 3
1222
1223 .. _Two-D-FilterActuator-mode: