canAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> <dt></dt>" to "</dd> <dt></dt>")
m (Text replacement - "\|s1= +" to "|s1= ")
Line 8: Line 8:
|descr= Checks if given object can be stored in inventory of given object or any inventory container ([[uniform]], [[vest]], [[backpack]]) of given unit.
|descr= Checks if given object can be stored in inventory of given object or any inventory container ([[uniform]], [[vest]], [[backpack]]) of given unit.


|s1= object [[canAdd]] item
|s1= object [[canAdd]] item


|p1= object: [[Object]] - unit or container
|p1= object: [[Object]] - unit or container

Revision as of 16:38, 19 June 2021

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:
Unit Inventory

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] Template:Since
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


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]; };