BIS fnc removeVirtualItemCargo: 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 (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.24|Game version=
|1.24


|gr1 = Inventory |GROUP1=
|gr1 = Inventory


|Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].|Description=
|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=
| [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: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - Item classes|Parameter 2=
|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - 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:
| [[Array]] of [[Array|arrays]] - All virtual items in objects's space in format:
Line 21: Line 21:
*1: [[Array]] - Weapons
*1: [[Array]] - Weapons
*2: [[Array]] - Magazines
*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= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualItemCargo]];</code>




| [[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=
| [[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]]
}}
}}



Revision as of 23:37, 17 January 2021

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:

Examples

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

Additional Information

See also:
ArsenalBIS_fnc_addVirtualBackpackCargoBIS_fnc_addVirtualItemCargoBIS_fnc_addVirtualMagazineCargoBIS_fnc_addVirtualWeaponCargoBIS_fnc_arsenalBIS_fnc_getVirtualBackpackCargoBIS_fnc_getVirtualItemCargoBIS_fnc_getVirtualMagazineCargoBIS_fnc_getVirtualWeaponCargoBIS_fnc_removeVirtualBackpackCargoBIS_fnc_removeVirtualMagazineCargoBIS_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

Bottom Section