Difference between revisions of "BIS fnc sceneGetObjects"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|+$" to "")
m (Text replacement - "Script handle" to "Script Handle")
 
(10 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
|gr2= Scenes
 
|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''', {{ic|[centrum]}} instead of {{ic|[_centrum]}} )}}
+
|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>[
{{cc|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>
 
{{Feature|important|Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}}
 
{{Feature|important|Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}}
  
Line 36: Line 36:
 
|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])
 
|p3= type: [[String]] - (Optional, default "All") - objects type (see [[nearestObjects]])
  
|r1= [[Script (Handle)|Script handle]]
+
|r1= [[Script Handle]]
  
|x1= <code>[<nowiki/>[[player]], 20, "Car"] [[call]] [[BIS_fnc_sceneGetObjects]];</code>
+
|x1= <sqf>[player, 20, "Car"] call BIS_fnc_sceneGetObjects;</sqf>
  
|seealso= [[BIS_fnc_sceneSetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]]
+
|seealso= [[BIS_fnc_sceneSetObjects]] [[BIS_fnc_objectsGrabber]] [[BIS_fnc_objectsMapper]]
 
}}
 
}}

Latest revision as of 19:17, 9 August 2022

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:

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