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")
 
(61 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|F]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|F]]
[[Category:Scripting Commands OFP 1.46|F]]
[[Category:Scripting Commands ArmA|F]]


back to [[Scripting_Reference#F|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066">'''formation ''grp'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''grp:''' [[Object or Group]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[String]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= Groups


Formation of the group.
|arg= global


Can be one of:
|descr= Returns the current formation of a group.


|s1= [[formation]]  target
|p1= target: [[Object]] or [[Group]]
|r1= [[String]] - can return:
{{Columns|3|
* "COLUMN"
* "COLUMN"
* "STAG COLUMN"
* "STAG COLUMN"
Line 30: Line 41:
* "VEE"
* "VEE"
* "LINE"
* "LINE"
* "FILE"
* "DIAMOND"
}}


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


'''Example:'''
|seealso= [[2D Editor: Waypoints#Formation|Formations Description]] [[formLeader]] [[setFormation]]
 
}}
_state = '''formation''' [[group]] [[player]]

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