BIS fnc removeVirtualMagazineCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Some wiki formatting)
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.24


|1.24|Game version=
|gr1= Inventory


|gr1 = Inventory |GROUP1=
|descr= Remove virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].


|Remove virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].|Description=
|s1= [object, magClasses, removeGlobally] call [[BIS_fnc_removeVirtualMagazineCargo]]


| [object,magClasses,removeGlobally] call [[BIS_fnc_removeVirtualMagazineCargo]] |Syntax=
|p1= object: [[Object]] - object from which items will be removed


|p1=object: [[Object]] - Object from which items will be removed|Parameter 1=
|p2= magClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - magazine classes


|p2=magClasses: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - Magazine classes|Parameter 2=
|p3= removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally


|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally|Parameter 3=
|r1= [[Array]] of [[Array]]s of all virtual items in objects's space in format [items, weapons, magazines, backpacks]<!--:
* 0: [[Array]] - Items
* 1: [[Array]] - Weapons
* 2: [[Array]] - Magazines
* 3: [[Array]] - Backpacks
-->


| [[Array]] of [[Array|arrays]] - All virtual items in objects's space in format:
|x1= <sqf>[BIS_ammoBox, ["class_1", "class_2"], true] call BIS_fnc_removeVirtualMagazineCargo;</sqf>
*0: [[Array]] - Items
*1: [[Array]] - Weapons
*2: [[Array]] - Magazines
*3: [[Array]] - Backpacks|Return value=


|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualMagazineCargo]];</code>|Example 1=
|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_removeVirtualItemCargo]] [[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_removeVirtualItemCargo]],[[BIS_fnc_removeVirtualWeaponCargo]] |See also=
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:removeVirtualMagazineCargo}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeVirtualMagazineCargo}}]]

Latest revision as of 00:02, 4 April 2024

Arma 3 logo black.png1.24
Hover & click on the images for description

Description

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

Syntax

Syntax:
[object, magClasses, removeGlobally] call BIS_fnc_removeVirtualMagazineCargo
Parameters:
object: Object - object from which items will be removed
magClasses: Boolean, String or Array of Strings - magazine classes
removeGlobally: Boolean - (Optional, default false) true to remove items globally
Return Value:
Array of Arrays of all virtual items in objects's space in format [items, weapons, magazines, backpacks]

Examples

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

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