BIS fnc sceneGetObjects: Difference between revisions

Latest revision as of 00:25, 2 February 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

⚠

This function is broken (at least in Arma 3) as it has a typo, displaying an error on each use! (typo line 63, [centrum] instead of [_centrum]).

This function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard via copyToClipboard.
Result is to format:

[ // 11 elements for one object _nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev, _nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev, // ... ]

⚠

Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!

Execution:

call

Groups:

Broken Functions Scenes

Syntax

Syntax:: [centre, radius, type] call BIS_fnc_sceneGetObjects
Parameters:: centre: Object or String - object or marker name - NOT a Position
: radius: Number - (Optional, default 20)
: type: String - (Optional, default "All") - objects type (see nearestObjects)
Return Value:: Script Handle

Examples

Example 1:: [player, 20, "Car"] call BIS_fnc_sceneGetObjects;

Additional Information

See also:: BIS_fnc_sceneSetObjects BIS_fnc_objectsGrabber BIS_fnc_objectsMapper

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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| {{warning|This function is broken (at least in {{arma3}}) as it has a typo, displaying an error on each use!  (typo '''line 63''', {{Inline code|[centrum]}} instead of {{Inline code|[_centrum]}}&nbsp;)}}
+|game3= tkoh
-This function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard ''via'' [[copyToClipboard]].<br />
+|version3= 1.00
-Text copied is to format:
-<code>[
+|game4= arma3
-	{{codecomment|// 11 elements for one object}}
+|version4= 0.50
+|gr1= Broken Functions
+|gr2= Scenes
+|descr= {{Feature|warning|This function is broken (at least in {{arma3}}) as it has a typo, displaying an error on each use!  (typo '''line 63''', {{hl|[centrum]}} instead of {{hl|[_centrum]}}).}}
+This function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard ''via'' [[copyToClipboard]].<br>
+Result is to format:
+<sqf>[
+	// 11 elements for one object
 	_nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,
 	_nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,
-	(…)
+	// ...
-]</code>
+]</sqf>
-{{Important|
+{{Feature|important|Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}}
-Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}} |= Description
-____________________________________________________________________________________________
-| [centre, radius, type] call [[BIS_fnc_sceneGetObjects]] |= Syntax
+|s1= [centre, radius, type] call [[BIS_fnc_sceneGetObjects]]
-|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]] |= Parameter 1
+|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]
-|p2= radius: [[Number]] - (Optional, default 20) |= Parameter 2
+|p2= radius: [[Number]] - (Optional, default 20)
-|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]]) |= Parameter 3
+|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])
-| [[Script_(Handle)|Script handle]] |= Return value
+|r1= [[Script Handle]]
-____________________________________________________________________________________________
-|x1= <code><nowiki>[</nowiki>[[player]], 20, "Car"] [[call]] [[BIS_fnc_sceneGetObjects]];</code> |= Example 1
+|x1= <sqf>[player, 20, "Car"] call BIS_fnc_sceneGetObjects;</sqf>
-____________________________________________________________________________________________
-| [[BIS_fnc_sceneSetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]] |= See also
+|seealso= [[BIS_fnc_sceneSetObjects]] [[BIS_fnc_objectsGrabber]] [[BIS_fnc_objectsMapper]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Scenes|{{uc:sceneGetObjects}}]]
-[[Category:Functions|{{uc:sceneGetObjects}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:sceneGetObjects}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneGetObjects}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:sceneGetObjects}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:sceneGetObjects}}]]