lineIntersects: Difference between revisions
Pennyworth (talk | contribs) (Add game version for alternative syntax to description. Minor typo corrections. Reordered see also commands to be grouped and consistent across lineIntersects pages) |
mNo edit summary |
||
Line 14: | Line 14: | ||
|gr1= Math - Geometry | |gr1= Math - Geometry | ||
|descr= Checks for object intersection with a virtual line between two positions. Since {{GVI|arma3|2.20|size= 0.75}}, there is an alternative syntax that does multiple checks | |descr= Checks for object intersection with a virtual line between two positions. Since {{GVI|arma3|2.20|size= 0.75}}, there is an alternative syntax that does multiple checks in parallel, faster than multiple calls. | ||
{{Feature|informative| | {{Feature|informative| | ||
* Does not work under water. | * Does not work under water. |
Revision as of 18:11, 18 March 2025
Description
- Description:
- Checks for object intersection with a virtual line between two positions. Since
2.20, there is an alternative syntax that does multiple checks in parallel, faster than multiple calls.
- Groups:
- Math - Geometry
Syntax
- Syntax:
- lineIntersects [begPos, endPos, objIgnore1, objIgnore2]
- Parameters:
- begPos: Array format PositionASL
- endPos: Array format PositionASL
- objIgnore1: Object - (Optional, default objNull) 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, default objNull) 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
- Return Value:
- Boolean - true if an intersection happens with an object (not with terrain)
Alternative Syntax
- Syntax:
- lineIntersects [element1, element2, ...]
- Parameters:
- elementN: Array format [begPos, endPos, objIgnore1, objIgnore2]:
- begPos: Array format PositionASL
- endPos: Array format PositionASL
- objIgnore1: Object - (Optional, default objNull) 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, default objNull) 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
- Return Value:
- Array format [result1, result2, ...] - true if an intersection happens with an object (not with terrain) for the Nth element
Examples
- Example 1:
- Example 2:
- Alternative syntax to check intersections in parallel:
Additional Information
- See also:
- lineIntersectsSurfaces lineIntersectsObjs lineIntersectsWith 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:46 (UTC)
- Please note the difference: