apertureParams: Difference between revisions

Latest revision as of 17:18, 5 May 2022

2.04

LALocal

Hover & click on the images for description

Description

Description:: Returns current aperture parameters.
Groups:: Camera Control Lights

Syntax

Syntax:

apertureParams

Return Value:

Array in format [aperture, isForced, estimatedAperture, estimatedLuminance, minCustom, stdCustom, maxCustom, customLuminance, isCustomForced, blinding], where:

aperture: Number - current aperture
isForced: Boolean - whether aperture was forced by setAperture
estimatedAperture: Number - engine-estimated scene aperture
estimatedLuminance: Number - engine-estimated luminance
minCustom: Number - minimal custom aperture, see setApertureNew
stdCustom: Number - standard custom aperture, see setApertureNew
maxCustom: Number - maximal custom aperture, see setApertureNew
customLuminance: Number - custom luminance, see setApertureNew
isCustomForced: Boolean - whether custom values were forced
blinding: Number - blinding intensity of the light

Examples

Example 1:: private _apertureParams = apertureParams;

Additional Information

See also:: setApertureNew setAperture

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-|game1= arma3dev
+|game1= arma3
+|version1= 2.04
-|version1= 2.03
+|arg= local
-<!--
+|descr= Returns current aperture parameters.
-|arg= local or global
-|eff= local or global
+|gr1= Camera Control
-|serverExec= server or empty
--->
-|descr= {{WIP}}
-<!--
-|mp= MP behaviour
-|pr= Known problems
--->
-|gr1= Camera Control
+|gr2= Lights
 |s1= [[apertureParams]]
-<!--
+|r1= [[Array]] in format [aperture, isForced, estimatedAperture, estimatedLuminance, minCustom, stdCustom, maxCustom, customLuminance, isCustomForced, blinding], where:
-|p1= argumentName: [[Type]] - (Optional, default [[defaultValue]]) description
+* aperture: [[Number]] - current aperture
+* isForced: [[Boolean]] - whether aperture was forced by [[setAperture]]
-|p2= target: [[Object]] - (Optional, default [[objNull]]) the command's target
+* estimatedAperture: [[Number]] - engine-estimated scene aperture
--->
+* estimatedLuminance: [[Number]] - engine-estimated luminance
+* minCustom: [[Number]] - minimal custom aperture, see [[setApertureNew]]
-|r1= [[Array]]
+* stdCustom: [[Number]] - standard custom aperture, see [[setApertureNew]]
+* maxCustom: [[Number]] - maximal custom aperture, see [[setApertureNew]]
+* customLuminance: [[Number]] - custom luminance, see [[setApertureNew]]
+* isCustomForced: [[Boolean]] - whether custom values were forced
+* blinding: [[Number]] - blinding intensity of the light
-|x1= <code>[[private]] _aperture = [[apertureParams]]</code>
+|x1= <sqf>private _apertureParams = apertureParams;</sqf>
 |seealso= [[setApertureNew]] [[setAperture]]
 }}