BIS fnc removeVirtualItemCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(11 intermediate revisions by the same user not shown)
Line 8: Line 8:
|descr=Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].
|descr=Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].


|s1=[object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]]
|s1= [object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]]


|p1=object: [[Object]] - Object from which items will be removed
|p1=object: [[Object]] - object from which items will be removed


|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - Item classes
|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - item classes


|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally
|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[true]] to remove items globally


|r1= [[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
*0: [[Array]] - Items
*1: [[Array]] - Weapons
*1: [[Array]] - Weapons
Line 22: Line 22:
*3: [[Array]] - Backpacks
*3: [[Array]] - Backpacks


|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualItemCargo]];</code>
|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]]
|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]]
}}
}}

Latest revision as of 17:27, 8 November 2023

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:
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