assignedItems: 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 (Text replacement - "since= Arma3" to "since= arma3")
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Unit Inventory


|gr1= Unit Inventory |GROUP1=
|descr= Get array with assigned items. The resulting [[Array]] order is not guaranteed. To check availability of a particular slot item use [[getSlotItemName]]. To return stored items see [[items]] and [[itemsWithMagazines]].
____________________________________________________________________________________________


| Get array with all assigned items. The resulting Array is sorted like: [<Map>, <Compass>, <Watch>, <Radio>, <GPS>, <NVG>, <Binoculars>]. But if something is missing it get's omitted so you can not be sure that some element is at a constant index. To return stored items see [[items]] and [[itemsWithMagazines]].
|s1= [[assignedItems]] unit
|DESCRIPTION=
____________________________________________________________________________________________


| '''assignedItems''' unit |SYNTAX=
|p1= unit: [[Object]]


|p1= unit: [[Object]] |PARAMETER1=
|r1= [[Array]] of [[String]]s


| [[Array]] |RETURNVALUE=  
|s2= [[assignedItems]] [unit, allItems, includeBinocs]
|s2since= arma3 2.14


|p21= unit: [[Object]] - soldier
|p22= allItems: [[Boolean]] - [[true]] to include all slot items, [[false]] exclude goggles and headgear
|p23= includeBinocs: [[Boolean]] - [[true]] to include binoculars (which is a weapon), [[false]] to exclude it


|x1= <code> [[hint]] [[str]] [[assignedItems]] [[player]];</code>|EXAMPLE1=
|r2= [[Array]] of [[String]]s


____________________________________________________________________________________________
|x1= <sqf>hint str assignedItems player;</sqf>


| [[assignItem]], [[unassignItem]], [[linkItem]], [[unlinkItem]], [[addItem]], [[removeItem]], [[removeAllAssignedItems]], [[items]], [[itemsWithMagazines]] |SEEALSO=
|seealso= [[getSlotItemName]] [[assignItem]] [[unassignItem]] [[linkItem]] [[unlinkItem]] [[addItem]] [[removeItem]] [[removeAllAssignedItems]] [[items]] [[itemsWithMagazines]] [[backpacks]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<dl class='command_description'>
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on June 18, 2013 - 14:20
<dt><dt>
<dt class="note">[[User:Druid|Druid]]<dd class="note">Arma 3, version 0.70 - headgear and goggles are not present in returned array now.<br>
<dd class="notedate">Posted on 2013-06-18 - 14:20</dd>
<dt class="note">[[User:Druid|Druid]]</dt>
<dd class="note">Arma 3, version 0.70 - headgear and goggles are not present in returned array now.<br>
<dt><dt>
<dd class="notedate">Posted on 2013-08-22 - 17:50</dd>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">For head gear use [[headgear]], [[addHeadgear]] and [[removeHeadgear]]. For goggles use [[goggles]], [[addGoggles]] and [[removeGoggles]]<br>


<dd class="notedate">Posted on August 22, 2013 - 17:50
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]<dd class="note">For head gear use [[headgear]], [[addHeadgear]] and [[removeHeadgear]]. For goggles use [[goggles]], [[addGoggles]] and [[removeGoggles]]<br>
<!-- Note Section END -->
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:26, 9 February 2024

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Get array with assigned items. The resulting Array order is not guaranteed. To check availability of a particular slot item use getSlotItemName. To return stored items see items and itemsWithMagazines.
Groups:
Unit Inventory

Syntax

Syntax:
assignedItems unit
Parameters:
unit: Object
Return Value:
Array of Strings

Alternative Syntax

Syntax:
assignedItems [unit, allItems, includeBinocs]
Parameters:
unit: Object - soldier
allItems: Boolean - true to include all slot items, false exclude goggles and headgear
includeBinocs: Boolean - true to include binoculars (which is a weapon), false to exclude it
Return Value:
Array of Strings

Examples

Example 1:
hint str assignedItems player;

Additional Information

See also:
getSlotItemName assignItem unassignItem linkItem unlinkItem addItem removeItem removeAllAssignedItems items itemsWithMagazines backpacks

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
Posted on 2013-06-18 - 14:20
Druid
Arma 3, version 0.70 - headgear and goggles are not present in returned array now.
Posted on 2013-08-22 - 17:50
Killzone_Kid
For head gear use headgear, addHeadgear and removeHeadgear. For goggles use goggles, addGoggles and removeGoggles
Retrieved from "https://community.bistudio.com/wiki?title=assignedItems&oldid=352417"