setLightAttenuation

From Bohemia Interactive Community
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Sets attenuation of light. Standard method of attenuation (1 / (constant + linear*dist + quadratic*dist*dist)). start param represents distance where the attenuation starts to take effects (dist = distance - start).
Groups:
Lights

Syntax

Syntax:
light setLightAttenuation [start, constant, linear, quadratic, hardlimitstart, hardlimitend]
Parameters:
light: Object
start: Number - distance with 100% intensity, falloff starts here
constant: Number - constant attenuation coef
linear: Number - linear attenuation coef
quadratic: Number - quadratic attenuation coef
hardlimitstart: Number - (Optional) max distance hard limit start (start of fading of intensity to 0) in m
hardlimitend: Number - (Optional) max distance hard limit end (end of fading of intensity to 0) in m
Return Value:
Nothing

Examples

Example 1:
myLight setLightAttenuation [2, 4, 4, 0, 9, 10];

Additional Information

See also:
setLightAmbient setLightColor lightAttachObject lightDetachObject setLightBrightness setLightIntensity setLightUseFlare setLightFlareSize setLightFlareMaxDistance setLightDayLight

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
ffur2007slx2_5
Posted on Mar 25, 2014 - 12:31 (UTC)
(A3 1.14) setLightAttenuation array will present fallowing visual effects:

[start(SCALAR), constant(SCALAR), linear (SCALAR), quadratic(SCALAR)]

start(SCALAR) – Number can be unlimited, this parameter determines the range that the light source takes effect. Terrain environmental color will be bathed by setLightAmbient within the range and its covered objects will reflect the color by setLightColor.

constant(SCALAR) – Support signed number, this parameter determines the brightness proportion of the light source, higher the number is, less the brightness will be, vice versa. Any minus value passed will be treated as 0 (100% brightness). In other words, this parameter is related with setLightBrightness and setLightIntensity.

linear (SCALAR) – Support signed number, effective range is from 0 ~ 100 (passed minus value will be treated as 0), this parameter determines the concentration of the light source, higher the number is, more will the light concentrate, vice versa. In other words, this parameter will turn the source into spotlight and sharpens its light circle border.
Please pay attention to a special value: 4.31918e-005
e.g.
// This value will make the light source reach an ultra high effect range. Any initial param set before will be discarded and overwritten. _light setLightAttenuation [2, 4, 4.31918e-005, 0];

quadratic(SCALAR) – Support signed number (range unlimited, passed minus number will be treated as 0), this parameter determines the range that the light source is visible and its visual presentation looks similar to linear. 0 means the maximum visible range. In further explanation, a less bright source can’t be seen out of the range on the land but still visible on the sea, and a bright enough source won’t be effected by the passed range who is still visible out of the range.
Please pay attention to a special value: 4.31918e-005
e.g.
// This value will make the light source reach an ultra high effect range. Any initial param set before will be discarded and overwritten. _light setLightAttenuation [6, 0, 0, 4.31918e-005];