checkVisibility: Difference between revisions

Latest revision as of 12:25, 10 April 2023

Hover & click on the images for description

Description

Description:

Affected by	Not affected by
terrain grid obstacles particles (with `blockAIVisibility = 1`)	daylight distance overcast fog

Checks if one position is visible from another position and how much.

ⓘ

Particles that have blockAIVisibility set to 1 will influence the result, but will never make checkVisibility return 0; an extremely small number will be returned instead.

Groups:

Math - Geometry

Syntax

Syntax:: [ignore, LOD, ignore2] checkVisibility [beg, end]
Parameters:: ignore: Object - object to exclude from calculations
: LOD: String - level of details to use. Possible values are: "FIRE", "VIEW", "GEOM", "IFIRE", and 2.02 "PHYSX"
since 1.62: ignore2: Object - (Optional, default objNull) second object to exclude from calculations
: beg: Array - start position in format PositionASL
: end: Array - end position in format PositionASL
Return Value:: Number - how much end position is visible to start position in range 0..1, where 1 is fully visible.

Examples

Example 1:: private _canSee = [objNull, "VIEW"] checkVisibility [eyePos player, eyePos unit1];

Additional Information

See also:: lineIntersectsWith lineIntersectsSurfaces lineIntersectsObjs intersect terrainIntersect terrainIntersectASL terrainIntersectAtASL lineIntersects cursorObject cursorTarget disableRemoteSensors

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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-|arma3|= Game name
+|game1= arma3
+|version1= 1.56
-|1.56|= Game version
+|gr1= Math - Geometry
-____________________________________________________________________________________________
-| WIP |= Description
+|descr= {{{!}} class="wikitable float-right"
-____________________________________________________________________________________________
+! style="width: 50%" {{!}} Affected by
+! Not affected by
+{{!}}-
+{{!}}
+* [[getTerrainGrid|terrain grid]]
+* obstacles
+* particles<br><span style="font-size: .9em">(with <syntaxhighlight lang="cpp" inline>blockAIVisibility = 1</syntaxhighlight>)</span>
+{{!}}
+* [[time|daylight]]
+* [[distance]]
+* [[overcast]]
+* [[fog]]
+{{!}}}
+Checks if one position is visible from another position and how much.
-| [ignored object, lod name] '''checkVisibility''' [begin, end] |= Syntax
+{{Feature|informative|Particles that have {{hl|blockAIVisibility}} set to 1 will influence the result, but will never make [[checkVisibility]] return 0; an extremely small number will be returned instead.}}
-|p1= ignored object: |= PARAMETER1
-|p2= lod name: |= PARAMETER2
-|p3= begin: |= PARAMETER3
-|p4= end: |= PARAMETER4
-| |= RETURNVALUE
-____________________________________________________________________________________________
-|  |= SEEALSO
+|s1= [ignore, LOD, ignore2] [[checkVisibility]] [beg, end]
-|  |= MPBEHAVIOUR
-____________________________________________________________________________________________
+|p1= ignore: [[Object]] - object to exclude from calculations
-}}
+|p2= LOD: [[String]] - level of details to use. Possible values are: {{hl|"FIRE"}}, {{hl|"VIEW"}}, {{hl|"GEOM"}}, {{hl|"IFIRE"}}, and {{GVI|arma3|2.02|size= 0.75}} {{hl|"PHYSX"}}
+|p3= ignore2: [[Object]] - (Optional, default [[objNull]]) second object to exclude from calculations
+|p3since= arma3 1.62
+|p4= beg: [[Array]] - start position in format [[Position#PositionASL|PositionASL]]
+|p5= end: [[Array]] - end position in format [[Position#PositionASL|PositionASL]]
-<h3 style='display:none'>Notes</h3>
+|r1= [[Number]] - how much end position is visible to start position in range 0..1, where 1 is fully visible.
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<!-- DISCONTINUE Notes -->
+|x1= <sqf>private _canSee = [objNull, "VIEW"] checkVisibility [eyePos player, eyePos unit1];</sqf>
-<h3 style='display:none'>Bottom Section</h3>
+|seealso= [[lineIntersectsWith]] [[lineIntersectsSurfaces]] [[lineIntersectsObjs]] [[intersect]] [[terrainIntersect]] [[terrainIntersectASL]] [[terrainIntersectAtASL]] [[lineIntersects]] [[cursorObject]] [[cursorTarget]] [[disableRemoteSensors]]
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]