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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma2
-____________________________________________________________________________________________
+|version1= 1.00
-| arma2 |= Game name
+|game2= arma2oa
+|version2= 1.50
-|1.00|= Game version
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| <pre>
+|game4= arma3
-/*******************************************************************************
+|version4= 0.50
- *
- *	version: 	1.0
- *	name:		sceneGetObjects
- *	description:	part of S.C.E.N.E.S. This script gets objects positions
- *			and direction relative to the choosen object
- *			more info on: https://wiki.bistudio.com/index.php/SCENES
- *	paramater:	object or marker
- *			(its position will be selected as a center of the scene)
- *			optional: x, y - size of the area which objects will be
- *			exported from
- *	return value:	nothing
- *
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_sceneGetObjects]]; --> |= Syntax
+|gr1= Broken Functions
-|p1= |= Parameter 1
+|gr2= Scenes
-| |= Return value
+|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,
+	// ...
+]</sqf>
+{{Feature|important|Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}}
-|x1= <code></code> |=
+|s1= [centre, radius, type] call [[BIS_fnc_sceneGetObjects]]
-____________________________________________________________________________________________
-| |= See also
+|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]
-}}
+|p2= radius: [[Number]] - (Optional, default 20)
+|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])
-<h3 style="display:none">Notes</h3>
+|r1= [[Script Handle]]
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>[player, 20, "Car"] call BIS_fnc_sceneGetObjects;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[BIS_fnc_sceneSetObjects]] [[BIS_fnc_objectsGrabber]] [[BIS_fnc_objectsMapper]]
-[[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}}]]