BIS fnc addVirtualWeaponCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(46 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.24


| arma3 |= Game name
|gr1= Inventory


|1.00|= Game version
|descr=Add virtual weapons to an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].
____________________________________________________________________________________________


| <pre>/*
|s1= [object,weaponClasses,addItemsGlobal,arsenal] call [[BIS_fnc_addVirtualWeaponCargo]]


Description:
|p1=object: [[Object]] - object to which items will be added
Add virtual weapons to an object (e.g., ammo box).
Virtual items can be selected in the Arsenal.


Parameter(s):
|p2=weaponClasses: [[Boolean]], [[String]] or [[Array]] of [[String]]s - weapon classes
0: OBJECT - objct to which weapons will be added
1: STRING or ARRAY of STRINGs - weapon class(es) to be added
2 (Optional): BOOL - true to add weapons globally (default: false)
3 (Optional): BOOL - true to add Arsenal action (default: true)


Returns:
|p3=addItemsGlobal: [[Boolean]] - (Optional, default [[false]]) [[true]] to add items globally
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
|p4=arsenal: [[Boolean]] - (Optional, default [[true]]) [[true]] to add [[Arsenal]] action
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_addVirtualWeaponCargo]]; --> |= Syntax
|r1= [[Array]] of [[String]]s - all virtual weapons


|p1= |= Parameter 1
|x1= <sqf>[BIS_ammoBox, ["class_1","class_2"], false, true] call BIS_fnc_addVirtualWeaponCargo;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arsenal]] [[BIS_fnc_addVirtualBackpackCargo]] [[BIS_fnc_addVirtualItemCargo]] [[BIS_fnc_addVirtualMagazineCargo]] [[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]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Inventory|{{uc:addVirtualWeaponCargo}}]]
[[Category:Functions|{{uc:addVirtualWeaponCargo}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addVirtualWeaponCargo}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

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

Syntax

Syntax:
[object,weaponClasses,addItemsGlobal,arsenal] call BIS_fnc_addVirtualWeaponCargo
Parameters:
object: Object - object to which items will be added
weaponClasses: Boolean, String or Array of Strings - weapon classes
addItemsGlobal: Boolean - (Optional, default false) true to add items globally
arsenal: Boolean - (Optional, default true) true to add Arsenal action
Return Value:
Array of Strings - all virtual weapons

Examples

Example 1:
[BIS_ammoBox, ["class_1","class_2"], false, true] call BIS_fnc_addVirtualWeaponCargo;

Additional Information

See also:
Arsenal BIS_fnc_addVirtualBackpackCargo BIS_fnc_addVirtualItemCargo BIS_fnc_addVirtualMagazineCargo 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