SetPlaceableIllumination

From NWN Lexicon
Jump to: navigation, search



SetPlaceableIllumination(object, int)

Sets the illumination for a placeable on or off.

void SetPlaceableIllumination(
    object oPlaceable = OBJECT_SELF,
    int bIlluminate = TRUE
);

Parameters

oPlaceable

The placeable whose illumination will be changed. (Default: OBJECT_SELF)

bIlluminate

If this is TRUE, oPlaceable's illumination will be turned on. If this is FALSE, oPlaceable's illumination will be turned off. (Default: TRUE)


Description

Set the status of the illumination for oPlaceable.



Remarks

You must call RecomputeStaticLighting() after calling this function in order for the changes to occur visually for the players. SetPlaceableIllumination() buffers the illumination changes, which are then sent out to the players once RecomputeStaticLighting() is called. As such, it is best to call SetPlaceableIllumination() for all the placeables you wish to set the illumination on, and then call RecomputeStaticLighting() once after all the placeable illumination has been set.


Known Bugs

Lighting is bugged in NWN, and has been since day one. It appears that it can't be fixed. The bug is that, even turning of a placeable's illumination will still cause a glow around it when the PC is nearby.


Version

1.22

See Also

functions: 

RecomputeStaticLighting



 author: Tom Cassiotis, editor: Lilac Soul