BIS fnc invRemove: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2") |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
|descr=Removes from inventory. Given number of items. Returns actually removed items count. | |descr=Removes from inventory. Given number of items. Returns actually removed items count. | ||
|s1=[object,class,count] call [[BIS_fnc_invRemove]] | |s1= [object,class,count] call [[BIS_fnc_invRemove]] | ||
|p1=object: [[Object]] | |p1=object: [[Object]] | ||
|p2=class: [[String]] - | |p2=class: [[String]] - item class to be added | ||
|p3=count: [[Number]] - (Optional, default 1) | |p3=count: [[Number]] - (Optional, default 1) number of items to be removed | ||
|r1= [[Number]] - | |r1= [[Number]] - number of items which were removed | ||
|x1= < | |x1= <sqf>[player,"someClass",5] call BIS_fnc_invRemove;</sqf> | ||
|seealso= [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invString]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]] [[BIS_fnc_invAdd]] | |seealso= [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invString]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]] [[BIS_fnc_invAdd]] | ||
}} | }} | ||
Latest revision as of 17:27, 8 November 2023
Description
- Description:
- Removes from inventory. Given number of items. Returns actually removed items count.
- Execution:
- call
- Groups:
- Inventory
Syntax
- Syntax:
- [object,class,count] call BIS_fnc_invRemove
- Parameters:
- object: Object
- class: String - item class to be added
- count: Number - (Optional, default 1) number of items to be removed
- Return Value:
- Number - number of items which were removed
Examples
- Example 1:
Additional Information
- See also:
- BIS_fnc_invCodeToArray BIS_fnc_invString BIS_fnc_invSlots BIS_fnc_invSlotsEmpty BIS_fnc_invSlotType BIS_fnc_invAdd
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