formation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \|(x[0-9]|p[0-9]{1,2}|descr|game[0-9]|version[0-9]|s[0-9]|exec|r[0-9]|arg|eff|branch|serverExec|gr[0-9]|mp|pr|seealso) +=" to " |$1=")
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(8 intermediate revisions by the same user not shown)
Line 28: Line 28:
|descr= Returns the current formation of a group.
|descr= Returns the current formation of a group.


|s1= '''formation''' target
|s1= [[formation]]  target


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


|r1= [[String]] - Can return:
|r1= [[String]] - can return:
* "COLUMN"
{{Columns|3|
* "COLUMN"
* "STAG COLUMN"
* "STAG COLUMN"
* "WEDGE"
* "WEDGE"
Line 42: Line 43:
* "FILE"
* "FILE"
* "DIAMOND"
* "DIAMOND"
}}


|x1= <code>'''formation''' [[group]] [[player]];</code>
|x1= <sqf>if (formation group player == "wedge") then { hint "this is the default formation" };</sqf>


|seealso= [[2D Editor: Waypoints#Formation|Formations Description]], [[formLeader]], [[setFormation]]
|seealso= [[2D Editor: Waypoints#Formation|Formations Description]] [[formLeader]] [[setFormation]]
}}
}}

Latest revision as of 15: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