BIS fnc invAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: fn_invAdd.sqf


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


Parameter(s):
|descr=Adds item to inventory - checks if there is room for it. Checks if add was done by engine.
1: <object> unit
2: <string | config class> inventory item (weapon | magazine | other item) - name or class


Returns:
|s1= [object,class,force] call [[BIS_fnc_invAdd]]
<bool> true if successfully added to inventory
or
when forcing add - <array> list of removed items (TODO: indicate fail to add)
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1=object: [[Object]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_invAdd]]; --> |= Syntax
|p2=class: [[String]] - item class to be added


|p1= |= Parameter 1
|p3=force: [[Boolean]] - (Optional, default [[false]]) [[true]] to force add item, other items might be removed


| |= Return value
|r1= [[Boolean]] or [[Array]] - [[true]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)
____________________________________________________________________________________________


|x1= <code></code> |=
|x1= <sqf>[player,"someClass"] call BIS_fnc_invAdd;</sqf>
____________________________________________________________________________________________
 
| |= 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:Function Group: Inventory|{{uc:invAdd}}]]
[[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}}]]

Latest revision as of 17:27, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_invAdd&oldid=349427"