BIS fnc sceneSetObjects: 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>
| This function sets objects positions and direction relative to the chosen object.
/*******************************************************************************
{{warning|Same as its [[BIS_fnc_sceneGetObjects|GET]] counterpart (at least in {{arma3}}), this function doesn't work as intended as it doesn't set objects direction properly. All objects will be created with a zero azimuth.}} |= Description
*
* version: 1.0
* name: sceneGetObjects
* description: part of S.C.E.N.E.S. This script set objects positions  
* and direction relative to the choosen object
* more info on: https://wiki.bistudio.com/index.php/SCENES   
* paramater: object or marker
* (its position will be selected as a center of the scene)
* ARRAY_OF_PARAMETERS
* - parameters gained from sceneGetObject
*
* return value: nothing
*
******************************************************************************/
//_this spawn
//{ 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneSetObjects]]; --> |= Syntax
| [centre, objectsArray, applyOffset, stopped] call [[BIS_fnc_sceneSetObjects]] |= Syntax


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


| |= Return value
|p2= objectsArray: [[Array]] - See [[BIS_fnc_sceneGetObjects]] for format information |= Parameter 2
 
|p3= applyOffset: [[Boolean]] - [[true]] to apply height offset |= Parameter 3
 
|p4= stopped: [[Anything]] - if provided and if BIS_debugModules is defined, units will be [[stop|stopped]] |= Parameter 4
 
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[player, ''_arrayOfObjects'', false] [[call]] [[BIS_fnc_sceneSetObjects]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Revision as of 12:02, 6 May 2018

Logo A2.png1.00
Hover & click on the images for description

Description

Description:
This function sets objects positions and direction relative to the chosen object.
⚠
Same as its GET counterpart (at least in Arma 3), this function doesn't work as intended as it doesn't set objects direction properly. All objects will be created with a zero azimuth.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[centre, objectsArray, applyOffset, stopped] call BIS_fnc_sceneSetObjects
Parameters:
centre: Object or String - object or marker name - NOT a Position
objectsArray: Array - See BIS_fnc_sceneGetObjects for format information
applyOffset: Boolean - true to apply height offset
stopped: Anything - if provided and if BIS_debugModules is defined, units will be stopped
Return Value:
Boolean

Examples

Example 1:
[player, _arrayOfObjects, false] call BIS_fnc_sceneSetObjects;

Additional Information

See also:
BIS_fnc_sceneGetObjectsBIS_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_sceneSetObjects&oldid=107138"