BIS fnc invAdd: Difference between revisions

From Bohemia Interactive Community
m (1 revision)
m (pf)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
|Adds item to inventory - checks if there is room for it. Checks if add was done by engine.|Description=
/*
____________________________________________________________________________________________
File: fn_invAdd.sqf


Description:
| [object,class,force] call [[BIS_fnc_invAdd]] |Syntax=
Adds item to inventory - checks if there is room for it. Checks if add was done by engine.


Parameter(s):
|p1=object: [[Object]] |Parameter 1=
1: <object> unit
2: <string | config class> inventory item (weapon | magazine | other item) - name or class


Returns:
|p2=class: [[String]] - Item class to be added |Parameter 2=
<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
|p3=force: [[Boolean]] - (Optional, default [[false]]) [[True]] to force add item, other items might be removed |Parameter 3=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_invAdd]]; --> |= Syntax
| [[Boolean]] or [[Array]] - [[True]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)|Return value=


|p1= |= Parameter 1
____________________________________________________________________________________________


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


|x1= <code></code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 23:40, 27 June 2018

Logo A2.png 1.00
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:
Uncategorised

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_invAdd&oldid=108740"