getLightingAt: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix camelCase) |
Lou Montana (talk | contribs) m (Text replacement - "Lightpoint Tutorial" to "Light Source Tutorial") |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
|game1= | |game1= arma3 | ||
|version1= 2.00 | |||
| | |gr1= Lights | ||
|descr= Gets provided object's lighting information. | |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, [[Arma 3: Headless Client|headless client]] or if the player is [[objNull|null]], the night vision state will always be off.}} | |||
|s1= [[getLightingAt]] obj | |s1= [[getLightingAt]] obj | ||
| Line 11: | Line 14: | ||
|p1= obj: [[Object]] | |p1= obj: [[Object]] | ||
|r1= [[Array]] | |r1= [[Array]] in format [ambientLightColor, ambientLightBrightness, dynamicLightColor, dynamicLightBrightness]: | ||
* ambientLightColor: [[Color|Color RGB]] | * ambientLightColor: [[Array]] in format [[Color|Color (RGB)]] | ||
* ambientLightBrightness: [[Number]] | * ambientLightBrightness: [[Number]] | ||
* dynamicLightColor: [[Color]] | * dynamicLightColor: [[Array]] in format [[Color|Color (RGB)]] | ||
* dynamiclightBrightness: [[Number]] | * dynamiclightBrightness: [[Number]] | ||
|x1= < | |x1= <sqf>getLightingAt player; // returns [[1,1,1], 0.5, [0,0,0], 0]</sqf> | ||
|seealso= [[getLighting]] [[ | |x2= <sqf>getLightingAt player params ["_ambientLightColour", "_ambientLightBrightness", "_dynamicLightColour", "_dynamicLightBrightness"];</sqf> | ||
|seealso= [[getLighting]] [[Light Source Tutorial]] | |||
}} | }} | ||
Latest revision as of 14:28, 27 April 2023
Description
- Description:
- Gets provided object's lighting information.
- Groups:
- Lights
Syntax
- Syntax:
- getLightingAt obj
- Parameters:
- obj: Object
- Return Value:
- Array in format [ambientLightColor, ambientLightBrightness, dynamicLightColor, dynamicLightBrightness]:
- ambientLightColor: Array in format Color (RGB)
- ambientLightBrightness: Number
- dynamicLightColor: Array in format Color (RGB)
- dynamiclightBrightness: Number
Examples
- Example 1:
- Example 2:
Additional Information
- See also:
- getLighting Light Source Tutorial
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