BIS fnc sceneSetPosFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Added params, syntax, example. Execution needs adjusting to spawn if anybody can figure that out.)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group. |= Description
/*******************************************************************************
*
* version: 1.0
* name:
* description: setup talking formations
* parameters: described bellow
*
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneSetPosFormation]]; --> |= Syntax
| param spawn [[BIS_fnc_sceneSetPosFormation]]; |= Syntax


|p1= |= Parameter 1
|p1= [[Array]] - Array of units involved. |= Parameter 1
|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'''''.


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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



Revision as of 18:18, 2 October 2014


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:
call
Groups:
Uncategorised

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 - Determines angle offset. Optional parameter, default 0.
Return Value:
Nothing

Examples

Example 1:
0 = [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

Notes

Bottom Section