BGE patch 17547 applied in trunk: Cleaned up pydoc for BGE, compiles now error free
authorBenoit Bolsee <benoit.bolsee@online.be>
Sun, 31 Aug 2008 19:07:10 +0000 (19:07 +0000)
committerBenoit Bolsee <benoit.bolsee@online.be>
Sun, 31 Aug 2008 19:07:10 +0000 (19:07 +0000)
source/gameengine/PyDoc/KX_GameObject.py
source/gameengine/PyDoc/KX_ObjectActuator.py
source/gameengine/PyDoc/KX_PolyProxy.py
source/gameengine/PyDoc/KX_TrackToActuator.py
source/gameengine/PyDoc/Rasterizer.py
source/gameengine/PyDoc/SCA_DelaySensor.py

index 2136ce54e307155b7e514e005b57cc22b0d1b5aa..916851fa2a2bf82be38a2170feeeb59d9793a0b5 100644 (file)
@@ -30,11 +30,11 @@ class KX_GameObject:
                Delete this object, can be used inpace of the EndObject Actuator.
                The actual removal of the object from the scene is delayed.
                """     
-       def getVisible(visible):
+       def getVisible():
                """
                Gets the game object's visible flag.
                
-               @type visible: boolean
+               @rtype: boolean
                """     
        def setVisible(visible):
                """
@@ -49,12 +49,12 @@ class KX_GameObject:
                @rtype: int
                @return: the objects state.
                """     
-       def setState():
+       def setState(state):
                """
-               Sets the game object's visible flag.
+               Sets the game object's state flag.
                The bitmasks for states from 1 to 30 can be set with (1<<0, 1<<1, 1<<2 ... 1<<29)
                
-               @type visible: boolean
+               @type state: integer
                """
        def setPosition(pos):
                """
@@ -342,7 +342,7 @@ class KX_GameObject:
                @param poly: polygon option: 1=>return value is a 4-tuple and the 4th element is a L{KX_PolyProxy}
                @type poly: int
                @rtype:    3-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz))
-                       or 4-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), L{KX_PolyProxy))
+                       or 4-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), L{KX_PolyProxy})
                @return: (object,hitpoint,hitnormal) or (object,hitpoint,hitnormal,polygon)
                         If no hit, returns (None,None,None) or (None,None,None,None)
                         If the object hit is not a static mesh, polygon is None
index db577d21e6ff6f0fb1f76088b5648d8e4dc27456..b7b76473292dec23771585400a7d729bed793cfc 100644 (file)
@@ -111,9 +111,7 @@ class KX_ObjectActuator(SCA_IActuator):
                For the servo control actuator, this is the target speed.
                
                @rtype: list [vx, vy, vz, local]
-               @return: A four item list, containing the vector velocity, and whether
-                        the velocity is applied in local coordinates (True) or world
-                            coordinates (False)
+               @return: A four item list, containing the vector velocity, and whether the velocity is applied in local coordinates (True) or world coordinates (False)
                """
        def setLinearVelocity(vx, vy, vz, local):
                """
index 45ae30a13dd389d5994526a6a135e971afb2212b..bcd42c2ac2e5a7616e531787d5b98725ae91f473 100644 (file)
@@ -59,7 +59,7 @@ class KX_PolyProxy:
                
                @rtype: integer
                @return: the material index in the mesh
-       
+               """
        def getNumVertex(): 
                """
                Returns the number of vertex of the polygon.
index 2ecd94f38ae52cf052de2e8855c75280e27c20f5..948302991b7ae5e7879397f1464f118bf236c4db 100644 (file)
@@ -21,7 +21,7 @@ class KX_TrackToActuator(SCA_IActuator):
                @type object: L{KX_GameObject}, string or None
                @param object: Either a reference to a game object or the name of the object to track.
                """
-       def getObject():
+       def getObject(name_only):
                """
                Returns the name of the object to track.
                
index f0e48b6ed43a573d4fa64fb17baa78c1ca76e366..3711ac63b3ebd554a49377973621e9b8b963f27a 100644 (file)
@@ -84,7 +84,8 @@ def setMousePosition(x, y):
        """
        Sets the mouse cursor position.
        
-       @type x, y: integer
+       @type x: integer
+       @type y: integer
        """
 
 def setBackgroundColor(rgba):
index 46b74f461a7e2f841635685fa62a77a8b5198c07..19df589ea7b1789b5777d0caead6d5e8e846b9cf 100644 (file)
@@ -1,6 +1,6 @@
 # $Id$
 # Documentation for SCA_DelaySensor
-from SCA_IActuator import *
+from SCA_ISensor import *
 
 class SCA_DelaySensor(SCA_ISensor):
        """