BIS fnc sceneGetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Broken Functions |GROUP1=
|gr1= Broken Functions


|gr2 = Scenes |GROUP2=
|gr2 = Scenes


| {{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;)}}
| {{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;)}}
Line 19: Line 19:
]</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!}}


| [centre, radius, type] call [[BIS_fnc_sceneGetObjects]] |SYNTAX=
| [centre, radius, type] call [[BIS_fnc_sceneGetObjects]]


|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]] |PARAMETER1=
|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]


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


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


| [[Script_(Handle)|Script handle]] |RETURNVALUE=
| [[Script_(Handle)|Script handle]]


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


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



Revision as of 00:45, 18 January 2021

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 FunctionsScenes

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

Bottom Section