Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / KX_RaySensor.py
1 # Documentation for KX_RaySensor
2 from SCA_ISensor import *
3
4 class KX_RaySensor(SCA_ISensor):
5         """
6         A ray sensor detects the first object in a given direction.
7         """
8         
9         def getHitObject():
10                 """
11                 Returns the game object that was hit by this ray.
12                 
13                 @rtype: KX_GameObject
14                 """
15         def getHitPosition():
16                 """
17                 Returns the position (in worldcoordinates) where the object was hit by this ray.
18                 
19                 @rtype: list [x, y, z]
20                 """
21         def getHitNormal():
22                 """
23                 Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
24                 
25                 @rtype: list [nx, ny, nz]
26                 """
27         def getRayDirection():
28                 """
29                 Returns the direction from the ray (in worldcoordinates)
30                 
31                 @rtype: list [dx, dy, dz]
32                 """