formation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fixed syntax and example)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(56 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Returns the current formation of a group. |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| '''formation''' grp |= Syntax
|game5= arma2oa
|version5= 1.50


|p1 = grp: [[Object]] or [[Group]] | = P1
|game6= tkoh
|version6= 1.00


| [[String]] -  returns either "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE" |= Return value
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50
 
|x1= <code>formation [[group]] [[player]]</code> |= Example 1
____________________________________________________________________________________________


| [[formLeader]], [[setFormation]] |= See also
|gr1= Groups


|arg= global
|descr= Returns the current formation of a group.
|s1= [[formation]]  target
|p1= target: [[Object]] or [[Group]]
|r1= [[String]] - can return:
{{Columns|3|
* "COLUMN"
* "STAG COLUMN"
* "WEDGE"
* "ECH LEFT"
* "ECH RIGHT"
* "VEE"
* "LINE"
* "FILE"
* "DIAMOND"
}}
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>if (formation group player == "wedge") then { hint "this is the default formation" };</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[2D Editor: Waypoints#Formation|Formations Description]] [[formLeader]] [[setFormation]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FORMATION]]
[[Category:Scripting Commands OFP 1.96|FORMATION]]
[[Category:Scripting Commands OFP 1.46|FORMATION]]
[[Category:Scripting Commands ArmA|FORMATION]]

Latest revision as of 14:00, 8 November 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns the current formation of a group.
Groups:
Groups

Syntax

Syntax:
formation target
Parameters:
target: Object or Group
Return Value:
String - can return:
  • "COLUMN"
  • "STAG COLUMN"
  • "WEDGE"
  • "ECH LEFT"
  • "ECH RIGHT"
  • "VEE"
  • "LINE"
  • "FILE"
  • "DIAMOND"

Examples

Example 1:
if (formation group player == "wedge") then { hint "this is the default formation" };

Additional Information

See also:
Formations Description formLeader setFormation

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=formation&oldid=348443"