BIS fnc addVirtualWeaponCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
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>/*
|Add virtual weapons to an object (e.g., ammo box). Virtual items can be selected in the [[Arsenal]].|Description=
____________________________________________________________________________________________


Description:
| [object,weaponClasses,addItemsGlobal,arsenal] call [[BIS_fnc_addVirtualWeaponCargo]] |Syntax=
Add virtual weapons to an object (e.g., ammo box).
Virtual items can be selected in the Arsenal.


Parameter(s):
|p1=object: [[Object]] - Object to which items will be added|Parameter 1=
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:
|p2=weaponClasses: [[String]] or [[Array]] of [[String|strings]] - Weapon classes|Parameter 2=
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
|p3=addItemsGlobal: [[Boolean]] - (Optional, default [[false]]) [[True]] to add items globally|Parameter 3=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_addVirtualWeaponCargo]]; --> |= Syntax
|p4=arsenal: [[Boolean]] - (Optional, default [[true]]) [[True]] to add [[Arsenal]] action|Parameter 4=


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


| |= Return value
|x1= <code>[ BIS_ammoBox, ["class_1","class_2"], [[false]], [[true]] ] [[call]] [[BIS_fnc_addVirtualWeaponCargo]];</code>|Example 1=
____________________________________________________________________________________________


|x1= <code></code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_addVirtualBackpackCargo]] [[BIS_fnc_addVirtualItemCargo]] [[BIS_fnc_addVirtualMagazineCargo]] |= 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]] |See also=
}}


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 10:21, 23 June 2018

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

Syntax

Syntax:
[object,weaponClasses,addItemsGlobal,arsenal] call BIS_fnc_addVirtualWeaponCargo
Parameters:
object: Object - Object to which items will be added
weaponClasses: 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 arrays - All virtual items in objects's space in format:

Examples

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

Additional Information

See also:
ArsenalBIS_fnc_addVirtualBackpackCargoBIS_fnc_addVirtualItemCargoBIS_fnc_addVirtualMagazineCargoBIS_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


Notes

Bottom Section

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