Regular API function

simGetLightParameters

Description Retrieves various parameters of a light object. See also simSetLightParameters.
C synopsis simInt simGetLightParameters(simInt objectHandle,simFloat* setToNULL,simFloat* diffusePart,simFloat* specularPart)
C parameters
objectHandle: handle of the light
setToNULL: not used, set to NULL
diffusePart: red, green and blue component of the light's diffuse part. Can be NULL
specularPart: red, green and blue component of the light's specular part. Can be NULL
C return value
-1 in case of an error, otherwise bit-coded: for now, only bit 0 is used: 1=light on
Lua synopsis number state,table_3 zero,table_3 diffusePart,table_3 specularPart=simGetLightParameters(number objectHandle)
Lua parameters
objectHandle: handle of the light
Lua return values
state: -1 in case of an error, otherwise bit-coded: for now, only bit 0 is used: 1=light on. See also the boolean operators in Lua.
zero: ignore this value
diffusePart: red, green and blue component of the light's diffuse part
specularPart: red, green and blue component of the light's specular part

All regular API functions on one page