BIS fnc sceneGetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
Line 17: Line 17:
]</code>
]</code>
{{Important|
{{Important|
Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}} |= Description
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
| [centre, radius, type] call [[BIS_fnc_sceneGetObjects]] |SYNTAX=


|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]] |PARAMETER1=


|p2= radius: [[Number]] - (Optional, default 20) |= Parameter 2
|p2= radius: [[Number]] - (Optional, default 20) |PARAMETER2=


|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]]) |= Parameter 3
|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]]) |PARAMETER3=


| [[Script_(Handle)|Script handle]] |= Return value
| [[Script_(Handle)|Script handle]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]], 20, "Car"] [[call]] [[BIS_fnc_sceneGetObjects]];</code> |= Example 1
|x1= <code><nowiki>[</nowiki>[[player]], 20, "Car"] [[call]] [[BIS_fnc_sceneGetObjects]];</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_sceneSetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]] |= See also
| [[BIS_fnc_sceneSetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]] |SEEALSO=
}}
}}



Revision as of 14:33, 7 April 2019

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:
Uncategorised

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_sceneSetObjectsBIS_fnc_objectsGrabberBIS_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

Notes

Bottom Section