BIS fnc addVirtualItemCargo: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *arma3 * * *\| *([0-2]\.[0-9]{2}) * " to "|game1= arma3 |version1= $1 ") |
(added some more info) |
||
| Line 2: | Line 2: | ||
|game1= arma3 | |game1= arma3 | ||
|version1= 1.24 | |version1= 1.24 | ||
|gr1= Inventory | |gr1= Inventory | ||
|descr=Add virtual items to an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]]. | |descr= Add virtual items to an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]]. If parameters 4 and 5 are used this function can replace [[BIS_fnc_addVirtualWeaponCargo]], [[BIS_fnc_addVirtualMagazineCargo]] and [[BIS_fnc_addVirtualBackpackCargo]]. | ||
|s1= [object, itemClasses, addItemsGlobal, arsenal, mode, itemType] call [[BIS_fnc_addVirtualItemCargo]] | |||
|p1= object: [[Object]] - Object to which items will be added | |||
|p2= itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String|strings]] - Item classes | |||
| | |p3= addItemsGlobal: [[Boolean]] - (Optional, default [[false]]) [[true]] to add items globally | ||
| | |p4= arsenal: [[Boolean]] - (Optional, default [[true]]) [[true]] to add [[Arsenal]] action | ||
| | |p5= mode: [[Number]] - (Optional, default 1) Defines what the function will do, can be: | ||
* -1 - remove given items | |||
* 0 - return current content | |||
* 1 - add given items | |||
| | |p6= itemType: [[Number]] - (Optional, default 1) Define the item type, can be: | ||
* 0 - items | |||
* 1 - weapons | |||
* 2 - magazines | |||
* 3 - backpacks | |||
|r1= [[Array]] of [[String|strings]] - All virtual items | |||
|r1=[[Array]] of [[String|strings]] - All virtual items | |||
|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[false]], [[true]] ] [[call]] [[BIS_fnc_addVirtualItemCargo]];</code> | |x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[false]], [[true]] ] [[call]] [[BIS_fnc_addVirtualItemCargo]];</code> | ||
Revision as of 11:24, 23 June 2021
Description
- Description:
- Add virtual items to an object (e.g., ammo box). Virtual items can be selected in the Arsenal. If parameters 4 and 5 are used this function can replace BIS_fnc_addVirtualWeaponCargo, BIS_fnc_addVirtualMagazineCargo and BIS_fnc_addVirtualBackpackCargo.
- Execution:
- call
- Groups:
- Inventory
Syntax
- Syntax:
- [object, itemClasses, addItemsGlobal, arsenal, mode, itemType] call BIS_fnc_addVirtualItemCargo
- Parameters:
- object: Object - Object to which items will be added
- itemClasses: Boolean, String or Array of strings - Item classes
- addItemsGlobal: Boolean - (Optional, default false) true to add items globally
- arsenal: Boolean - (Optional, default true) true to add Arsenal action
- mode: Number - (Optional, default 1) Defines what the function will do, can be:
- -1 - remove given items
- 0 - return current content
- 1 - add given items
- itemType: Number - (Optional, default 1) Define the item type, can be:
- 0 - items
- 1 - weapons
- 2 - magazines
- 3 - backpacks
- Return Value:
- Array of strings - All virtual items
Examples
- Example 1:
[ BIS_ammoBox, ["class_1","class_2"], false, true ] call BIS_fnc_addVirtualItemCargo;
Additional Information
- See also:
- ArsenalBIS_fnc_addVirtualBackpackCargoBIS_fnc_addVirtualMagazineCargoBIS_fnc_addVirtualWeaponCargoBIS_fnc_arsenalBIS_fnc_getVirtualBackpackCargoBIS_fnc_getVirtualItemCargoBIS_fnc_getVirtualMagazineCargoBIS_fnc_getVirtualWeaponCargoBIS_fnc_removeVirtualBackpackCargoBIS_fnc_removeVirtualItemCargoBIS_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
- Posted on October 16, 2014 - 23:55 (UTC)
- Kamaradski
-
In AmmoboxInit mode, for the ammobox to ONLY contain your white-listed items in the ammobox, you should first issue the BIS_fnc_removeVirtualItemCargo command. Otherwise the box will contain non whitelisted clutter.
Example:["AmmoboxInit",[_myBox,true]] call BIS_fnc_arsenal; [_myBox,[true],true] call BIS_fnc_removeVirtualItemCargo; [_myBox,["U_B_CombatUniform_mcam","U_B_CombatUniform_mcam_tshirt"],true] call BIS_fnc_addVirtualItemCargo;