BIS fnc removeVirtualMagazineCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(46 intermediate revisions by 4 users not shown)
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 magazines from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].
____________________________________________________________________________________________


| <pre>/*
|s1= [object, magClasses, removeGlobally] call [[BIS_fnc_removeVirtualMagazineCargo]]


Description:
|p1= object: [[Object]] - object from which items will be removed
Remove virtual magazines from an object (e.g., ammo box).
Virtual items can be selected in the Arsenal.


Parameter(s):
|p2= magClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - magazine classes
0: OBJECT - objct from which magazines will be removed
1: STRING or ARRAY of STRINGs - magazine class(es) to be removed
2 (Optional): BOOL - true to remove magazines 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]]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
-->


| <!-- [] call [[BIS_fnc_removeVirtualMagazineCargo]]; --> |= Syntax
|x1= <sqf>[BIS_ammoBox, ["class_1", "class_2"], true] call BIS_fnc_removeVirtualMagazineCargo;</sqf>
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= 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_removeVirtualItemCargo]] [[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:removeVirtualMagazineCargo}}]]
[[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"