BIS fnc removeVirtualItemCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (typo)
m (pf)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.24|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
|Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].|Description=
 
____________________________________________________________________________________________
Description:
Remove virtual items from an object (e.g., ammo box).
Virtual items can be selected in the Arsenal.


Parameter(s):
| [object,itemClasses,removeGlobally] call [[BIS_fnc_removeVirtualItemCargo]] |Syntax=
0: OBJECT - object from which items will be removed
1: STRING or ARRAY of STRINGs - item class(es) to be removed
2 (Optional): BOOL - true to remove items globally (default: false)


Returns:
|p1=object: [[Object]] - Object from which items will be removed|Parameter 1=
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
|p2=itemClasses: [[String]] or [[Array]] of [[String|strings]] - Item classes|Parameter 2=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeVirtualItemCargo]]; --> |= Syntax
|p3=removeGlobally: [[Boolean]] - (Optional, default [[false]]) [[True]] to remove items globally|Parameter 3=


|p1= |= Parameter 1
| [[Array]] of [[Array|arrays]] - All virtual items in objects's space in format:
 
*0: [[Array]] - Items
| |= Return value
*1: [[Array]] - Weapons
*2: [[Array]] - Magazines
*3: [[Array]] - Backpacks|Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[ _box , "U_B_CombatUniform_mcam", true ] call BIS_fnc_removeVirtualItemCargo; // removes the item global from the virtualArsenal of the _box </code> |= Example 1
|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[true]] ] [[call]] [[BIS_fnc_removeVirtualItemCargo]];</code>|Example 1=


|x2= <code>[ _box , ["U_B_CombatUniform_mcam","H_Booniehat_mcamo"] ] call BIS_fnc_removeVirtualItemCargo; // removes the content in the Array from the virtualArsenal of the _box </code> |= Example 2
|x3= <code>[ _box , (_box call BIS_fnc_getVirtualItemCargo)] call BIS_fnc_removeVirtualItemCargo; // removes all virtualArsenal added items from the _box </code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Arsenal]], [[BIS_fnc_getVirtualItemCargo]], [[BIS_fnc_addVirtualItemCargo]] |= 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]] |See also=
 
}}
}}


Revision as of 10:25, 23 June 2018

Arma 3 logo black.png1.24
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:
Uncategorised

Syntax

Syntax:
[object,itemClasses,removeGlobally] call BIS_fnc_removeVirtualItemCargo
Parameters:
object: Object - Object from which items will be removed
itemClasses: 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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_removeVirtualItemCargo&oldid=108650"