[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [19916] trunk/blender/source/gameengine/ PyDoc: BGE PyAPI epydoc errors fixed
Campbell Barton
ideasman42 at gmail.com
Fri Apr 24 09:45:18 CEST 2009
Revision: 19916
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=19916
Author: campbellbarton
Date: 2009-04-24 09:45:17 +0200 (Fri, 24 Apr 2009)
Log Message:
-----------
BGE PyAPI epydoc errors fixed
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/GameKeys.py
trunk/blender/source/gameengine/PyDoc/KX_ConstraintActuator.py
trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
trunk/blender/source/gameengine/PyDoc/KX_SoundActuator.py
trunk/blender/source/gameengine/PyDoc/KX_StateActuator.py
trunk/blender/source/gameengine/PyDoc/Rasterizer.py
Modified: trunk/blender/source/gameengine/PyDoc/GameKeys.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameKeys.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/GameKeys.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -174,8 +174,8 @@
@type event: int
@param event: key event from GameKeys or the keyboard sensor.
- @type event: bool
- @param event: set to true if shift is held.
+ @type shift: bool
+ @param shift: set to true if shift is held.
@rtype: string
"""
Modified: trunk/blender/source/gameengine/PyDoc/KX_ConstraintActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ConstraintActuator.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/KX_ConstraintActuator.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -19,15 +19,15 @@
@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
+ 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.
Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -110,7 +110,7 @@
"""
Sets the game object's occlusion capability.
- @type visible: boolean
+ @type occlusion: boolean
@type recursive: boolean
@param recursive: optional argument to set all childrens occlusion flag too.
"""
Modified: trunk/blender/source/gameengine/PyDoc/KX_SoundActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_SoundActuator.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/KX_SoundActuator.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -36,20 +36,20 @@
@type orientation: 3x3 matrix [[float]]
@ivar type: Sets the operation mode of the actuator. You can use one of the following constant:
- 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)
+ - 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 type: integer
- @group Play Methods: startSound, pauseSound, stopSound.
+ @group Play Methods: startSound, pauseSound, stopSound
"""
def setFilename(filename):
"""
DEPRECATED: Use the filename property instead.
- Sets the filename of the sound this actuator plays.
+ Sets the filename of the sound this actuator plays.
@type filename: string
"""
Modified: trunk/blender/source/gameengine/PyDoc/KX_StateActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_StateActuator.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/KX_StateActuator.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -9,17 +9,17 @@
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
+ 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
+ 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):
Modified: trunk/blender/source/gameengine/PyDoc/Rasterizer.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/Rasterizer.py 2009-04-24 01:27:17 UTC (rev 19915)
+++ trunk/blender/source/gameengine/PyDoc/Rasterizer.py 2009-04-24 07:45:17 UTC (rev 19916)
@@ -82,8 +82,8 @@
@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 prop: property name that object must have; can be omitted => detect any object
- @type prop: string
+ @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
"""
More information about the Bf-blender-cvs
mailing list