formation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<!-- Note Section [A-Z]+ --> " to "")
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= Groups
|gr1= Groups
Line 9: Line 26:
|arg= global
|arg= global


| Returns the current formation of a group.
|descr= Returns the current formation of a group.


| [[String]] <nowiki>=</nowiki> '''formation''' grp
|s1= [[formation]] target


|p1 = grp: [[Object]] or [[Group]] | = P1
|p1= target: [[Object]] or [[Group]]


| [[String]] - returns either "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE"
|r1= [[String]] - can return:
 
{{Columns|3|
|x1= <code>formation [[group]] [[player]]</code>
* "COLUMN"
 
* "STAG COLUMN"
| [[Mission_Editor:_Waypoints#Formation|formations description]], [[formLeader]], [[setFormation]]
* "WEDGE"
* "ECH LEFT"
* "ECH RIGHT"
* "VEE"
* "LINE"
* "FILE"
* "DIAMOND"
}}
}}


<dl class="command_description">
|x1= <sqf>if (formation group player == "wedge") then { hint "this is the default formation" };</sqf>
<dd class="notedate">Posted on January 9, 2007 - 03:16</dd>
<dt class="note">[[User:ColonelSandersLite|ColonelSandersLite]]<dd class="note"><br>
Additional ARMA Formations: "File" - Column Compact. "DIAMOND" - Delta.<br>


</dl>
|seealso= [[2D Editor: Waypoints#Formation|Formations Description]] [[formLeader]] [[setFormation]]
 
}}
 
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 14:00, 8 November 2023

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