Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / GameLogic.py
1 """
2 Documentation for the GameLogic Module.
3
4 Constants:
5         KX_TRUE:  True value used by some modules
6         KX_FALSE: False value used by some modules.
7
8 Property Sensor:
9         Tests that the property sensor is able to perform.
10         KX_PROPSENSOR_EQUAL:            Activate when the property is equal to the sensor value.
11         KX_PROPSENSOR_NOTEQUAL          Activate when the property is not equal to the sensor value.
12         KX_PROPSENSOR_INTERVAL          Activate when the property is between the specified limits.
13         KX_PROPSENSOR_CHANGED           Activate when the property changes
14         KX_PROPSENSOR_EXPRESSION        Activate when the expression matches
15
16 Constraint Actuator:
17         The axis and type (location/rotation) of constraint
18         KX_CONSTRAINTACT_LOCX
19         KX_CONSTRAINTACT_LOCY
20         KX_CONSTRAINTACT_LOCZ
21         KX_CONSTRAINTACT_ROTX
22         KX_CONSTRAINTACT_ROTY
23         KX_CONSTRAINTACT_ROTZ
24
25 IPO Actuator:
26         IPO Types
27         KX_IPOACT_PLAY
28         KX_IPOACT_PINGPONG
29         KX_IPOACT_FLIPPER
30         KX_IPOACT_LOOPSTOP
31         KX_IPOACT_LOOPEND
32
33 Random distributions:
34         KX_RANDOMACT_BOOL_CONST
35         KX_RANDOMACT_BOOL_UNIFORM
36         KX_RANDOMACT_BOOL_BERNOUILLI
37         KX_RANDOMACT_INT_CONST
38         KX_RANDOMACT_INT_UNIFORM
39         KX_RANDOMACT_INT_POISSON
40         KX_RANDOMACT_FLOAT_CONST
41         KX_RANDOMACT_FLOAT_UNIFORM
42         KX_RANDOMACT_FLOAT_NORMAL
43         KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
44
45 """
46
47
48 def getCurrentController():
49         """
50         Gets the Python controller associated with this Python script.
51         
52         @rtype: SCA_PythonController
53         """
54 def addActiveActuator(actuator, activate):
55         """
56         Activates the given actuator.
57         
58         @type actuator: SCA_IActuator
59         @type activate: boolean
60         @param activate: whether to activate or deactivate the given actuator.
61         """
62 def getRandomFloat():
63         """
64         Returns a random floating point value in the range [0...1)
65         """
66 def setGravity(gravity):
67         """
68         Sets the world gravity.
69         
70         @type gravity: list [fx, fy, fz]
71         """
72 def getSpectrum():
73         """
74         Returns a 512 point list from the sound card.
75         This only works if the fmod sound driver is being used.
76         
77         @rtype: list [float], len(getSpectrum()) == 512
78         """
79 def stopDSP():
80         """
81         Stops the sound driver using DSP effects.
82         
83         Only the fmod sound driver supports this.
84         DSP can be computationally expensive.
85         """