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 ") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|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] call [[BIS_fnc_addVirtualItemCargo]] | |s1= [object, itemClasses, addItemsGlobal, arsenal, mode, itemType] call [[BIS_fnc_addVirtualItemCargo]] | ||
|p1=object: [[Object]] - | |p1= object: [[Object]] - object to which items will be added | ||
|p2=itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String | |p2= itemClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - item classes | ||
|p3=addItemsGlobal: [[Boolean]] - (Optional, default [[false]]) [[true]] to add items globally | |p3= addItemsGlobal: [[Boolean]] - (Optional, default [[false]]) [[true]] to add items globally | ||
|p4=arsenal: [[Boolean]] - (Optional, default [[true]]) [[true]] to add [[Arsenal]] action | |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 0) define the item type, can be: | ||
* 0 - items | |||
* 1 - weapons | |||
* 2 - magazines | |||
* 3 - backpacks | |||
|r1= [[Array]] of [[String]]s - all virtual items | |||
< | |x1= <sqf>[BIS_ammoBox, ["class_1", "class_2"], false, true] call BIS_fnc_addVirtualItemCargo;</sqf> | ||
|seealso= [[Arsenal]] [[BIS_fnc_addVirtualBackpackCargo]] [[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]] [[BIS_fnc_removeVirtualWeaponCargo]] | |||
}} | |||
[ | |||
[ | |||
</ | {{Note | ||
|user= Kamaradski | |||
|timestamp= 20141016235500 | |||
|text= 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. | |||
<br><br> | |||
'''Example:''' | |||
<sqf> | |||
["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; | |||
</sqf> | |||
}} | |||
Latest revision as of 23:41, 10 July 2022
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 0) 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:
Additional Information
- See also:
- Arsenal BIS_fnc_addVirtualBackpackCargo 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 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
- Posted on Oct 16, 2014 - 23:55 (UTC)
-
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;