canAddItemToVest: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class='command_description'>" to "<dl class="command_description">")
(Added potential warning message: bad vehicle type if empty string is passed)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
|version1= 1.04


|1.04
|gr1= Unit Inventory


|gr1= Unit Inventory
|descr= Checks if given object can be stored into soldier's vest.


| 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.
}}


| unit [[canAddItemToVest]] item
|s1= unit [[canAddItemToVest]] item


|p1= unit: [[Object]]
|p1= unit: [[Object]]
|p2= item: [[String]]
|p2= item: [[String]]
| [[Boolean]]


|s2= unit [[canAddItemToVest]] [item, count] {{Since|arma3|1.55.133607|y}}
|r1= [[Boolean]]
 
|s2= unit [[canAddItemToVest]] [item, count, ignoreSoldierMaxLoad]
 
|s2since= arma3 1.56


|p21= unit: [[Object]]
|p21= unit: [[Object]]
|p22= [item, count]: [[Array]]
 
|p23= item: [[String]]
|p22= item: [[String]]
|p24= count: [[Number]]
 
|p23= count: [[Number]]
 
|p24= ignoreSoldierMaxLoad: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted.
|p24since= arma3 2.18


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


|x1= <code>_item = "HandGrenade";
|x1= <sqf>
[[private]] _fits = [[player]] [[canAddItemToVest]] _item;
_item = "HandGrenade";
[[if]] (_fits) [[then]] {
private _fits = player canAddItemToVest _item;
[[player]] [[addItemToVest]] _item;
if (_fits) then {
} [[else]] {
player addItemToVest _item;
[[hint]] "no room!";
} else {
};</code>
hint "no room!";
};
</sqf>


|seealso= [[canAdd]], [[canAddItemToBackpack]], [[canAddItemToUniform]]
|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToUniform]]
}}
}}
<dl class="command_description">
</dl>

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