BIS fnc invRemove: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: fn_invRemove.sqf


Description:
|gr1= Inventory
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)
*/


|descr=Removes from inventory. Given number of items. Returns actually removed items count.


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [object,class,count] call [[BIS_fnc_invRemove]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_invRemove]]; --> |= Syntax
|p1=object: [[Object]]


|p1= |= Parameter 1
|p2=class: [[String]] - item class to be added


| |= Return value
|p3=count: [[Number]] - (Optional, default 1) number of items to be removed
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Number]] - number of items which were removed
____________________________________________________________________________________________


| |= See also
|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]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Inventory|{{uc:invRemove}}]]
[[Category:Functions|{{uc:invRemove}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:invRemove}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:invRemove}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:invRemove}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:invRemove}}]]

Latest revision as of 18:27, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

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_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_invRemove&oldid=349422"