C4 Engine
C4 Engine API Documentation


Defined in:  C4LightObjects.h
Returns the base type of a light.

LightType GetBaseLightType(voidconst;

All of the light types are divided into two categories, lights that are directional and have infinite range and lights that are localized and have finite range. The GetBaseLightType function returns the base light type, which can only be kLightInfinite or kLightPoint. This represents which general category the light object falls into. The more specific type of light can be determined by calling the LightObject::GetLightType function.

The InfiniteLightObject class has the kLightInfinite base type, and the PointLightObject, CubeLightObject, and SpotLightObject classes have the kLightPoint base type.
See Also