formation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(64 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<h2 style="color:#000066">'''formation ''grp'''''</h2>
{{RV|type=command


'''Operand types:'''
|game1= ofp
|version1= 1.00


grp: [[Object]] or [[Group]]
|game2= ofpe
|version2= 1.00


'''Type of returned value:'''
|game3= arma1
|version3= 1.00


[[String]]
|game4= arma2
|version4= 1.00


'''Description:'''
|game5= arma2oa
|version5= 1.50


Formation of the group.
|game6= tkoh
|version6= 1.00


Can be one of:
|game7= arma3
|version7= 0.50


    * "COLUMN"
|gr1= Groups
    * "STAG COLUMN"
    * "WEDGE"
    * "ECH LEFT"
    * "ECH RIGHT"
    * "VEE"
    * "LINE"


'''Example:'''
|arg= global


_state = '''formation''' group player
|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"
}}
 
|x1= <sqf>if (formation group player == "wedge") then { hint "this is the default formation" };</sqf>
 
|seealso= [[2D Editor: Waypoints#Formation|Formations Description]] [[formLeader]] [[setFormation]]
}}

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