BIS fnc sceneGetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}")
m (revert + fix)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2


|1.00
|version1= 1.00


|gr1= Broken Functions
|gr1= Broken Functions


|gr2 = Scenes
|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]}} )}}
|descr= {{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]}} )}}
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>[
<code>[
{{cc| 11 elements for one object}} _nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,
{{cc|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,
(…)
(…)
]</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!}}
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]]
|s1= [centre, radius, type] call [[BIS_fnc_sceneGetObjects]]


|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]
|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]
Line 28: Line 28:
|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])
|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])


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


|x1= <code><nowiki>[</nowiki>[[player]], 20, "Car"] [[call]] [[BIS_fnc_sceneGetObjects]];</code>
|x1= <code>[<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]]
}}
}}


[[Category:Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneGetObjects}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneGetObjects}}]]

Revision as of 22:27, 29 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