KX_RaySensor(SCA_ISensor)¶

base class — SCA_ISensor

class KX_RaySensor(SCA_ISensor)¶

A ray sensor detects the first object in a given direction.

propName¶

The property the ray is looking for.

Type: string

range¶

The distance of the ray.

Type: float

useMaterial¶

Whether or not to look for a material (false = property).

Type: boolean

useXRay¶

Whether or not to use XRay.

Type: boolean

mask¶

The collision mask (16 layers mapped to a 16-bit integer) combined with each object’s collision group, to hit only a subset of the objects in the scene. Only those objects for which collisionGroup & mask is true can be hit.

Type: bitfield

hitObject¶

The game object that was hit by the ray. (read-only).

Type: KX_GameObject

hitPosition¶

The position (in worldcoordinates) where the object was hit by the ray. (read-only).

Type: list [x, y, z]

hitNormal¶

The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (read-only).

Type: list [x, y, z]

hitMaterial¶

The material of the object in the face hit by the ray. (read-only).

Type: string

rayDirection¶

The direction from the ray (in worldcoordinates). (read-only).

Type: list [x, y, z]

axis¶

The axis the ray is pointing on. Can be one of these constants.

Type: integer from 0 to 5