BIS fnc invAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "True" to "true")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 7: Line 6:


|gr1 = Inventory |GROUP1=
|gr1 = Inventory |GROUP1=
____________________________________________________________________________________________


|Adds item to inventory - checks if there is room for it. Checks if add was done by engine.|Description=
|Adds item to inventory - checks if there is room for it. Checks if add was done by engine.|Description=
____________________________________________________________________________________________


| [object,class,force] call [[BIS_fnc_invAdd]] |Syntax=
| [object,class,force] call [[BIS_fnc_invAdd]] |Syntax=
Line 22: Line 19:
| [[Boolean]] or [[Array]] - [[true]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)|Return value=
| [[Boolean]] or [[Array]] - [[true]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)|Return value=


____________________________________________________________________________________________


|x1= <code>[ [[player]],"someClass" ] [[call]] [[BIS_fnc_invAdd]];</code>|Example 1=
|x1= <code>[ [[player]],"someClass" ] [[call]] [[BIS_fnc_invAdd]];</code>|Example 1=


____________________________________________________________________________________________


| [[BIS_fnc_invRemove]], [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]] |See also=
| [[BIS_fnc_invRemove]], [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]] |See also=

Revision as of 00:26, 17 January 2021

Hover & click on the images for description

Description

Description:
Adds item to inventory - checks if there is room for it. Checks if add was done by engine.
Execution:
call
Groups:
Inventory

Syntax

Syntax:
[object,class,force] call BIS_fnc_invAdd
Parameters:
object: Object
class: String - Item class to be added
force: Boolean - (Optional, default false) true to force add item, other items might be removed
Return Value:
Boolean or Array - true when successfull, Array if force is set to true and items were removed (retuns items)

Examples

Example 1:
[ player,"someClass" ] call BIS_fnc_invAdd;

Additional Information

See also:
BIS_fnc_invRemoveBIS_fnc_invCodeToArrayBIS_fnc_invStringBIS_fnc_invSlotsBIS_fnc_invSlotsEmptyBIS_fnc_invSlotType

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