squadParams: Difference between revisions

Latest revision as of 15:15, 21 November 2023

1.18

GAGlobal

Hover & click on the images for description

Description

Description:: Returns data about squad of given unit loaded from squad.xml as well as the unit itself.
ⓘ
This command returns an empty array in single player.
Groups:: Object Manipulation System

Syntax

Syntax:

squadParams unit

Parameters:

unit: Object

Return Value:

Array in format [squadInfo, memberInfo, squadId, a3unitsId] where:

squadInfo: Array of Strings format [nick, name, email, web, picture, title]
memberInfo: Array of Strings format [uid, name, fullname, email, icq, remark]
2.06 squadId: String - unique squad ID
2.06 a3unitsId: String - unique Arma 3 Units ID

Examples

Example 1:: _info = squadParams player;
Example 2:: squadParams player params ["_squadInfo", "_memberInfo", "_squadID", "_a3unitsID"];

Additional Information

See also:: squad.xml

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.18
-|1.18|= Game version
+|arg= global
-____________________________________________________________________________________________
+|gr1= Object Manipulation
-| Returns data about squad of given unit loaded from squad.xml. |= Description
+|gr2= System
-____________________________________________________________________________________________
-| '''squadParams''' unit |= Syntax
+|descr= Returns data about squad of given unit loaded from [[squad.xml]] as well as the unit itself.
+{{Feature|informative|This command returns an empty array in single player.}}
-|p1= unit: [[Object]] |= Parameter 1
+|s1= [[squadParams]] unit
-| [[Array]] - <nowiki>[[</nowiki>squadNick,squadName,squadEmail,squadWeb,squadPicture,squadTitle],[memberId,memberNick,memberName,memberEmail,memberIcq,memberRemark<nowiki>]]</nowiki>|= Return value
+|p1= unit: [[Object]]
-____________________________________________________________________________________________
-|x1= <code>_info = squadParams player</code> |= Example 1
-____________________________________________________________________________________________
-| [[squad.xml]] |= See also
+|r1= [[Array]] in format [squadInfo, memberInfo, squadId, a3unitsId] where:
+* squadInfo: [[Array]] of [[String]]s format [nick, name, email, web, picture, title]
+* memberInfo: [[Array]] of [[String]]s format [uid, name, fullname, email, icq, remark]
+* {{GVI|arma3|2.06|size= 0.75}} squadId: [[String]] - unique squad ID
+* {{GVI|arma3|2.06|size= 0.75}} a3unitsId: [[String]] - unique {{arma3}} Units  ID
-}}
+|x1= <sqf>_info = squadParams player;</sqf>
-<h3 style="display:none">Notes</h3>
+|x2= <sqf>squadParams player params ["_squadInfo", "_memberInfo", "_squadID", "_a3unitsID"];</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|seealso= [[squad.xml]]
-</dl>
+}}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]