canAddItemToUniform: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Replacing category Scripting Commands Arma 3 with Arma 3: Scripting Commands)
m (Text replacement - "since= Arma3" to "since= arma3")
 
(48 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
____________________________________________________________________________________________


| 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
|s1= unit [[canAddItemToUniform]] item


|p1= unit: [[Object]] |= Parameter 1
|p1= unit: [[Object]]
|p2= item: [[String]] |= Parameter 2
| [[Boolean]] |= RETURNVALUE


| s2 =unit '''canAddItemToUniform''' [item, count]       (''Since Arma 3 v1.55.133607'') |= Syntax
|p2= item: [[String]]


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


| r2= [[Boolean]] |= RETURNVALUE
|s2= unit [[canAddItemToUniform]] [item, count, ignoreSoldierMaxLoad]


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


____________________________________________________________________________________________
|p21= unit: [[Object]]


| [[canAdd]], [[canAddItemToBackpack]], [[canAddItemToVest]] |= SEEALSO
|p22= item: [[String]]


| |= MPBEHAVIOUR
|p23= count: [[Number]]
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|p24= ignoreSoldierMaxLoad (Optional): [[Boolean]] - [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted. Default: [[false]]
<dl class='command_description'>
|p24since= arma3 2.18
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r2= [[Boolean]]
</dl>


<h3 style='display:none'>Bottom Section</h3>
|x1= <sqf>_item = "HandGrenade";
_fits = player canAddItemToUniform _item;
if (_fits) then {
player addItemToUniform _item;
} else {
hint "no room!";
};</sqf>


[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|seealso= [[canAdd]] [[canAddItemToBackpack]] [[canAddItemToVest]]
[[Category:Arma 3: Scripting Commands]]
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:26, 9 February 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.
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=352414"