canAddItemToVest: Difference between revisions

Latest revision as of 11:33, 3 September 2024

1.04

Hover & click on the images for description

Description

Description:: Checks if given object can be stored into soldier's vest.
⚠
Avoid passing an empty string "" to this command as it will create a warning dialog:
This message will show once per mission restart.
Groups:: Unit Inventory

Syntax

Syntax:: unit canAddItemToVest item
Parameters:: unit: Object
: item: String
Return Value:: Boolean

1.56

Alternative Syntax

Syntax:: unit canAddItemToVest [item, count, ignoreSoldierMaxLoad]
Parameters:: unit: Object
: item: String
: count: Number
since 2.18: ignoreSoldierMaxLoad: Boolean - (Optional, default true) true to ignore 'soldierMaxLoad' param, container maxLoad is still counted.
Return Value:: Boolean

Examples

Example 1:: _item = "HandGrenade"; private _fits = player canAddItemToVest _item; if (_fits) then { player addItemToVest _item; } else { hint "no room!"; };

Additional Information

See also:: canAdd canAddItemToBackpack canAddItemToUniform

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.04
-|1.04|= Game version
+|gr1= Unit Inventory
-____________________________________________________________________________________________
-| Checks if given object can be stored into soldier's vest. |= Description
+|descr= Checks if given object can be stored into soldier's vest.
-____________________________________________________________________________________________
-| unit '''canAddItemToVest''' item |= Syntax
+{{Feature|important|
+Avoid passing an empty string <sqf inline>""</sqf> to this command as it will create a warning dialog:
+[[File:a3 warning badvehicletype.jpg|none|alt= Warning Message: Bad vehicle type|Warning Message: Bad vehicle type]]
+This message will show once per mission restart.
+}}
+|s1= unit [[canAddItemToVest]] item
+|p1= unit: [[Object]]
+|p2= item: [[String]]
+|r1= [[Boolean]]
+|s2= unit [[canAddItemToVest]] [item, count, ignoreSoldierMaxLoad]
-|p1= unit: [[Object]] |= Parameter 1
+|s2since= arma3 1.56
-|p2= item: [[String]] |= Parameter 2
-| [[Boolean]] |= RETURNVALUE
-|x1= <code>_item = "HandGrenade";
+|p21= unit: [[Object]]
-_fits = [[player]] [[canAddItemToVest]] _item;
-[[if]] (_fits) [[then]] {
-	[[player]] [[addItemToVest]] _item;
-} [[else]] {
-	[[hint]] "no room!";
-};</code>|= EXAMPLE1
-____________________________________________________________________________________________
+|p22= item: [[String]]
-| [[canAdd]], [[canAddItemToBackpack]], [[canAddItemToUniform]] |= SEEALSO
+|p23= count: [[Number]]
-|  |= MPBEHAVIOUR
+|p24= ignoreSoldierMaxLoad: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted.
-____________________________________________________________________________________________
+|p24since= arma3 2.18
-}}
-<h3 style='display:none'>Notes</h3>
+|r2= [[Boolean]]
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>
-</dl>
+_item = "HandGrenade";
+private _fits = player canAddItemToVest _item;
+if (_fits) then {
+	player addItemToVest _item;
+} else {
+	hint "no room!";
+};
+</sqf>
-<h3 style='display:none'>Bottom Section</h3>
+|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToUniform]]
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]