formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager

# fz_lite_grup_get_parm

Description

Gets a light group's parameter. For the parameters FZ_LITE_GROUP_PARM_VISIBILITY
FZ_LITE_GROUP_PARM_LOCKED_ON
FZ_LITE_GROUP_PARM_SHINING_ON
FZ_LITE_GROUP_PARM_SHADOWS_ON
if the return value is -1, the status of the lights in the group is not the same. For example, if there are 3 lights in a group with two lights which have visibility on and one light with visibility off, the FZ_LITE_GROUP_PARM_VISIBILITY parameter will be returned as -1.

Plugin Prototype

fzrt_error_td fz_lite_grup_get_parm(

fzrt_int | windex,
fz_tag_td * | group_tag,
fz_lite_parm_grup_enum | which,
fz_type_td * | data )

Parameters

windex [Input]

project window index

group_tag [Input]

light group tag

which [Input]

parameter identifier

data [Result]

parameter data

Returns

Error codes

Availability

5.0.0.0

Example Files

util_lights.fsl

See Also

fz_lite_grup_set_parm

Function Set

fz_lite_fset

Defined in

fz_lite_api.h