[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [14346] trunk/blender/source/gameengine/ PyDoc/KX_GameObject.py: add KX_GameObject::rayCastTo() PyDoc

[Benoit Bolsee]

Revision: 14346
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=14346
Author:   ben2610
Date:     2008-04-06 22:02:41 +0200 (Sun, 06 Apr 2008)

Log Message:
-----------
add KX_GameObject::rayCastTo() PyDoc

Modified Paths:
--------------
    trunk/blender/source/gameengine/PyDoc/KX_GameObject.py

Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py	2008-04-06 19:48:15 UTC (rev 14345)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py	2008-04-06 20:02:41 UTC (rev 14346)
@@ -164,3 +164,20 @@
 		@type other: L{KX_GameObject} or list [x, y, z]
 		@rtype: float
 		"""
+	def rayCastTo(other,dist,prop):
+		"""
+		Look towards another point/object and find first object hit within dist that matches prop.
+
+		The ray is always casted from the center of the object, ignoring the object itself.
+		The ray is casted towards the center of another object or an explicit [x,y,z] point.
+
+		@param other: [x,y,z] or object towards which the ray is casted
+		@type other: L{KX_GameObject} or string
+		@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
+		@rtype: L{KX_GameObject}
+		@return: the first object hit or None if no object or object does not match prop
+		"""
+	
\ No newline at end of file