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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.24
-| arma3 |= Game name
+|gr1= Inventory
-|1.00|= Game version
+|descr=Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]]
-	Description:
+|p1=object: [[Object]] - object from which items will be removed
-	Remove virtual items from an object (e.g., ammo box).
-	Virtual items can be selected in the Arsenal.
-	Parameter(s):
+|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - item classes
-: OBJECT - objct from which items will be removed
-: STRING or ARRAY of STRINGs - item class(es) to be removed
-(Optional): BOOL - true to remove items globally (default: false)
-	Returns:
+|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally
-	ARRAY of ARRAYs - all virtual items within the object's space in format [<items>,<weapons>,<magazines>,<backpacks>]
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|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
-| <!-- [] call [[BIS_fnc_removeVirtualItemCargo]]; --> |= Syntax
+|x1= <sqf>[BIS_ammoBox, ["class_1","class_2"], true] call BIS_fnc_removeVirtualItemCargo;</sqf>
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code>[ _box , "U_B_CombatUniform_mcam", true ] call BIS_fnc_removeVirtualItemCargo; // removes the item global from the virtualArsenal of the _box </code> |= Example 1
-|x2= <code>[ _box , ["U_B_CombatUniform_mcam","H_Booniehat_mcamo"] ] call BIS_fnc_removeVirtualItemCargo; // removes the content in the Array from the virtualArsenal of the _box </code> |= Example 2
-|x3= <code>[ _box , (_box call BIS_fnc_getVirtualItemCargo)] call BIS_fnc_removeVirtualItemCargo; // removes all virtualArsenal added items from the _box </code> |= Example 3
-____________________________________________________________________________________________
-| [[Arsenal]], [[BIS_fnc_getVirtualItemCargo]], [[BIS_fnc_addVirtualItemCargo]] |= See also
+|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]]
 }}
-<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}}]]