BIS fnc sceneSetObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Broken Functions |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


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


| [centre, objectsArray, applyOffset, stopped] call [[BIS_fnc_sceneSetObjects]] |SYNTAX=
|gr1= Broken Functions


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


|p2= objectsArray: [[Array]] - See [[BIS_fnc_sceneGetObjects]] for format information |PARAMETER2=
|descr= This function sets objects positions and direction relative to the chosen object.
{{Feature|warning|Same as its [[BIS_fnc_sceneGetObjects|GET]] counterpart (at least in {{arma3}}), this function does not work as intended as it does not set objects' direction properly. All objects will be created with a zero azimuth.}}


|p3= applyOffset: [[Boolean]] - [[true]] to apply height offset |PARAMETER3=
|s1= [centre, objectsArray, applyOffset, stopped] call [[BIS_fnc_sceneSetObjects]]


|p4= stopped: [[Anything]] - if provided and if BIS_debugModules is defined, units will be [[stop|stopped]] |PARAMETER4=
|p1= centre: [[Object]] or [[String]] - object or marker name - '''NOT''' a [[Position]]


| [[Boolean]] |RETURNVALUE=
|p2= objectsArray: [[Array]] - see [[BIS_fnc_sceneGetObjects]] for format information
____________________________________________________________________________________________


|x1= <code>[player, ''_arrayOfObjects'', false] [[call]] [[BIS_fnc_sceneSetObjects]];</code> |EXAMPLE1=
|p3= applyOffset: [[Boolean]] - [[true]] to apply height offset
____________________________________________________________________________________________


| [[BIS_fnc_sceneGetObjects]], [[BIS_fnc_objectsGrabber]], [[BIS_fnc_objectsMapper]] |SEEALSO=
|p4= stopped: [[Anything]] - if provided and if {{hl|BIS_debugModules}} is defined, units will be [[stop|stopped]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>[player, _arrayOfObjects, false] call BIS_fnc_sceneSetObjects;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_sceneGetObjects]] [[BIS_fnc_objectsGrabber]] [[BIS_fnc_objectsMapper]]
[[Category:Function Group: Scenes|{{uc:sceneSetObjects}}]]
}}
[[Category:Functions|{{uc:sceneSetObjects}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sceneSetObjects}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneSetObjects}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneSetObjects}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneSetObjects}}]]

Latest revision as of 13:00, 1 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 does not work as intended as it does not set objects' direction properly. All objects will be created with a zero azimuth.
Execution:
call
Groups:
Broken FunctionsScenes

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_sceneGetObjects 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sceneSetObjects&oldid=324235"