diff options
author | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-05-24 11:49:50 +0400 |
---|---|---|
committer | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-05-24 11:49:50 +0400 |
commit | a96955efc2c8ecc4de7b42ea717c3e287dad05cb (patch) | |
tree | 4154dc0f6850d1e942dbae8647966fb49ff17cd5 /source/gameengine/PyDoc/KX_MouseFocusSensor.py | |
parent | 86899e7a22a3143ff8ecf2f3a7d65104ac6fa0b8 (diff) |
Game Python Reference Manual.
This manual lists all the Python classes and modules for Game Objects, Sensor bricks, Controllers etc.
Missing: Actuator & Controller reference.
Diffstat (limited to 'source/gameengine/PyDoc/KX_MouseFocusSensor.py')
-rw-r--r-- | source/gameengine/PyDoc/KX_MouseFocusSensor.py | 25 |
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. + """ |