formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Gets one of the common parameters of a light.
Note: not all common parameters are used by all lights.
In this case the parameter is still returned, but has no
effect on the behavior of the light.
If the display parameter is TRUE, the parameter value returned
reflects the light parameters as used when a scene is displayed.
That is, if the light is in a light group and the group's
override option is on for that parameter, the override
parameter is returned.
If the display parameter is FALSE, the true parameter of the light
is returned.
Not all parameters of a light have an equivalent override
parameter in the light group.
In that case, the true parameter of the light is always returned,
regardless of the display parameter.
This function is now obsolete. Use and instead.
Plugin Prototype
fzrt_error_td fz_lite_get_parm_common_obsolete(
fzrt_int | windex, |
lite, | |
which, | |
display, | |
data ) |
Parameters
windex [Input]
project window index
lite [Input]
light
which [Input]
parameter identifier
display [Input]
if TRUE, the display parameter is returned, otherwise the true parameter is returned
data [Result]
parameter data
Returns
Error codes
Availability
5.0.0.0
Example Files
See Also
fz_lite_set_parm_common
Function Set
Defined in