canAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|0.70|Game version=
|0.70


|gr1= Unit Inventory |GROUP1=
|gr1= Unit Inventory


| Checks if given object can be stored in inventory of given object or any inventory container ([[uniform]], [[vest]], [[backpack]]) of given unit. |DESCRIPTION=
| Checks if given object can be stored in inventory of given object or any inventory container ([[uniform]], [[vest]], [[backpack]]) of given unit.


| object [[canAdd]] item |SYNTAX=
| object [[canAdd]] item


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


|p2= item: [[String]] - Config class |PARAMETER2=
|p2= item: [[String]] - Config class


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]


|s2= object [[canAdd]] [item, count] {{Since|arma3|1.55.133607|y}} |SYNTAX2=
|s2= object [[canAdd]] [item, count] {{Since|arma3|1.55.133607|y}}


|p21= object: [[Object]] - unit or container  |PARAMETER21=
|p21= object: [[Object]] - unit or container  |PARAMETER21=
Line 27: Line 27:
|p24= count: [[Number]] - desired quantity  |PARAMETER24=
|p24= count: [[Number]] - desired quantity  |PARAMETER24=


| r2= [[Boolean]] |RETURNVALUE2=
| r2= [[Boolean]]


|x1= <code>[[if]] ([[player]] [[canAdd]] "FirstAidKit") [[then]] {
|x1= <code>[[if]] ([[player]] [[canAdd]] "FirstAidKit") [[then]] {
Line 34: Line 34:
   [[hint]] "Not enough space";
   [[hint]] "Not enough space";
};
};
</code>|EXAMPLE1=
</code>


|x2= <code>[[if]] (_box [[canAdd]] "FirstAidKit") [[then]] {
|x2= <code>[[if]] (_box [[canAdd]] "FirstAidKit") [[then]] {
Line 41: Line 41:
   [[hint]] "Not enough space";
   [[hint]] "Not enough space";
};
};
</code>|EXAMPLE2=
</code>


|x3= <code>car [[canAdd]] [<nowiki/>[[currentWeapon]] [[player]], 50];</code> |EXAMPLE3=
|x3= <code>car [[canAdd]] [<nowiki/>[[currentWeapon]] [[player]], 50];</code>


| [[canAddItemToBackpack]], [[canAddItemToUniform]], [[canAddItemToVest]] |SEEALSO=
| [[canAddItemToBackpack]], [[canAddItemToUniform]], [[canAddItemToVest]]


| |MPBEHAVIOUR=
| |MPBEHAVIOUR=

Revision as of 01:09, 18 January 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

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