Difference between revisions of "BIS fnc getIntersectionsUnderCursor"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 7/7)
m (pf)
Line 1: Line 1:
 
+
{{Function|Comments=
{{Function|= Comments
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>/*
+
| Returns intersections under cursor. |Description=
Author: Nelson Duarte
+
____________________________________________________________________________________________
 
 
Description:
 
Returns intersections under cursor
 
  
Parameters:
+
| [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults] call [[BIS_fnc_getIntersectionsUnderCursor]] |Syntax=
_this:
 
  
Returns:
 
ARRAy of intersections, see https://community.bistudio.com/wiki/lineIntersectsSurfaces
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_getIntersectionsUnderCursor]]; --> |= Syntax
+
|p1= [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2]: [[Array]]| Parameter 1 =
|p1= |= Parameter 1
+
|p2= begPosASL: [[PositionASL]] - virtual line start | Parameter 2 =
 +
|p3= endPosASL: [[PositionASL]] - virtual line end | Parameter 3 =
 +
|p4= ignoreObj1 (Optional): [[Object]] - first object to ignore or [[objNull]]: Default: [[objNull]]| Parameter 4 =
 +
|p5= ignoreObj2 (Optional): [[Object]] - second object to ignore or [[objNull]]: Default: [[objNull]] | Parameter 5 =
 +
|p6= sortMode (Optional): [[Boolean]] - [[true]]: closest to furthest, [[false]]: furthest to closest. Default: [[true]]  | Parameter 6 =  
 +
|p7= maxResults (Optional): [[Number]] - Max results to return. -1 to return every result. Default: 1| Parameter 7 =  
  
| |= Return value
+
|[[Array]] of intersections in format <nowiki>[</nowiki>[intersectPosASL, surfaceNormal, intersectObj, parentObject],...] where:
 +
* intersectPosASL - the actual position where line intersects surface
 +
* [[surfaceNormal]] - a normal to the intersected surface
 +
* intersectObject - the object the surface belongs to (could be proxy object) - [[objNull]] if terrain
 +
* parentObject - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code>[ [[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper, [[true]] ] [[call]] [[BIS_fnc_getIntersectionsUnderCursor]];</code> |Example 1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[lineIntersectsSurfaces]] |See also=
 +
}}
  
}}
 
  
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>

Revision as of 00:59, 7 June 2018

Introduced with Arma 3 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Returns intersections under cursor.

Syntax

Syntax:
[begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults] call BIS_fnc_getIntersectionsUnderCursor
Parameters:
[begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2]: Array
begPosASL: PositionASL - virtual line start
endPosASL: PositionASL - virtual line end
ignoreObj1 (Optional): Object - first object to ignore or objNull: Default: objNull
ignoreObj2 (Optional): Object - second object to ignore or objNull: Default: objNull
sortMode (Optional): Boolean - true: closest to furthest, false: furthest to closest. Default: true
maxResults (Optional): Number - Max results to return. -1 to return every result. Default: 1
Return Value:
Array of intersections in format [[intersectPosASL, surfaceNormal, intersectObj, parentObject],...] where:
  • intersectPosASL - the actual position where line intersects surface
  • surfaceNormal - a normal to the intersected surface
  • intersectObject - the object the surface belongs to (could be proxy object) - objNull if terrain
  • parentObject - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain

Examples

Example 1:
[ eyePos player, aimPos chopper, player, chopper, true ] call BIS_fnc_getIntersectionsUnderCursor;

Additional Information

Execution:
call
Multiplayer:
-
See also:
lineIntersectsSurfaces

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To


Notes

Bottom Section