BIS fnc invAdd: Difference between revisions

Latest revision as of 17:27, 8 November 2023

1.00

1.50

1.00

0.50

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_invRemove BIS_fnc_invCodeToArray BIS_fnc_invString BIS_fnc_invSlots BIS_fnc_invSlotsEmpty BIS_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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2 |Game name=
+|game1= arma2
+|version1= 1.00
-|1.00|Game version=
+|game2= arma2oa
+|version2= 1.50
-|gr1 = Inventory |GROUP1=
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-|Adds item to inventory - checks if there is room for it. Checks if add was done by engine.|Description=
+|game4= arma3
-____________________________________________________________________________________________
+|version4= 0.50
-| [object,class,force] call [[BIS_fnc_invAdd]] |Syntax=
+|gr1= Inventory
-|p1=object: [[Object]] |Parameter 1=
+|descr=Adds item to inventory - checks if there is room for it. Checks if add was done by engine.
-|p2=class: [[String]] - Item class to be added |Parameter 2=
+|s1= [object,class,force] call [[BIS_fnc_invAdd]]
-|p3=force: [[Boolean]] - (Optional, default [[false]]) [[True]] to force add item, other items might be removed |Parameter 3=
+|p1=object: [[Object]]
-| [[Boolean]] or [[Array]] - [[True]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)|Return value=
+|p2=class: [[String]] - item class to be added
-____________________________________________________________________________________________
+|p3=force: [[Boolean]] - (Optional, default [[false]]) [[true]] to force add item, other items might be removed
-|x1= <code>[ [[player]],"someClass" ] [[call]] [[BIS_fnc_invAdd]];</code>|Example 1=
+|r1= [[Boolean]] or [[Array]] - [[true]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)
-____________________________________________________________________________________________
+|x1= <sqf>[player,"someClass"] call BIS_fnc_invAdd;</sqf>
-| [[BIS_fnc_invRemove]], [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]] |See also=
+|seealso= [[BIS_fnc_invRemove]] [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invString]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Functions|{{uc:invAdd}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:invAdd}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:invAdd}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:invAdd}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:invAdd}}]]