getLightingAt: Difference between revisions

Revision as of 12:50, 4 May 2022

Hover & click on the images for description

Description:: Gets provided object's lighting information.
ⓘ
The command will use local player's night vision state to determine whether to include IR lights in the result or not.
On a dedicated server, headless client or if the player is null, the night vision state will always be off.
Groups:: Lights

Syntax:

getLightingAt obj

Parameters:

obj: Object

Return Value:

Array in format [ambientLightColor, ambientLightBrightness, dynamicLightColor, dynamicLightBrightness]:

Example 1:: getLightingAt player; // returns [[1,1,1], 0.5, [0,0,0], 0]
Example 2:: getLightingAt player params ["_ambientLightColour", "_ambientLightBrightness", "_dynamicLightColour", "_dynamicLightBrightness"];

: 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

@@ Line 8: / Line 8: @@
 |descr= Gets provided object's lighting information.
 {{Feature|informative|The command will use [[local]] [[player]]'s night vision state to determine whether to include IR lights in the result or not.<br>
-On a dedicated server<!-- (or anywhere where [[player]] [[isNull|is null]] or without [[hasInterface|interface]])-->, the night vision state will always be off.}}
+On a dedicated server, [[Arma 3: Headless Client|headless client]] or if the player is [[objNull|null]], the night vision state will always be off.}}
 |s1= [[getLightingAt]] obj
@@ Line 20: / Line 20: @@
 * dynamiclightBrightness: [[Number]]
-|x1= <code>[[getLightingAt]] [[player]]; {{cc|returns [<nowiki/>[1,1,1], 0.5, [0,0,0], 0]}}</code>
+|x1= <sqf>getLightingAt player; // returns [[1,1,1], 0.5, [0,0,0], 0]</sqf>
+|x2= <sqf>getLightingAt player params ["_ambientLightColour", "_ambientLightBrightness", "_dynamicLightColour", "_dynamicLightBrightness"];</sqf>
 |seealso= [[getLighting]] [[Lightpoint Tutorial]]
 }}