BIS fnc removeVirtualItemCargo: Difference between revisions

Latest revision as of 17:27, 8 November 2023

1.24

Hover & click on the images for description

Description

Description:: Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
Execution:: call
Groups:: Inventory

Syntax

Syntax:

[object,itemClasses,removeGlobally] call BIS_fnc_removeVirtualItemCargo

Parameters:

object: Object - object from which items will be removed

itemClasses: Boolean, String or Array of Strings - item classes

removeGlobally: Boolean - (Optional, default false) true to remove items globally

Return Value:

Array of arrays - all virtual items in objects's space in format:

0: Array - Items
1: Array - Weapons
2: Array - Magazines
3: Array - Backpacks

Examples

Example 1:: [BIS_ammoBox, ["class_1","class_2"], true] call BIS_fnc_removeVirtualItemCargo;

Additional Information

See also:: Arsenal BIS_fnc_addVirtualBackpackCargo BIS_fnc_addVirtualItemCargo BIS_fnc_addVirtualMagazineCargo BIS_fnc_addVirtualWeaponCargo BIS_fnc_arsenal BIS_fnc_getVirtualBackpackCargo BIS_fnc_getVirtualItemCargo BIS_fnc_getVirtualMagazineCargo BIS_fnc_getVirtualWeaponCargo BIS_fnc_removeVirtualBackpackCargo BIS_fnc_removeVirtualMagazineCargo BIS_fnc_removeVirtualWeaponCargo

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.24
-|1.24|Game version=
+|gr1= Inventory
-____________________________________________________________________________________________
-|Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].|Description=
+|descr=Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].
-____________________________________________________________________________________________
-| [object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]] |Syntax=
+|s1= [object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]]
-|p1=object: [[Object]] - Object from which items will be removed|Parameter 1=
+|p1=object: [[Object]] - object from which items will be removed
-|p2=itemClasses: [[String]] or [[Array]] of [[String|strings]] - Item classes|Parameter 2=
+|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - item classes
-|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[True]] to remove items globally|Parameter 3=
+|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally
-| [[Array]] of [[Array|arrays]] - All virtual items in objects's space in format:
+|r1= [[Array]] of [[Array|arrays]] - all virtual items in objects's space in format:
 *0: [[Array]] - Items
 *1: [[Array]] - Weapons
 *2: [[Array]] - Magazines
-*3: [[Array]] - Backpacks|Return value=
+*3: [[Array]] - Backpacks
-____________________________________________________________________________________________
-|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualItemCargo]];</code>|Example 1=
+|x1= <sqf>[BIS_ammoBox, ["class_1","class_2"], true] call BIS_fnc_removeVirtualItemCargo;</sqf>
-____________________________________________________________________________________________
+|seealso= [[Arsenal]] [[BIS_fnc_addVirtualBackpackCargo]] [[BIS_fnc_addVirtualItemCargo]] [[BIS_fnc_addVirtualMagazineCargo]] [[BIS_fnc_addVirtualWeaponCargo]] [[BIS_fnc_arsenal]] [[BIS_fnc_getVirtualBackpackCargo]] [[BIS_fnc_getVirtualItemCargo]] [[BIS_fnc_getVirtualMagazineCargo]] [[BIS_fnc_getVirtualWeaponCargo]] [[BIS_fnc_removeVirtualBackpackCargo]] [[BIS_fnc_removeVirtualMagazineCargo]] [[BIS_fnc_removeVirtualWeaponCargo]]
-| [[Arsenal]],[[BIS_fnc_addVirtualBackpackCargo]], [[BIS_fnc_addVirtualItemCargo]], [[BIS_fnc_addVirtualMagazineCargo]],[[BIS_fnc_addVirtualWeaponCargo]],[[BIS_fnc_arsenal]],[[BIS_fnc_getVirtualBackpackCargo]],[[BIS_fnc_getVirtualItemCargo]],[[BIS_fnc_getVirtualMagazineCargo]],[[BIS_fnc_getVirtualWeaponCargo]], [[BIS_fnc_removeVirtualBackpackCargo]], [[BIS_fnc_removeVirtualMagazineCargo]],[[BIS_fnc_removeVirtualWeaponCargo]] |See also=
 }}
-<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:removeVirtualItemCargo}}]]
-[[Category:Functions|{{uc:removeVirtualItemCargo}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:removeVirtualItemCargo}}]]