BIS fnc sceneSetPosFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added params, syntax, example. Execution needs adjusting to spawn if anybody can figure that out.)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *F([a-z ])" to "$1 - f$2")
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group. |= Description
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| param spawn [[BIS_fnc_sceneSetPosFormation]]; |= Syntax
|gr1= Scenes


|p1= [[Array]] - Array of units involved. |= Parameter 1
|exec= spawn
|p2= [[Object]] - Scene initiator. |=
|p3= [[Object]] - Talking partner of scene initiator. |=
|p4= [[String]] - Formation in which to place units. Possible values: "LINE", "CIRCLE", "HALFCIRCLE |=
|p5= [[Number]] - True / false in format [[Number]] (0 = false, 1 = true), determines debug mode (showing markers). |=
|p6= ''[[Number]] - Determines angle offset. Optional parameter, '''default 0'''''.


| [[Nothing]] |= Return value
|descr= Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.
____________________________________________________________________________________________


|x1= <code>0 = <nowiki>[units group player, bluforCommander, player, "HALFCIRCLE",0]</nowiki> spawn BIS_fnc_sceneSetPosFormation;</code> |=
|s1= param spawn [[BIS_fnc_sceneSetPosFormation]]
____________________________________________________________________________________________


| |= See also
|p1= [[Array]] - array of units involved


}}
|p2= [[Object]] - scene initiator
 
|p3= [[Object]] - talking partner of scene initiator
 
|p4= [[String]] - formation in which to place units. Possible values: "LINE", "CIRCLE", "HALFCIRCLE
 
|p5= [[Number]] - true / false in format [[Number]] (0 = false, 1 = true), determines debug mode (showing markers).
 
|p6= [[Number]] - (Optional, default 0) - determines angle offset


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


<!-- Note Section END -->
|x1= <sqf>[units group player, bluforCommander, player, "HALFCIRCLE", 0] spawn BIS_fnc_sceneSetPosFormation;</sqf>
</dl>


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

Latest revision as of 16:29, 8 November 2023

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:
Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.
Execution:
spawn
Groups:
Scenes

Syntax

Syntax:
param spawn BIS_fnc_sceneSetPosFormation
Parameters:
Array - array of units involved
Object - scene initiator
Object - talking partner of scene initiator
String - formation in which to place units. Possible values: "LINE", "CIRCLE", "HALFCIRCLE
Number - true / false in format Number (0 = false, 1 = true), determines debug mode (showing markers).
Number - (Optional, default 0) - determines angle offset
Return Value:
Nothing

Examples

Example 1:
[units group player, bluforCommander, player, "HALFCIRCLE", 0] spawn BIS_fnc_sceneSetPosFormation;

Additional Information

See also:
See also needed

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_sceneSetPosFormation&oldid=348694"