BIS fnc invRemove: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|gr1 = Inventory | |gr1 = Inventory | ||
|Removes from inventory. Given number of items. Returns actually removed items count. | |Removes from inventory. Given number of items. Returns actually removed items count. | ||
| [object,class,count] call [[BIS_fnc_invRemove]] | | [object,class,count] call [[BIS_fnc_invRemove]] | ||
|p1=object: [[Object]] | |p1=object: [[Object]] | ||
|p2=class: [[String]] - Item class to be added | |p2=class: [[String]] - Item class to be added | ||
|p3=count: [[Number]] - (Optional, default 1) Number of items to be removed | |p3=count: [[Number]] - (Optional, default 1) Number of items to be removed | ||
| [[Number]] - Number of items which were removed | | [[Number]] - Number of items which were removed | ||
|x1= <code>[ [[player]],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code> | |x1= <code>[ [[player]],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code> | ||
| [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] | | [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] | ||
}} | }} | ||
Revision as of 00:09, 18 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