canAddItemToUniform: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(40 intermediate revisions by 5 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


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


| Checks if given object can be stored into soldier's uniform. |DESCRIPTION=
{{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.
}}


| unit [[canAddItemToUniform]] item |SYNTAX=
|s1= unit [[canAddItemToUniform]] item


|p1= unit: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


|p2= item: [[String]] |PARAMETER2=
|p2= item: [[String]]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]
____________________________________________________________________________________________


|s2= unit [[canAddItemToUniform]] [item, count] {{since|arma3|1.55.133607|y}} |SYNTAX2=
|s2= unit [[canAddItemToUniform]] [item, count, ignoreSoldierMaxLoad]


|p21= unit: [[Object]]  |PARAMETER21=
|s2since= arma3 1.56


|p22= [item, count]: [[Array]] |PARAMETER22=
|p21= unit: [[Object]]


|p23= item: [[String]] |PARAMETER23=
|p22= item: [[String]]


|p24= count: [[Number]] |PARAMETER24=
|p23= count: [[Number]]


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


|x1= <code>_item = "HandGrenade";
|r2= [[Boolean]]
_fits = [[player]] [[canAddItemToUniform]] _item;
[[if]] (_fits) [[then]] {
[[player]] [[addItemToUniform]] _item;
} [[else]] {
[[hint]] "no room!";
};</code> |EXAMPLE1=


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


| [[canAdd]], [[canAddItemToBackpack]], [[canAddItemToVest]] |SEEALSO=
|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToVest]]
 
|  |MPBEHAVIOUR=
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:33, 3 September 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=369125"