BIS fnc sceneSetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
Line 8: Line 8:


| This function sets objects positions and direction relative to the chosen object.
| 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
{{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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [centre, objectsArray, applyOffset, stopped] call [[BIS_fnc_sceneSetObjects]] |= Syntax
| [centre, objectsArray, applyOffset, stopped] call [[BIS_fnc_sceneSetObjects]] |SYNTAX=


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


|p2= objectsArray: [[Array]] - See [[BIS_fnc_sceneGetObjects]] for format information |= Parameter 2
|p2= objectsArray: [[Array]] - See [[BIS_fnc_sceneGetObjects]] for format information |PARAMETER2=


|p3= applyOffset: [[Boolean]] - [[true]] to apply height offset |= Parameter 3
|p3= applyOffset: [[Boolean]] - [[true]] to apply height offset |PARAMETER3=


|p4= stopped: [[Anything]] - if provided and if BIS_debugModules is defined, units will be [[stop|stopped]] |= Parameter 4
|p4= stopped: [[Anything]] - if provided and if BIS_debugModules is defined, units will be [[stop|stopped]] |PARAMETER4=


| [[Boolean]] |= Return value
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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



Revision as of 14:33, 7 April 2019

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