BIS fnc invAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code> *([^<|{]*) *<\/code>" to "<sqf>$1</sqf>")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(2 intermediate revisions by the same user not shown)
Line 17: Line 17:
|descr=Adds item to inventory - checks if there is room for it. Checks if add was done by engine.
|descr=Adds item to inventory - checks if there is room for it. Checks if add was done by engine.


|s1=[object,class,force] call [[BIS_fnc_invAdd]]
|s1= [object,class,force] call [[BIS_fnc_invAdd]]


|p1=object: [[Object]]
|p1=object: [[Object]]


|p2=class: [[String]] - Item class to be added
|p2=class: [[String]] - item class to be added


|p3=force: [[Boolean]] - (Optional, default [[false]]) [[true]] to force add item, other items might be removed
|p3=force: [[Boolean]] - (Optional, default [[false]]) [[true]] to force add item, other items might be removed
Line 27: Line 27:
|r1= [[Boolean]] or [[Array]] - [[true]] when successfull, [[Array]] if force is set to [[true]] and items were removed (retuns items)
|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>
|x1= <sqf>[player,"someClass"] call BIS_fnc_invAdd;</sqf>


|seealso= [[BIS_fnc_invRemove]] [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invString]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]]
|seealso= [[BIS_fnc_invRemove]] [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invString]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]]
}}
}}

Latest revision as of 17:27, 8 November 2023

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