getLightInfo

Arma 3 v2.22

Command · Markdown · JSON · original wiki page

Description

Returns various properties for the given #lightpoint or #lightreflector. ConePars and VolumeShapePars are exclusive properties of #lightreflector only.

Syntax

Syntax 1

getLightInfo light

Parameters:

light: Object - #lightpoint or #lightreflector

Returns: Array with [intensity, diffuseColor, ambientColor, dayLight, IR, useFlare, flareSize, flareMaxDistance, attenuationPars, attachedToPars, conePars, volumeShapePars]

0 - intensity: Number - getter for setLightIntensity (setLightBrightness also sets intensity in a weird way, but it is also obsolete)
1 - diffuseColor: Color - getter for setLightColor
2 - ambientColor: Color - getter for setLightAmbient
3 - dayLight: Boolean - getter for setLightDayLight
4 - IR: Boolean - getter for setLightIR
5 - useFlare: Boolean - getter for setLightUseFlare
6 - flareSize: Number - getter for setLightFlareSize
7 - flareMaxDistance: Number - getter for setLightFlareMaxDistance
8 - attenuationPars: Array - getter for setLightAttenuation
9 - attachedToPars: Array - getter for lightAttachObject, lightDetachObject
10 - conePars: Array - getter for setLightConePars
11 - volumeShapePars: Array - getter for setLightVolumeShape

Syntax 2

light getLightInfo index

Parameters:

light: Object - #lightpoint or #lightreflector
index: Number - property index (see main syntax, for example 0 for light intensity)

Returns: Anything - depends on the requested property, or Nothing

Examples

Example 1

private _lightInfo = getLightInfo light1;

Example 2

private _lightIntensity = light1 getLightInfo 0;