canAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|SYNTAX= |p21=" to "|SYNTAX2= |p21=")
m (Text replacement - "|PARAMETER1= |p22=" to "|PARAMETER21= |p22=")
Line 20: Line 20:
|  s2 =object '''canAdd''' [item, count]       (''Since Arma 3 v1.55.133607'') |SYNTAX2=
|  s2 =object '''canAdd''' [item, count]       (''Since Arma 3 v1.55.133607'') |SYNTAX2=


|p21= object: [[Object]] - unit or container  |PARAMETER1=  
|p21= object: [[Object]] - unit or container  |PARAMETER21=
|p22= [item, count]: [[Array]] |PARAMETER1=  
|p22= [item, count]: [[Array]] |PARAMETER1=  
|p23= item: [[String]] - Config class |PARAMETER2=  
|p23= item: [[String]] - Config class |PARAMETER2=  

Revision as of 22:26, 19 December 2019

Hover & click on the images for description

Description

Description:
Checks if given object can be stored in inventory of given object or any inventory container (uniform, vest, backpack) of given unit.
Groups:
Uncategorised

Syntax

Syntax:
object canAdd item
Parameters:
object: Object - unit or container
item: String - Config class
Return Value:
Boolean

Alternative Syntax

Syntax:
object canAdd [item, count]       (Since Arma 3 v1.55.133607)
Parameters:
object: Object - unit or container
[item, count]: Array
item: String - Config class
count: Number - desired quantity
Return Value:
Boolean

Examples

Example 1:
if (player canAdd "FirstAidKit") then { player addItem "FirstAidKit"; } else { hint "Not enough space"; };
Example 2:
if (_box canAdd "FirstAidKit") then { _box addWeaponCargo ["FirstAidKit", 1]; } else { hint "Not enough space"; };
Example 3:
car canAdd [currentWeapon player, 50];

Additional Information

See also:
canAddItemToBackpackcanAddItemToUniformcanAddItemToVest

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

Notes

Bottom Section

Posted on November 29, 2015 - 00:02 (UTC)
Jonpas
Can also be used on any object that has inventory, not only player inventory containers.

Where _box is B_supplyCrate_F: // Empty _box canAdd "FirstAidKit"; -> true // Full _box canAdd "FirstAidKit"; -> false
Posted on February 11, 2017 - 18:40 (UTC)
Demellion
This can also be used as alternative to canAddItemToBackpack, canAddItemToUniform, canAddItemToVest where container might not be strictly defined.In some cases it might be a good optimisation for your code, where you also don't need to perform checks on which type of player container this is. Example:
_i = [(uniformContainer player),(vestContainer player),(backpackContainer player)] call BIS_fnc_selectRandom; if (_i canAdd "Rangefinder") then { _i addItemCargoGlobal ["Rangefinder",1]; };