Regular API function

simGetLightParameters / sim.getLightParameters

Description Retrieves various parameters of a light object. See also sim.setLightParameters.
C/C++
synopsis
simInt simGetLightParameters(simInt objectHandle,simFloat* setToNULL,simFloat* diffusePart,simFloat* specularPart)
C/C++
parameters
objectHandle: handle of the light
setToNULL: not used, set to nullptr
diffusePart: red, green and blue component of the light's diffuse part. Can be nullptr
specularPart: red, green and blue component of the light's specular part. Can be nullptr
C/C++
return value
-1 in case of an error, otherwise bit-coded: for now, only bit 0 is used: 1=light on
Lua
synopsis
int state,float[3] zero,float[3] diffusePart,float[3] specularPart=sim.getLightParameters(int objectHandle)
Lua
parameters
objectHandle: handle of the light
Lua
return values
state:bit-coded: for now, only bit 0 is used: 1=light on.
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
Python
synopsis
int state,list zero,list diffusePart,list specularPart=sim.getLightParameters(int objectHandle)