lineIntersectsWith: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
Killzone Kid (talk | contribs) (corrected explanation of sortByDistance functionality) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns objects intersecting with the virtual line from ''begPos'' to ''endPos''. | | Returns objects intersecting with the virtual line from ''begPos'' to ''endPos''. By default resulting array of intersecting objects is unsorted. To sort by distance set ''sortByDistance'' param to [[true]]. |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''lineIntersectsWith''' [begPos, endPos, objIgnore1, objIgnore2, | | '''lineIntersectsWith''' [begPos, endPos, objIgnore1, objIgnore2, sortByDistance] |= Syntax | ||
|p1= begPos: [[PositionASL]] - virtual line start |= Parameter 1 | |p1= begPos: [[PositionASL]] - virtual line start |= Parameter 1 | ||
| Line 16: | Line 16: | ||
|p3= objIgnore1: (optional) [[Object]] - object to ignore. When testing intersection from an object/unit/vehicle, pass that object here to prevent intersection inside of the object.|=Parameter 3 | |p3= objIgnore1: (optional) [[Object]] - object to ignore. When testing intersection from an object/unit/vehicle, pass that object here to prevent intersection inside of the object.|=Parameter 3 | ||
|p4= objIgnore2: (optional) [[Object]] - another object to ignore. When testing intersection of a line between two objects, pass the second object here to prevent intersection inside of it being reported|= Parameter 4 | |p4= objIgnore2: (optional) [[Object]] - another object to ignore. When testing intersection of a line between two objects, pass the second object here to prevent intersection inside of it being reported|= Parameter 4 | ||
|p5= | |p5= sortByDistance: (optional) [[Boolean]] - [[true]]: Sort by distance => furthermost object first, closest object last; [[false]]: unsorted |= Parameter 5 | ||
| [[Array]] - intersecting objects |= Return value | | [[Array]] - intersecting objects |= Return value | ||
| Line 23: | Line 23: | ||
|x1= <code>_objects = [[lineIntersectsWith]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[ATLtoASL]] [[screenToWorld]] [0.5,0.5]];</code> |= Example 1 | |x1= <code>_objects = [[lineIntersectsWith]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[ATLtoASL]] [[screenToWorld]] [0.5,0.5]];</code> |= Example 1 | ||
|x2= | |x2= Sort by distance: <code>_objects = [[lineIntersectsWith]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[ATLtoASL]] [[screenToWorld]] [0.5,0.5], [[objNull]], [[objNull]], [[true]]];</code> |= Example 2 | ||
|x3= Ignore objects: <code>_objects = [[lineIntersectsWith]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper];</code> |= Example 3 | |x3= Ignore objects: <code>_objects = [[lineIntersectsWith]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper];</code> |= Example 3 | ||
Revision as of 19:09, 27 February 2014
Description
- Description:
- Returns objects intersecting with the virtual line from begPos to endPos. By default resulting array of intersecting objects is unsorted. To sort by distance set sortByDistance param to true.
- Groups:
- Uncategorised
Syntax
- Syntax:
- lineIntersectsWith [begPos, endPos, objIgnore1, objIgnore2, sortByDistance]
- Parameters:
- begPos: PositionASL - virtual line start
- endPos: PositionASL - virtual line end
- objIgnore1: (optional) Object - object to ignore. When testing intersection from an object/unit/vehicle, pass that object here to prevent intersection inside of the object.
- objIgnore2: (optional) Object - another object to ignore. When testing intersection of a line between two objects, pass the second object here to prevent intersection inside of it being reported
- sortByDistance: (optional) Boolean - true: Sort by distance => furthermost object first, closest object last; false: unsorted
- Return Value:
- Array - intersecting objects
Examples
- Example 1:
_objects = lineIntersectsWith [eyePos player, ATLtoASL screenToWorld [0.5,0.5]];- Example 2:
- Sort by distance:
_objects = lineIntersectsWith [eyePos player, ATLtoASL screenToWorld [0.5,0.5], objNull, objNull, true]; - Example 3:
- Ignore objects:
_objects = lineIntersectsWith [eyePos player, aimPos chopper, player, chopper];
Additional Information
- See also:
- terrainIntersectlineIntersects
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
Notes
- Posted on may 31, 2012 - 10:50 (CEST)
- Lou Montana
- Please note the difference :
- terrainIntersect
- lineIntersects
- lineIntersectsWith