removeAllAssignedItems: 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")
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


|0.50|Game version=
|arg= local


|arg= local |Multiplayer Arguments=
|eff= global


|eff= global |Multiplayer Effects=
|gr1= Unit Inventory


|gr1= Unit Inventory |GROUP1=
|descr= Unassigns and deletes all linked items from inventory.
____________________________________________________________________________________________
The commands operates on [[assignedItems]] array, which does not include goggles or headgear but includes binoculars, which is a weapon.<br>
Use [[removeGoggles]] and [[removeHeadgear]] for those.


| Unassigns and deletes all linked items from inventory. The commands operates on [[assignedItems]] array, which doesnt include goggles or headgear. Use [[removeGoggles]] and [[removeHeadgear]] for those.|DESCRIPTION=
|s1= [[removeAllAssignedItems]] unit
____________________________________________________________________________________________


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


|p1= unit: [[Object]] |PARAMETER1=
|r1= [[Nothing]]


| [[Nothing]] |RETURNVALUE=  
|s2= [[removeAllAssignedItems]] [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>[[removeAllAssignedItems]] [[player]];</code>|EXAMPLE1=
|r2= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>removeAllAssignedItems player;</sqf>


| [[assignedItems]], [[linkItem]], [[unlinkItem]], [[assignItem]], [[unassignItem]], [[addItem]], [[removeItem]], [[removeAllContainers]] |SEEALSO=
|seealso= [[assignedItems]] [[linkItem]] [[unlinkItem]] [[assignItem]] [[unassignItem]] [[addItem]] [[removeItem]] [[removeAllContainers]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</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

Hover & click on the images for description

Description

Description:
Unassigns and deletes all linked items from inventory. The commands operates on assignedItems array, which does not include goggles or headgear but includes binoculars, which is a weapon.
Use removeGoggles and removeHeadgear for those.
Groups:
Unit Inventory

Syntax

Syntax:
removeAllAssignedItems unit
Parameters:
unit: Object
Return Value:
Nothing

Alternative Syntax

Syntax:
removeAllAssignedItems [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:
Nothing

Examples

Example 1:
removeAllAssignedItems player;

Additional Information

See also:
assignedItems linkItem unlinkItem assignItem unassignItem addItem removeItem removeAllContainers

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