BIS fnc sceneGetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "Script handle" to "Script Handle")
(25 intermediate revisions by 2 users not shown)
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


|gr1= Broken Functions |GROUP1=
|game3= tkoh
|version3= 1.00


|gr2 = Scenes |GROUP2=
|game4= arma3
|version4= 0.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]}} )}}
|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>
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:
Result is to format:
<code>[
<sqf>[
{{codecomment|// 11 elements for one object}}
// 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,
_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]] |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=
|r1= [[Script Handle]]


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


| [[BIS_fnc_sceneSetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]] |SEEALSO=
|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: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}}]]

Revision as of 19:17, 9 August 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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 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_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sceneGetObjects&oldid=329964"