Difference between revisions of "lineIntersectsObjs"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<br/>" to "<br>")
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
|1.10|= Game version
+
|1.10|Game version=
|arg= global|= Arguments in MP
+
|arg= global|Multiplayer Arguments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 18: Line 18:
 
|p5= sortByDistance: [[Boolean]] - [[true]]: furthest object first, closest object last; [[false]]: unsorted |PARAMETER5=
 
|p5= sortByDistance: [[Boolean]] - [[true]]: furthest object first, closest object last; [[false]]: unsorted |PARAMETER5=
 
|p6= flags: [[Number]]
 
|p6= flags: [[Number]]
<br/>1 - CF_ONLY_WATER  
+
<br>1 - CF_ONLY_WATER  
<br/>2 - CF_NEAREST_CONTACT  
+
<br>2 - CF_NEAREST_CONTACT  
<br/>4 - CF_ONLY_STATIC  
+
<br>4 - CF_ONLY_STATIC  
<br/>8 - CF_ONLY_DYNAMIC  
+
<br>8 - CF_ONLY_DYNAMIC  
<br/>16 - CF_FIRST_CONTACT  
+
<br>16 - CF_FIRST_CONTACT  
<br/>32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
+
<br>32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
<br/>Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC|PARAMETER6=
+
<br>Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC|PARAMETER6=
  
 
| [[Array]] of [[Object|Objects]] - intersecting objects |RETURNVALUE=
 
| [[Array]] of [[Object|Objects]] - intersecting objects |RETURNVALUE=

Latest revision as of 15:23, 14 March 2020

Introduced with Arma 3 version 1.101.10Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Returns list of objects intersected by given line from begPos to endPos.

Syntax

Syntax:
lineIntersectsObjs [begPos, endPos, withObj, ignoreObj, sortByDistance, flags]
Parameters:
begPos: PositionASL - virtual line start
endPos: PositionASL - virtual line end
withObj: Object
ignoreObj: Object
sortByDistance: Boolean - true: furthest object first, closest object last; false: unsorted
flags: Number
1 - CF_ONLY_WATER
2 - CF_NEAREST_CONTACT
4 - CF_ONLY_STATIC
8 - CF_ONLY_DYNAMIC
16 - CF_FIRST_CONTACT
32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC
Return Value:
Array of Objects - intersecting objects

Examples

Example 1:
Sto = []; Fn = { { Sto set [_foreachindex,lineIntersectsObjs [(eyePos player),(ATLtoASL screenToWorld [0.5,0.5]),objNull,objNull,false,_x]]; } forEach [1,2,4,8,16,32]; hintSilent format [" ONLY_WATER: %1, NEAREST_CONTACT: %2, ONLY_STATIC: %3, ONLY_DYNAMIC: %4, FIRST_CONTACT: %5, ALL_OBJECTS: %6", Sto select 0,Sto select 1,Sto select 2,Sto select 3,Sto select 4,Sto select 5]; }; ["sample_id","onEachFrame","Fn"] call BIS_fnc_addStackedEventHandler; //Example display objects' array in the middle of the screen sorted by 6 flags

Additional Information

See also:
lineIntersectsSurfaceslineIntersectsWithterrainIntersectterrainIntersectASLterrainIntersectAtASLlineIntersectsintersectcursorObjectcursorTargetcheckVisibility

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.


Bottom Section

Posted on March 29, 2016 - 05:07 (UTC)
AgentRev
Distance sorting is relative to object model center, and not intersect position.