BIS_fnc_getIntersectionsUnderCursor

1.00

Hover & click on the images for description

Description

Description:

Returns intersections under cursor. For more information see lineIntersectsSurfaces.

Execution:

call

Groups:

Geometry

Syntax

Syntax:

[screenX, screenY, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2] call BIS_fnc_getIntersectionsUnderCursor

Parameters:

screenX: Number - (Optional, default 0) cursor's X position - see screenToWorld

screenY: Number - (Optional, default 0) cursor's Y position - see screenToWorld

ignoreObj1: Object - (Optional, default objNull) first object to ignore

ignoreObj2: Object - (Optional, default objNull) second object to ignore

sortMode: Boolean - (Optional, default true) true: closest to furthest, false: furthest to closest

maxResults: Number - (Optional, default 1) max results to return. -1 to return every result

since 1.52

LOD1: String - (Optional, default "VIEW") primary LOD to look for intersection. Can be one of:

• "FIRE"
• "VIEW"
• "GEOM"
• "IFIRE" - ("I" stands for Indirect, almost identical to "FIRE")
• "NONE"
• 2.02 "PHYSX" - PhysX geometry LOD
• 2.08 "ROADWAY" - only works from the top

since 1.52

LOD2: String - (Optional, default "FIRE") secondary LOD to look for intersection. See LOD1 for possible values

Return Value:

Array of intersections in format [[intersectPosASL, surfaceNormal, intersectObj, parentObject, selectionNames, pathToBisurf], ...] where:

• intersectPosASL: PositionASL - the actual position where line intersects surface
• surfaceNormal: Vector - a normal to the intersected surface
• intersectObject: Object - the object the surface belongs to (could be proxy object) - objNull if terrain
• parentObject: Object - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain
• 2.10 selectionNames: Array of Strings - Names of the intersected selections (bones). Returns [] if there is no intersection with a selection.
• 2.10 pathToBisurf: String - path to intersected surface properties (.bisurf) file. Returns "" if surface has no special properties. Terrain surface properties begin with #, and the surface properties are defined in CfgSurfaces. For example, if it returns #GdtVRsurface01, properties are defined in: configFile >> "CfgSurfaces" >> "GdtVRsurface01"

Examples

Example 1:

[0.5, 0.5, player, objNull, true, "VIEW"] call BIS_fnc_getIntersectionsUnderCursor;

Additional Information

See also:

lineIntersectsSurfaces

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