Game Python Reference Manual.

This manual lists all the Python classes and modules for Game Objects, Sensor bricks, Controllers etc.
Missing: Actuator & Controller reference.

1 files changed, 25 insertions, 0 deletions

diff --git a/source/gameengine/PyDoc/KX_MouseFocusSensor.py b/source/gameengine/PyDoc/KX_MouseFocusSensor.py
new file mode 100644
index 00000000000..9e0d523725b
--- /dev/null
+++ b/source/gameengine/PyDoc/KX_MouseFocusSensor.py
@@ -0,0 +1,25 @@
+# Documentation for KX_MouseFocusSensor
+from SCA_MouseSensor import *
+
+class KX_MouseFocusSensor(SCA_MouseSensor):
+	"""
+	The mouse focus sensor detects when the mouse is over the current game object.
+	
+	The mouse focus sensor works by transforming the mouse coordinates from 2d device
+	space to 3d space then raycasting away from the camera.
+	"""
+	
+	def GetRayTarget():
+		"""
+		Returns the end point of the sensor ray.
+		
+		@rtype: list [x, y, z]
+		@return: the end point of the sensor ray, in world coordinates.
+		"""
+	def GetRaySource():
+		"""
+		Returns the start point of the sensor ray.
+		
+		@rtype: list [x, y, z]
+		@return: the start point of the sensor ray, in world coordinates.
+		"""