BIS fnc sceneSetPosFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>0 = " to "<code>")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 15: Line 15:
|gr1= Scenes
|gr1= Scenes


| Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.
|exec= spawn


|s1= param spawn [[BIS_fnc_sceneSetPosFormation]]
|descr= Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.


|p1= [[Array]] - Array of units involved.
|s1= param spawn [[BIS_fnc_sceneSetPosFormation]]
|p2= [[Object]] - Scene initiator.


|p3= [[Object]] - Talking partner of scene initiator.
|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
|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).
|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'''''.
|p6= [[Number]] - (Optional, default 0) - determines angle offset


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code><nowiki>[units group player, bluforCommander, player, "HALFCIRCLE",0]</nowiki> spawn BIS_fnc_sceneSetPosFormation;</code>
|x1= <code>[<nowiki/>[[units]] [[group]] [[player]], bluforCommander, [[player]], "HALFCIRCLE", 0] [[spawn]] [[BIS_fnc_sceneSetPosFormation]];</code>
 
|seealso=
}}
}}
[[Category:{{Name|arma2}}: Functions|{{uc:sceneSetPosFormation}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneSetPosFormation}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneSetPosFormation}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneSetPosFormation}}]]

Revision as of 19:56, 13 June 2021

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