C4 Engine Terathon Software C4 Engine API Documentation

• Graphics Manager

API Links
Developer Links

LightObject::SetLightFlags

Defined in:  C4LightObjects.h
Sets the light flags.
Prototype

void SetLightFlags(unsigned long flags);

Parameters
flags The new light flags.
Description
The SetLightFlags function sets the light flags to the value specified by the flags parameter, which can be a combination (through logical OR) of the following values.
kLightStatic Light is static (does not move).
kLightShadowInhibit Light does not cast shadows.
kLightGenerator Light generates a projected shadow.
kLightExternalZone The light's position may temporarily be outside its owning zone.
kLightConfined The light is confined to a small sphere (point light only).
kLightInstanceShadowSpace The light should use the shadow space connected by an instance super node.
The kLightGenerator flag only pertains to depth lights, cube lights, and spot lights. It indicates that a projected texture should be generated for a light during the development process.

The kLightExternalZone flag should be set when the light source is a subnode of another node that may be in a different zone. When this flag is set, the light node will independently determine which zone it's in instead of using the owning zone in the node hierarchy.
See Also

LightObject::GetLightFlags