Revision: 19544
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=19544
Author: campbellbarton
Date: 2009-04-05 12:03:23 +0200 (Sun, 05 Apr 2009)
Log Message:
-----------
- fixed errors with bge epydocs
- changed epy_docgen.sh so inherited attributes & methods are included inline
for each type, removed source option since its not useful and makes the
download bigger.
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py
trunk/blender/source/gameengine/PyDoc/BL_ShapeActionActuator.py
trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py
trunk/blender/source/gameengine/PyDoc/KX_CDActuator.py
trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
trunk/blender/source/gameengine/PyDoc/KX_ParentActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
trunk/blender/source/gameengine/PyDoc/KX_Scene.py
trunk/blender/source/gameengine/PyDoc/KX_SceneActuator.py
trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py
trunk/blender/source/gameengine/PyDoc/KX_VisibilityActuator.py
trunk/blender/source/gameengine/PyDoc/SCA_JoystickSensor.py
trunk/blender/source/gameengine/PyDoc/epy_docgen.sh
Modified: trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py 2009-04-05
08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py 2009-04-05
10:03:23 UTC (rev 19544)
@@ -1,7 +1,9 @@
# $Id$
# Documentation for BL_ActionActuator
+import SCA_ILogicBrick
from SCA_IActuator import *
+
class BL_ActionActuator(SCA_IActuator):
"""
Action Actuators apply an action to an actor.
@@ -10,7 +12,7 @@
@type action: string
@ivar start: Specifies the starting frame of the animation.
@type start: float
- @type end: Specifies the ending frame of the animation.
+ @ivar end: Specifies the ending frame of the animation.
@type end: float
@ivar blendin: Specifies the number of frames of animation to generate
when making transitions between actions.
@type blendin: float
@@ -25,9 +27,7 @@
@ivar blendTime: Sets the internal frame timer. This property must be in
the range from 0.0 to blendin.
@type blendTime: float
- @ivar type: The operation mode of the actuator.
- KX_ACTIONACT_PLAY,
KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER,
- KX_ACTIONACT_LOOPSTOP,
KX_ACTIONACT_LOOPEND
+ @ivar type: The operation mode of the actuator. KX_ACTIONACT_PLAY,
KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP,
KX_ACTIONACT_LOOPEND
@type type: integer
@ivar continue: The actions continue option, True or False.
When True, the action will always play
from where last left off,
Modified: trunk/blender/source/gameengine/PyDoc/BL_ShapeActionActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_ShapeActionActuator.py
2009-04-05 08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/BL_ShapeActionActuator.py
2009-04-05 10:03:23 UTC (rev 19544)
@@ -1,6 +1,7 @@
# $Id$
# Documentation for BL_ShapeActionActuator
from SCA_IActuator import *
+from SCA_ILogicBrick import *
class BL_ShapeActionActuator(SCA_IActuator):
"""
@@ -10,7 +11,7 @@
@type action: string
@ivar start: Specifies the starting frame of the shape animation.
@type start: float
- @type end: Specifies the ending frame of the shape animation.
+ @ivar end: Specifies the ending frame of the shape animation.
@type end: float
@ivar blendin: Specifies the number of frames of animation to generate
when making transitions between actions.
@type blendin: float
Modified: trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py 2009-04-05
08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py 2009-04-05
10:03:23 UTC (rev 19544)
@@ -2,6 +2,7 @@
# Documentation for KX_ActuatorSensor
from SCA_IActuator import *
from SCA_ISensor import *
+from SCA_ILogicBrick import *
class KX_ActuatorSensor(SCA_ISensor):
"""
Modified: trunk/blender/source/gameengine/PyDoc/KX_CDActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_CDActuator.py 2009-04-05
08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/KX_CDActuator.py 2009-04-05
10:03:23 UTC (rev 19544)
@@ -3,13 +3,15 @@
from SCA_IActuator import *
class KX_CDActuator(SCA_IActuator):
- """
- CD Controller actuator.
- @ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 =
max volume.
- @type volume: float
- @ivar track: the track selected to be played
- @type track: integer
- """
+ """
+ CD Controller actuator.
+ @ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 =
max volume.
+ @type volume: float
+ @ivar track: the track selected to be played
+ @type track: integer
+ @ivar gain: the gain (volume) of the CD between 0.0 and 1.0.
+ @type gain: float
+ """
def startCD():
"""
Starts the CD playing.
@@ -26,17 +28,17 @@
"""
Resumes the CD after a pause.
"""
- def playAll():
- """
- Plays the CD from the beginning.
- """
- def playTrack(trackNumber):
- """
- Plays the track selected.
- """
+ def playAll():
+ """
+ Plays the CD from the beginning.
+ """
+ def playTrack(trackNumber):
+ """
+ Plays the track selected.
+ """
def setGain(gain):
"""
- DEPRECATED: Use the volume property.
+ DEPRECATED: Use the volume property.
Sets the gain (volume) of the CD.
@type gain: float
@@ -44,7 +46,7 @@
"""
def getGain():
"""
- DEPRECATED: Use the volume property.
+ DEPRECATED: Use the volume property.
Gets the current gain (volume) of the CD.
@rtype: float
Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-05
08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-05
10:03:23 UTC (rev 19544)
@@ -2,9 +2,9 @@
# Documentation for game objects
# from SCA_IObject import *
-from SCA_ISensor import *
-from SCA_IController import *
-from SCA_IActuator import *
+# from SCA_ISensor import *
+# from SCA_IController import *
+# from SCA_IActuator import *
class KX_GameObject: # (SCA_IObject)
@@ -12,19 +12,20 @@
All game objects are derived from this class.
Properties assigned to game objects are accessible as attributes of
this class.
-
+
@ivar name: The object's name. (Read only)
+ - note: Currently (Blender 2.49) the prefix "OB" is added to
all objects name. This may change in blender 2.5.
@type name: string.
@ivar mass: The object's mass (provided the object has a physics
controller). Read only.
@type mass: float
@ivar parent: The object's parent object. (Read only)
- @type parent: L{KX_GameObject}
+ @type parent: L{KX_GameObject} or None
@ivar visible: visibility flag.
+ - note: Game logic will still run for invisible objects.
@type visible: boolean
@ivar position: The object's position.
@type position: list [x, y, z]
- @ivar orientation: The object's orientation. 3x3 Matrix.
- You can also write a Quaternion or Euler vector.
+ @ivar orientation: The object's orientation. 3x3 Matrix. You can also
write a Quaternion or Euler vector.
@type orientation: 3x3 Matrix [[float]]
@ivar scaling: The object's scaling factor. list [sx, sy, sz]
@type scaling: list [sx, sy, sz]
@@ -33,21 +34,21 @@
@ivar state: the game object's state bitmask.
@type state: int
@ivar meshes: a list meshes for this object.
- B{Note}: Most objects use only 1 mesh.
- B{Note}: Changes to this list will not update the KX_GameObject.
+ - note: Most objects use only 1 mesh.
+ - note: Changes to this list will not update the KX_GameObject.
@type meshes: list of L{KX_MeshProxy}
@ivar sensors: a list of L{SCA_ISensor} objects.
- B{Note}: This attribute is experemental and may be removed (but
probably wont be).
- B{Note}: Changes to this list will not update the KX_GameObject
- @type sensors: list of L{SCA_ISensor}
- @ivar controllers: a list of L{SCA_ISensor} objects.
- B{Note}: This attribute is experemental and may be removed (but
probably wont be).
- B{Note}: Changes to this list will not update the KX_GameObject
- @type controllers: list of L{SCA_IController}
- @ivar the actuators assigned to this object.
- B{Note}: This attribute is experemental and may be removed (but
probably wont be).
- B{Note}: Changes to this list will not update the KX_GameObject
- @type actuators: a list of L{SCA_IActuator}
+ - note: This attribute is experemental and may be removed (but
probably wont be).
+ - note: Changes to this list will not update the KX_GameObject.
+ @type sensors: list
+ @ivar controllers: a list of L{SCA_IController} objects.
+ - note: This attribute is experemental and may be removed (but
probably wont be).
+ - note: Changes to this list will not update the KX_GameObject.
+ @type controllers: list of L{SCA_ISensor}.
+ @ivar actuators: a list of L{SCA_IActuator} objects.
+ - note: This attribute is experemental and may be removed (but
probably wont be).
+ - note: Changes to this list will not update the KX_GameObject.
+ @type actuators: list
"""
def endObject(visible):
"""
@@ -159,7 +160,7 @@
@param local: - False: you get the "global" movement ie:
relative to world orientation (default).
- True: you get the "local" movement ie: relative
to object orientation.
"""
- def applyRotation(movement, local = 0):
+ def applyRotation(rotation, local = 0):
"""
Sets the game object's rotation.
Modified: trunk/blender/source/gameengine/PyDoc/KX_ParentActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ParentActuator.py 2009-04-05
08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/KX_ParentActuator.py 2009-04-05
10:03:23 UTC (rev 19544)
@@ -10,7 +10,7 @@
"""
def setObject(object):
"""
- DEPRECATED: Use the object property.
+ DEPRECATED: Use the object property.
Sets the object to set as parent.
Object can be either a L{KX_GameObject} or the name of the
object.
@@ -19,7 +19,7 @@
"""
def getObject(name_only = 1):
"""
- DEPRECATED: Use the object property.
+ DEPRECATED: Use the object property.
Returns the name of the object to change to.
@type name_only: bool
@param name_only: optional argument, when 0 return a
KX_GameObject
Modified: trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
2009-04-05 08:48:51 UTC (rev 19543)
+++ trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
2009-04-05 10:03:23 UTC (rev 19544)
@@ -5,26 +5,26 @@
class KX_SCA_DynamicActuator(SCA_IActuator):
"""
Dynamic Actuator.
- @ivar operation: the type of operation of the actuator, 0-4
- KX_DYN_RESTORE_DYNAMICS, KX_DYN_DISABLE_DYNAMICS,
- KX_DYN_ENABLE_RIGID_BODY, KX_DYN_DISABLE_RIGID_BODY,
KX_DYN_SET_MASS
- @type operation: integer
- @ivar mass: the mass value for the KX_DYN_SET_MASS operation
- @type mass: float
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
Bf-blender-cvs@blender.org
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
