BIS fnc invRemove: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Inventory(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma2 |Game name= | | arma2 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1 = Inventory |GROUP1= | |gr1 = Inventory |GROUP1= | ||
|Removes from inventory. Given number of items. Returns actually removed items count.|Description= | |Removes from inventory. Given number of items. Returns actually removed items count.|Description= | ||
| [object,class,count] call [[BIS_fnc_invRemove]] |Syntax= | | [object,class,count] call [[BIS_fnc_invRemove]] |Syntax= | ||
| Line 22: | Line 19: | ||
| [[Number]] - Number of items which were removed|Return value= | | [[Number]] - Number of items which were removed|Return value= | ||
|x1= <code>[ [[player]],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code>|Example 1= | |x1= <code>[ [[player]],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code>|Example 1= | ||
| [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] |See also= | | [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] |See also= | ||
Revision as of 23:23, 16 January 2021
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:
[ player,"someClass",5 ] call BIS_fnc_invRemove;
Additional Information
- See also:
- BIS_fnc_invCodeToArrayBIS_fnc_invStringBIS_fnc_invSlotsBIS_fnc_invSlotsEmptyBIS_fnc_invSlotTypeBIS_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