getCursorObjectParams: Difference between revisions

Latest revision as of 10:59, 16 June 2024

Hover & click on the images for description

Description:: Returns object and named selections under cursor and distance to object's surface (to the point cursor points at). If object surface is further away than 50 meters, selections are always an empty array and distance is 1e10 (10^10).
Groups:: Object Detection

Syntax:

getCursorObjectParams

Return Value:

Array with [cursorObject, selections, distance]

: 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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-|arma3
+|game1= arma3
+|version1= 1.70
-|1.70
 |gr1= Object Detection
-| Returns object and named selections under cursor and distance to object's surface (to the point cursor points at). If object surface is further away than 50 meters, selections are always an empty array and distance is 1e10 (10^10).
+|descr= Returns object and named selections under cursor and distance to object's surface (to the point cursor points at). If object surface is further away than 50 meters, selections are always an empty array and distance is 1e10 (10^10).
-\|s1= '''getCursorObjectParams'''
+|s1= '''getCursorObjectParams'''
-|r1=[[Array]] - [cursorObject, selections, distance]
+|r1= [[Array]] with [cursorObject, selections, distance]
+* cursorObject: [[Object]]
+* selections: [[Array]] of [[String]]s
+* distance: [[Number]] - distance to object's surface (to the point cursor points at)
-|x1= <code>[[hint]] [[str]] [[getCursorObjectParams]];</code>
+|x1= <sqf>hint str getCursorObjectParams;</sqf>
-|seealso= [[cursorObject]], [[cursorTarget]]
+|seealso= [[cursorObject]] [[cursorTarget]]
 }}