squadParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Some wiki formatting)
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.18


|1.18|Game version=
|arg= global


|arg= global|Multiplayer Arguments=
|gr1= Object Manipulation


|gr1= Object Manipulation |GROUP1=
|gr2= System


|gr2= System |GROUP2=
|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.}}


____________________________________________________________________________________________
|s1= [[squadParams]] unit


| Returns data about squad of given unit loaded from squad.xml.<br>
|p1= unit: [[Object]]
All items in returned array are [[String]].  |DESCRIPTION=
____________________________________________________________________________________________


| '''squadParams''' unit |SYNTAX=
|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


|p1= unit: [[Object]] |PARAMETER1=
|x1= <sqf>_info = squadParams player;</sqf>


| [[Array]] - <nowiki>[[</nowiki>squadNick,squadName,squadEmail,squadWeb,squadPicture,squadTitle],[memberId,memberNick,memberName,memberEmail,memberIcq,memberRemark<nowiki>]]</nowiki>|RETURNVALUE=
|x2= <sqf>squadParams player params ["_squadInfo", "_memberInfo", "_squadID", "_a3unitsID"];</sqf>
____________________________________________________________________________________________
 
|x1= <code>_info = [[squadParams]] [[player]];</code> |EXAMPLE1=
____________________________________________________________________________________________
 
| [[squad.xml]] |SEEALSO=


|seealso= [[squad.xml]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 19, 2015 - 21:43 (UTC)</dd>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dd class="note">
Returns an empty array in singleplayer.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 15:15, 21 November 2023

Arma 3 logo black.png1.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 ManipulationSystem

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]
  • Arma 3 logo black.png2.06 squadId: String - unique squad ID
  • Arma 3 logo black.png2.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
Retrieved from "https://community.bistudio.com/wiki?title=squadParams&oldid=350054"