BIS fnc removeVirtualWeaponCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.24


|1.24
|gr1= Inventory


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


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


| [object,weaponClasses,removeGlobally] call [[BIS_fnc_removeVirtualWeaponCargo]]
|p1=object: [[Object]] - object from which items will be removed


|p1=object: [[Object]] - Object from which items will be removed
|p2=weaponClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - weapon classes
 
|p2=weaponClasses: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - Weapon classes


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


| [[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 23: Line 22:
*3: [[Array]] - Backpacks
*3: [[Array]] - Backpacks


|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualWeaponCargo]];</code>
|x1= <sqf>[BIS_ammoBox, ["class_1","class_2"], true] call BIS_fnc_removeVirtualWeaponCargo;</sqf>


| [[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_removeVirtualMagazineCargo]]
|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_removeVirtualMagazineCargo]]
}}
}}
[[Category:{{Name|arma3}}: Functions|{{uc:removeVirtualWeaponCargo}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

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

Syntax

Syntax:
[object,weaponClasses,removeGlobally] call BIS_fnc_removeVirtualWeaponCargo
Parameters:
object: Object - object from which items will be removed
weaponClasses: Boolean, String or Array of Strings - weapon 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_removeVirtualWeaponCargo;

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_removeVirtualMagazineCargo

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