Difference between revisions of "BIS fnc invRemove"

From Bohemia Interactive Community
Jump to navigation Jump to search
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>
+
|Removes from inventory. Given number of items. Returns actually removed items count.|Description=
/*
+
____________________________________________________________________________________________
File: fn_invRemove.sqf
 
  
Description:
+
| [object,class,count] call [[BIS_fnc_invRemove]] |Syntax=
Removes from inventory. Given number of items. Returns actually removed items count.
 
 
Parameter(s):
 
1: <object> unit
 
2: <string | config class> inventory item (weapon | magazine | other item) - name or class
 
3: <scalar> how items with given name/class much to remove
 
 
Returns:
 
<number> number of successfully removed items
 
 
Note: 2nd parameter is string that is both weapon and magazine, we handle as weapon (you you want to handle as magazine - handle magazine classname for it)
 
*/
 
  
 +
|p1=object: [[Object]] |Parameter 1=
  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
|p2=class: [[String]] - Item class to be added |Parameter 2=
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_invRemove]]; --> |= Syntax
+
|p3=count: [[Number]] - (Optional, default 1) Number of items to be removed |Parameter 3=
  
|p1= |= Parameter 1
+
| [[Number]] - Number of items which were removed|Return value=
  
| |= Return value
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code>[ [player],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code>|Example 1=
 +
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= 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 00:43, 28 June 2018

Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

Description

Description:
Removes from inventory. Given number of items. Returns actually removed items count.

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

Execution:
call
Multiplayer:
-
See also:
BIS_fnc_invCodeToArrayBIS_fnc_invStringBIS_fnc_invSlotsBIS_fnc_invSlotsEmptyBIS_fnc_invSlotTypeBIS_fnc_invAdd

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section