lineIntersectsWith: Difference between revisions
Pennyworth (talk | contribs) (Add alternative syntax for running multiple intersections in parallel. Minor typo corrections. Reordered see also commands to be grouped and consistent across lineIntersects pages) |
mNo edit summary |
||
Line 19: | Line 19: | ||
* Max hardcoded distance is 1000m. | * Max hardcoded distance is 1000m. | ||
}} | }} | ||
Since {{GVI|arma3|2.20|size= 0.75}}, there is an alternative syntax that does multiple checks | Since {{GVI|arma3|2.20|size= 0.75}}, there is an alternative syntax that does multiple checks in parallel, faster than multiple calls. | ||
|s1= [[lineIntersectsWith]] [begPos, endPos, objIgnore1, objIgnore2, sortByDistance] | |s1= [[lineIntersectsWith]] [begPos, endPos, objIgnore1, objIgnore2, sortByDistance] |
Revision as of 18:11, 18 March 2025
Description
- Description:
- Returns objects intersecting with the virtual line from begPos to endPos. By default, the resulting array of intersecting objects is unsorted (see sortByDistance).
Since
2.20, there is an alternative syntax that does multiple checks in parallel, faster than multiple calls.
- Groups:
- Math - Geometry
Syntax
- Syntax:
- lineIntersectsWith [begPos, endPos, objIgnore1, objIgnore2, sortByDistance]
- Parameters:
- begPos: Array format PositionASL - virtual line start
- endPos: Array format PositionASL - virtual line end
- objIgnore1: Object - (Optional) object to ignore. When testing intersections from an object/unit/vehicle, pass that object here to prevent intersections inside of the object.
- objIgnore2: Object - (Optional) another object to ignore. When testing intersections of a line between two objects, pass the second object here to prevent intersections inside of it being reported
- sortByDistance: Boolean - (Optional) true: sort by descending distance (furthermost object first, closest object last); false: unsorted
- Return Value:
- Array - intersecting objects
Alternative Syntax
- Syntax:
- lineIntersectsWith [element1, element2, ...]
- Parameters:
- elementN: Array format [begPos, endPos, objIgnore1, objIgnore2, sortByDistance]
- begPos: Array format PositionASL - virtual line start
- endPos: Array format PositionASL - virtual line end
- objIgnore1: Object - (Optional) object to ignore. When testing intersections from an object/unit/vehicle, pass that object here to prevent intersections inside of the object.
- objIgnore2: Object - (Optional) another object to ignore. When testing intersections of a line between two objects, pass the second object here to prevent intersections inside of it being reported
- sortByDistance: Boolean - (Optional) true: sort by descending distance (furthermost object first, closest object last); false: unsorted
- Return Value:
- Array format [result1, result2, ...] - each result is an Array of intersecting objects for the Nth element
Examples
- Example 1:
- Example 2:
- Sort by distance:
- Example 3:
- Ignore objects:
- Example 4:
- Alternative syntax to check intersections in parallel:
Additional Information
- See also:
- lineIntersectsSurfaces lineIntersectsObjs lineIntersects terrainIntersect terrainIntersectASL terrainIntersectAtASL intersect cursorObject cursorTarget checkVisibility
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
- Posted on May 31, 2012 - 10:50 (UTC)
-
Please note the difference :
- terrainIntersect
- terrainIntersectASL
- lineIntersects
- lineIntersectsWith
- lineIntersectsObjs
- intersect