getLighting: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page creation)
 
No edit summary
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


|game1= arma3dev |Game name=
|game1= arma3
|version1= 2.00


|version= 1.99 |Game version=
|gr1= Lights
____________________________________________________________________________________________


|descr= Gets general environment's light settings or specific object's lighting information. |Description=
|descr= Gets general environment's light settings.
____________________________________________________________________________________________


|s1= [[getLighting]] |Syntax=
|s1= [[getLighting]]


|r1= [[Array]] to format [ambientLightColor, lightDirection, moonPhase, starsVisibility]:
|r1= [[Array]] in format [ambientLightColor, ambientLightBrightness, lightDirection, starsVisibility]:
* ambientLightColor: [[Color]]
* ambientLightColor: [[Color|Color (RGB)]]
* ambientLightBrightness: [[Number]]
* lightDirection: [[Vector3D]]
* lightDirection: [[Vector3D]]
* moonPhase: [[Number]]
* starsVisibility: [[Number]]
* starsVisibility: [[Number]] |Return Value=
____________________________________________________________________________________________


|s2= [[getLighting]] obj |Alternative Syntax=
|x1= <sqf>getLighting; // returns [[0.646753,0.781818,1],28526.2,[-0.0167152,0.211598,-0.977214],0]</sqf>


|p21= obj: [[Object]] |Alternative Parameter 1=
|x2= <sqf>getLighting params ["_ambientLightColour", "_ambientLightBrightness", "_lightDirection", "_starsVisibility"];</sqf>


|r2= [[Array]] to format [dynamicLightColor, dynamiclightBrightness, ambientLightColor, ambientLightBrightness]:
|seealso= [[getLightingAt]] [[moonPhase]] [[Light Source Tutorial]]
* dynamicLightColor: [[Color]]
}}
* dynamiclightBrightness: [[Number]]
* ambientLightColor: [[Color]]
* ambientLightBrightness: [[Number]] |Alternative Return Value=
____________________________________________________________________________________________


|x1= <!--<code>[[getLighting]]; {{cc|returns }}</code>--> |Example 1=
{{Note
____________________________________________________________________________________________
|user= POLPOX
 
|timestamp= 20230918132029
|seealso= [[:Category:Command Group: Lights]] [[Lightpoint Tutorial]] |See Also=
|text= Possible to check if a position is in a shadow.
<sqf>[player,"VIEW"] checkVisibility [eyePos player,eyePos player vectorDiff ((getLighting#2) vectorMultiply 200)]</sqf>
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Command Group: Lights]]

Latest revision as of 14:20, 18 September 2023

Arma 3 logo black.png2.00
Hover & click on the images for description

Description

Description:
Gets general environment's light settings.
Groups:
Lights

Syntax

Syntax:
getLighting
Return Value:
Array in format [ambientLightColor, ambientLightBrightness, lightDirection, starsVisibility]:

Examples

Example 1:
getLighting; // returns [[0.646753,0.781818,1],28526.2,[-0.0167152,0.211598,-0.977214],0]
Example 2:
getLighting params ["_ambientLightColour", "_ambientLightBrightness", "_lightDirection", "_starsVisibility"];

Additional Information

See also:
getLightingAt moonPhase 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
POLPOX - c
Posted on Sep 18, 2023 - 13:20 (UTC)
Possible to check if a position is in a shadow.
[player,"VIEW"] checkVisibility [eyePos player,eyePos player vectorDiff ((getLighting#2) vectorMultiply 200)]
Retrieved from "https://community.bistudio.com/wiki?title=getLighting&oldid=347410"