groupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Fix)
 
(7 intermediate revisions by the same user not shown)
Line 8: Line 8:
|arg= global
|arg= global


|descr= Returns group name.
|descr= Returns a group's name or a unit's group ID number.


|s1= [[groupId]] group
|s1= [[groupId]] group


|p1= group: [[Group]]
|p1= group: [[Group]]


|r1= [[String]]
|r1= [[String]] - the group's name (e.g "Alpha Red")


|x1= <code>_name = [[groupId]] ([[group]] [[player]]);</code>
|s2= [[groupId]] unit


|seealso= [[setGroupId]], [[setGroupIdGlobal]], [[group]]
|s2since= arma3 2.12
 
|p21= unit: [[Object]] - a group's unit
 
|r2= [[Number]] - the unit's group ID (e.g "'''2''', taking command")
 
|x1= <sqf>_name = groupId group player; // e.g "B Alpha 1-1"</sqf>
 
|x2= <sqf>private _unitGroupId = groupId player; // e.g 3 (number, not a string)</sqf>
 
|seealso= [[setGroupId]] [[setGroupIdGlobal]] [[group]]
}}
}}

Latest revision as of 13:45, 18 January 2023

Hover & click on the images for description

Description

Description:
Returns a group's name or a unit's group ID number.
Groups:
Groups

Syntax

Syntax:
groupId group
Parameters:
group: Group
Return Value:
String - the group's name (e.g "Alpha Red")

Alternative Syntax

Syntax:
groupId unit
Parameters:
unit: Object - a group's unit
Return Value:
Number - the unit's group ID (e.g "2, taking command")

Examples

Example 1:
_name = groupId group player; // e.g "B Alpha 1-1"
Example 2:
private _unitGroupId = groupId player; // e.g 3 (number, not a string)

Additional Information

See also:
setGroupId setGroupIdGlobal group

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