BIS_fnc_arsenal

1.24

Hover & click on the images for description

Description

Description:

Function used for the Virtual Arsenal. The function features four different modes, each mode comes with its own parameters.

ⓘ

If Arsenal is launched within the first second from the mission start, the unit loadout will be randomised.

Execution:

call

Groups:

Inventory

Syntax

Syntax:

[mode, params] call BIS_fnc_arsenal

Parameters:

mode: String - mode, can be one of:

• "Open" - opens the Arsenal
• "Preload" - preloads item configs, without preloading the configs are parsed the first time it is opened
• "AmmoboxInit" - adds a virtual ammobox. Action to access the Arsenal will be added automatically to all clients
• "AmmoboxExit" - remove virtual ammobox

params: Anything - mode parameters:

• "Open": [full, cargo, center]
  • full: Boolean - (Optional, default false) true to open full Arsenal with all items available
  • cargo: Object to use as the cargo carrier (cargo is added with the BIS_fnc_addVirtualItemCargo functions)
  • center: Object whose arsenal will be modified
• "Preload": no parameters
• "AmmoboxInit": [ammobox, allItems, condition]
  • ammobox: Object - Object which should get a virtual ammobox
  • allItems: Boolean - (Optional, default false) true to make all items available
  • condition: Code - (Optional, default { true }) condition for the Arsenal to be accessible. Available arguments are the same as in addAction's condition parameter:
    • _target: Object - object to which the action is attached or, if the object is a unit inside of vehicle, the vehicle
    • _this: Object - caller person to whom the action is shown (or not depending on condition)
    • _originalTarget: Object - original object to which the action is attached, regardless if the object/unit is in a vehicle or not
• "AmmoboxExit": [ammobox]
  • ammobox: Object - the object to which the Arsenal was added

Return Value:

Nothing

Examples

Example 1:

// Opens Arsenal with all items ["Open", [true]] call BIS_fnc_arsenal;

Example 2:

// Preloads Arsenal's config ["Preload"] call BIS_fnc_arsenal;

Example 3:

// Adds full Arsenal to the player object and makes the action available when the player is closer than 10 meters from ammoBox ["AmmoboxInit", [ammoBox, true, { _this distance _target < 10 }]] call BIS_fnc_arsenal;

Example 4:

// Removes Arsenal from player object ["AmmoboxExit", player] call BIS_fnc_arsenal;

Additional Information

See also:

Arma 3: Arsenal BIS_fnc_garage

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