canAddItemToUniform: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
(Added potential warning message: bad vehicle type if empty string is passed)
 
(6 intermediate revisions by 3 users not shown)
Line 7: Line 7:


|descr= Checks if given object can be stored into soldier's uniform.
|descr= Checks if given object can be stored into soldier's uniform.
{{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 [[canAddItemToUniform]] item
|s1= unit [[canAddItemToUniform]] item
Line 16: Line 22:
|r1= [[Boolean]]
|r1= [[Boolean]]


|s2= unit [[canAddItemToUniform]] [item, count]
|s2= unit [[canAddItemToUniform]] [item, count, ignoreSoldierMaxLoad]


|s2since= arma3 1.56
|s2since= arma3 1.56
Line 22: Line 28:
|p21= unit: [[Object]]
|p21= unit: [[Object]]


|p22= [item, count]: [[Array]]
|p22= item: [[String]]


|p23= item: [[String]]
|p23= count: [[Number]]


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


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


|x1= <code>_item = "HandGrenade";
|x1= <sqf>_item = "HandGrenade";
_fits = player canAddItemToUniform _item;
_fits = player canAddItemToUniform _item;
if (_fits) then {
if (_fits) then {
Line 36: Line 43:
} else {
} else {
hint "no room!";
hint "no room!";
};</code>
};</sqf>


|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToVest]]
|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToVest]]
}}
}}

Latest revision as of 18:27, 25 May 2024

Hover & click on the images for description

Description

Description:
Checks if given object can be stored into soldier's uniform.
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 canAddItemToUniform item
Parameters:
unit: Object
item: String
Return Value:
Boolean

Alternative Syntax

Syntax:
unit canAddItemToUniform [item, count, ignoreSoldierMaxLoad]
Parameters:
unit: Object
item: String
count: Number
since Arma 3 logo black.png2.18
ignoreSoldierMaxLoad (Optional): Boolean - true to ignore 'soldierMaxLoad' param, container maxLoad is still counted. Default: false
Return Value:
Boolean

Examples

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

Additional Information

See also:
canAdd canAddItemToBackpack canAddItemToVest

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