diff options
| author | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-05-31 17:06:04 +0400 |
|---|---|---|
| committer | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-05-31 17:06:04 +0400 |
| commit | 0dfc3a3b785ca5ed39a48e0d62a0c472167c5506 (patch) | |
| tree | 05c0ab514628172d637c4b6c0be311d00144106a /source/gameengine/PyDoc/GameLogic.py | |
| parent | 4f457fa277754a0c34f07bfa02acad00bfb50731 (diff) | |
Use epydoc for generating game python reference (like the bpython guys)
Diffstat (limited to 'source/gameengine/PyDoc/GameLogic.py')
| -rw-r--r-- | source/gameengine/PyDoc/GameLogic.py | 71 |
1 files changed, 38 insertions, 33 deletions
diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py index 05dfd0cd481..20621fae659 100644 --- a/source/gameengine/PyDoc/GameLogic.py +++ b/source/gameengine/PyDoc/GameLogic.py @@ -2,46 +2,51 @@ """ Documentation for the GameLogic Module. -Constants: - KX_TRUE: True value used by some modules - KX_FALSE: False value used by some modules. +Constants +========= + - KX_TRUE: True value used by some modules + - KX_FALSE: False value used by some modules. -Property Sensor: +Property Sensor +--------------- Tests that the property sensor is able to perform. - KX_PROPSENSOR_EQUAL: Activate when the property is equal to the sensor value. - KX_PROPSENSOR_NOTEQUAL Activate when the property is not equal to the sensor value. - KX_PROPSENSOR_INTERVAL Activate when the property is between the specified limits. - KX_PROPSENSOR_CHANGED Activate when the property changes - KX_PROPSENSOR_EXPRESSION Activate when the expression matches + - KX_PROPSENSOR_EQUAL: Activate when the property is equal to the sensor value. + - KX_PROPSENSOR_NOTEQUAL Activate when the property is not equal to the sensor value. + - KX_PROPSENSOR_INTERVAL Activate when the property is between the specified limits. + - KX_PROPSENSOR_CHANGED Activate when the property changes + - KX_PROPSENSOR_EXPRESSION Activate when the expression matches -Constraint Actuator: +Constraint Actuator +------------------- The axis and type (location/rotation) of constraint - KX_CONSTRAINTACT_LOCX - KX_CONSTRAINTACT_LOCY - KX_CONSTRAINTACT_LOCZ - KX_CONSTRAINTACT_ROTX - KX_CONSTRAINTACT_ROTY - KX_CONSTRAINTACT_ROTZ + - KX_CONSTRAINTACT_LOCX + - KX_CONSTRAINTACT_LOCY + - KX_CONSTRAINTACT_LOCZ + - KX_CONSTRAINTACT_ROTX + - KX_CONSTRAINTACT_ROTY + - KX_CONSTRAINTACT_ROTZ -IPO Actuator: +IPO Actuator +------------ IPO Types - KX_IPOACT_PLAY - KX_IPOACT_PINGPONG - KX_IPOACT_FLIPPER - KX_IPOACT_LOOPSTOP - KX_IPOACT_LOOPEND + - KX_IPOACT_PLAY + - KX_IPOACT_PINGPONG + - KX_IPOACT_FLIPPER + - KX_IPOACT_LOOPSTOP + - KX_IPOACT_LOOPEND -Random distributions: - 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 +Random Distributions +-------------------- + - 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 """ |