From a5f4d7cb53682a944eee0f10bbae77f3b0465417 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 24 Apr 2009 07:45:17 +0000 Subject: BGE PyAPI epydoc errors fixed --- source/gameengine/PyDoc/GameKeys.py | 4 ++-- source/gameengine/PyDoc/KX_ConstraintActuator.py | 18 +++++++++--------- source/gameengine/PyDoc/KX_GameObject.py | 2 +- source/gameengine/PyDoc/KX_SoundActuator.py | 16 ++++++++-------- source/gameengine/PyDoc/KX_StateActuator.py | 16 ++++++++-------- source/gameengine/PyDoc/Rasterizer.py | 4 ++-- 6 files changed, 30 insertions(+), 30 deletions(-) (limited to 'source/gameengine/PyDoc') diff --git a/source/gameengine/PyDoc/GameKeys.py b/source/gameengine/PyDoc/GameKeys.py index 310f2b0d506..14cd7e4f25c 100644 --- a/source/gameengine/PyDoc/GameKeys.py +++ b/source/gameengine/PyDoc/GameKeys.py @@ -174,8 +174,8 @@ def EventToCharacter(event, shift): @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 """ diff --git a/source/gameengine/PyDoc/KX_ConstraintActuator.py b/source/gameengine/PyDoc/KX_ConstraintActuator.py index a30b859548b..89ca4d80c73 100644 --- a/source/gameengine/PyDoc/KX_ConstraintActuator.py +++ b/source/gameengine/PyDoc/KX_ConstraintActuator.py @@ -19,15 +19,15 @@ class KX_ConstraintActuator(SCA_IActuator): @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. diff --git a/source/gameengine/PyDoc/KX_GameObject.py b/source/gameengine/PyDoc/KX_GameObject.py index abdd4c3eda1..db0aebfc761 100644 --- a/source/gameengine/PyDoc/KX_GameObject.py +++ b/source/gameengine/PyDoc/KX_GameObject.py @@ -110,7 +110,7 @@ class KX_GameObject: # (SCA_IObject) """ 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. """ diff --git a/source/gameengine/PyDoc/KX_SoundActuator.py b/source/gameengine/PyDoc/KX_SoundActuator.py index 37ae3c6640d..0aec57c851c 100644 --- a/source/gameengine/PyDoc/KX_SoundActuator.py +++ b/source/gameengine/PyDoc/KX_SoundActuator.py @@ -36,20 +36,20 @@ class KX_SoundActuator(SCA_IActuator): @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 """ diff --git a/source/gameengine/PyDoc/KX_StateActuator.py b/source/gameengine/PyDoc/KX_StateActuator.py index fe3669d3809..d9785ad13fa 100644 --- a/source/gameengine/PyDoc/KX_StateActuator.py +++ b/source/gameengine/PyDoc/KX_StateActuator.py @@ -9,17 +9,17 @@ class KX_StateActuator(SCA_IActuator): 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): diff --git a/source/gameengine/PyDoc/Rasterizer.py b/source/gameengine/PyDoc/Rasterizer.py index 3a2d6408ac9..fdd53c27898 100644 --- a/source/gameengine/PyDoc/Rasterizer.py +++ b/source/gameengine/PyDoc/Rasterizer.py @@ -82,8 +82,8 @@ def getScreenRay(x, y, dist, property): @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 """ -- cgit v1.2.3