canAddItemToUniform: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
(Added potential warning message: bad vehicle type if empty string is passed)
 
(44 intermediate revisions by 4 users not shown)
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 uniform. |DESCRIPTION=
|descr= Checks if given object can be stored into soldier's uniform.
____________________________________________________________________________________________


| unit '''canAddItemToUniform''' 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|400px|alt=Warning Message: Bad vehicle type|Warning Message: Bad vehicle type]]
This message will show once per mission restart.
}}


|p1= unit: [[Object]] |PARAMETER1=
|s1= unit [[canAddItemToUniform]] item
|p2= item: [[String]] |PARAMETER2=
| [[Boolean]] |RETURNVALUE=


| s2 =unit '''canAddItemToUniform''' [item, count]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.55.133607'') |SYNTAX=
|p1= unit: [[Object]]


|p21= unit: [[Object]]  |PARAMETER1=
|p2= item: [[String]]
|p22= [item, count]: [[Array]] |PARAMETER1=
|p23= item: [[String]] |PARAMETER2=
|p24= count: [[Number]]  |PARAMETER1=


| r2= [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]


|x1= <code>_item = "HandGrenade";
|s2= unit [[canAddItemToUniform]] [item, count, ignoreSoldierMaxLoad]
_fits = [[player]] [[canAddItemToUniform]] _item;
[[if]] (_fits) [[then]] {
[[player]] [[addItemToUniform]] _item;
} [[else]] {
[[hint]] "no room!";
};</code>|EXAMPLE1=


____________________________________________________________________________________________
|s2since= arma3 1.56


| [[canAdd]], [[canAddItemToBackpack]], [[canAddItemToVest]] |SEEALSO=
|p21= unit: [[Object]]


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


<h3 style='display:none'>Notes</h3>
|r2= [[Boolean]]
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_item = "HandGrenade";
</dl>
_fits = player canAddItemToUniform _item;
if (_fits) then {
player addItemToUniform _item;
} else {
hint "no room!";
};</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToVest]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:27, 25 May 2024

Arma 3 logo black.png1.04
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
Retrieved from "https://community.bistudio.com/wiki?title=canAddItemToUniform&oldid=364686"