BIS fnc invRemove: Difference between revisions

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


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


|Removes from inventory. Given number of items. Returns actually removed items count.|Description=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [object,class,count] call [[BIS_fnc_invRemove]] |Syntax=
|game4= arma3
|version4= 0.50


|p1=object: [[Object]] |Parameter 1=
|gr1= Inventory


|p2=class: [[String]] - Item class to be added |Parameter 2=
|descr=Removes from inventory. Given number of items. Returns actually removed items count.


|p3=count: [[Number]] - (Optional, default 1) Number of items to be removed |Parameter 3=
|s1= [object,class,count] call [[BIS_fnc_invRemove]]


| [[Number]] - Number of items which were removed|Return value=
|p1=object: [[Object]]


____________________________________________________________________________________________
|p2=class: [[String]] - item class to be added


|x1= <code>[ [[player]],"someClass",5 ] [[call]] [[BIS_fnc_invRemove]];</code>|Example 1=
|p3=count: [[Number]] - (Optional, default 1) number of items to be removed


____________________________________________________________________________________________
|r1= [[Number]] - number of items which were removed


| [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invString]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] |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"