BIS fnc sceneGetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| {{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;)}}
/*******************************************************************************
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 />
  *
Text copied is to format:
* version: 1.0
<code>[
* name: sceneGetObjects
{{codecomment|// 11 elements for one object}}
* description: part of S.C.E.N.E.S. This script gets objects positions  
_nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,
* and direction relative to the choosen object
_nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,
* more info on: https://wiki.bistudio.com/index.php/SCENES   
(…)
* paramater: object or marker
]</code>
* (its position will be selected as a center of the scene)
{{Important|
* optional: x, y - size of the area which objects will be
Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!}} |= Description
* exported from
* return value: nothing
*
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] 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
 
|p2= radius: [[Number]] - (Optional, default 20) |= Parameter 2


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


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


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


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


Revision as of 10:28, 6 May 2018

Logo A2.png1.00
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.
Text copied 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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sceneGetObjects&oldid=107136"