[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [16320] trunk/blender/source/gameengine/ PyDoc: BGE patch 17547 applied in trunk: Cleaned up pydoc for BGE, compiles now error free

Benoit Bolsee benoit.bolsee at online.be
Sun Aug 31 21:07:10 CEST 2008


Revision: 16320
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=16320
Author:   ben2610
Date:     2008-08-31 21:07:10 +0200 (Sun, 31 Aug 2008)

Log Message:
-----------
BGE patch 17547 applied in trunk: Cleaned up pydoc for BGE, compiles now error free

Modified Paths:
--------------
    trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
    trunk/blender/source/gameengine/PyDoc/KX_ObjectActuator.py
    trunk/blender/source/gameengine/PyDoc/KX_PolyProxy.py
    trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py
    trunk/blender/source/gameengine/PyDoc/Rasterizer.py
    trunk/blender/source/gameengine/PyDoc/SCA_DelaySensor.py

Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -30,11 +30,11 @@
 		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 @@
 		@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 @@
 		@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

Modified: trunk/blender/source/gameengine/PyDoc/KX_ObjectActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ObjectActuator.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/KX_ObjectActuator.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -111,9 +111,7 @@
 		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):
 		"""

Modified: trunk/blender/source/gameengine/PyDoc/KX_PolyProxy.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_PolyProxy.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/KX_PolyProxy.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -59,7 +59,7 @@
 		
 		@rtype: integer
 		@return: the material index in the mesh
-	
+		"""
 	def getNumVertex(): 
 		"""
 		Returns the number of vertex of the polygon.

Modified: trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -21,7 +21,7 @@
 		@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.
 		

Modified: trunk/blender/source/gameengine/PyDoc/Rasterizer.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/Rasterizer.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/Rasterizer.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -84,7 +84,8 @@
 	"""
 	Sets the mouse cursor position.
 	
-	@type x, y: integer
+	@type x: integer
+	@type y: integer
 	"""
 
 def setBackgroundColor(rgba):

Modified: trunk/blender/source/gameengine/PyDoc/SCA_DelaySensor.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/SCA_DelaySensor.py	2008-08-31 18:42:58 UTC (rev 16319)
+++ trunk/blender/source/gameengine/PyDoc/SCA_DelaySensor.py	2008-08-31 19:07:10 UTC (rev 16320)
@@ -1,6 +1,6 @@
 # $Id$
 # Documentation for SCA_DelaySensor
-from SCA_IActuator import *
+from SCA_ISensor import *
 
 class SCA_DelaySensor(SCA_ISensor):
 	"""





More information about the Bf-blender-cvs mailing list