canAddItemToVest: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (2.16 -> 2.18)
(Added potential warning message: bad vehicle type if empty string is passed)
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:


|descr= Checks if given object can be stored into soldier's vest.
|descr= Checks if given object can be stored into soldier's vest.
{{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|400px|alt=Warning Message: Bad vehicle type|Warning Message: Bad vehicle type]]
This message will show once per mission restart.
}}


|s1= unit [[canAddItemToVest]] item
|s1= unit [[canAddItemToVest]] item
Line 26: Line 32:
|p23= count: [[Number]]
|p23= count: [[Number]]


|p24= ignoreSoldierMaxLoad (Optional): [[Boolean]] - [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted. Default: [[false]]
|p24= ignoreSoldierMaxLoad: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted.
|p24since= Arma3 2.18
|p24since= arma3 2.18


|r2= [[Boolean]]
|r2= [[Boolean]]

Latest revision as of 18:28, 25 May 2024

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:
Warning Message: Bad vehicle type
This message will show once per mission restart.
Groups:
Unit Inventory

Syntax

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

Alternative Syntax

Syntax:
unit canAddItemToVest [item, count, ignoreSoldierMaxLoad]
Parameters:
unit: Object
item: String
count: Number
since Arma 3 logo black.png2.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