BIS fnc arsenal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(page overhault)
(added code comments)
Line 31: Line 31:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[ "Open", [ [[true]] ] [[call]] '''BIS_fnc_arsenal''';</code> |= example 1
|x1= <code>[ "Open", [ [[true]] ] [[call]] '''BIS_fnc_arsenal''';</code>{{codecomment|Opens [[Arsenal]] with all items}} |= example 1
|x2= <code>[ "Preload" ] [[call]] '''BIS_fnc_arsenal''';</code> |= example 2
|x2= <code>[ "Preload" ] [[call]] '''BIS_fnc_arsenal''';</code>{{codecomment|Preloads config for [[Arsenal]]}} |= example 2
|x3= <code>[ "AmmoboxInit", [ [[player]], [[true]], {(_this [[distance]] _target) < 10} ] ] [[call]] '''BIS_fnc_arsenal''';</code> |= example 3
|x3= <code>[ "AmmoboxInit", [ ammoBox, [[true]], {(_this [[distance]] _target) < 10} ] ] [[call]] '''BIS_fnc_arsenal''';</code>{{codecomment|Adds full [[Arsenal]] to [[player]] object and makes the [[addAction|action]] available when the player is as closer than 10 meters from ammoBox}} |= example 3
|x4= <code>[ "AmmoboxExit", [[player]] ] [[call]] '''BIS_fnc_arsenal''';</code> |= example 4
|x4= <code>[ "AmmoboxExit", [[player]] ] [[call]] '''BIS_fnc_arsenal''';</code>{{codecomment|Removes [[Arsenal]] from [[player]] object}} |= example 4
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 10:03, 13 May 2018

Hover & click on the images for description

Description

Description:
Function used for Virtual Arsenal. The function features four different modes, each mode comes with its own paramters.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[mode,params] call BIS_fnc_arsenal
Parameters:
mode: String - Mode, can be "Open", "Preload", "AmmoboxInit" and "AmmoboxExit"
params: Anything - Parameters used by mode (See below for details)
  • "Open" - Opens the Arsenal
  • "Preload" - Preloads item configs, without preloading the configs are parsed the first time it's opened
    • No parameters
  • "AmmoboxInit" - Adds a virtual ammobox. Action to access the Arsenal will be added automatically to all clients
    • 0: Object - Object which should get a virtual ammobox
    • 1: Boolean - True to make all items available (optional, default: false)
    • 2: Code - Condition for the Arsenal to be accessable (optional,default: {false})
      • Passed arguments are the same as in addAction condition, i.e. _target - the object, _this - the caller
  • "AmmoboxExit" - Remove virtual ammobox
Return Value:
Nothing

Examples

Example 1:
[ "Open", [ true ] call BIS_fnc_arsenal;Opens Arsenal with all items
Example 2:
[ "Preload" ] call BIS_fnc_arsenal;Preloads config for Arsenal
Example 3:
[ "AmmoboxInit", [ ammoBox, true, {(_this distance _target) < 10} ] ] call BIS_fnc_arsenal;Adds full Arsenal to player object and makes the action available when the player is as closer than 10 meters from ammoBox
Example 4:
[ "AmmoboxExit", player ] call BIS_fnc_arsenal;Removes Arsenal from player object

Additional Information

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

Notes

Bottom Section

Posted on October 6, 2014 - 04:59 (UTC)
Benargee
To remove arsenal from an ammo box, you can use: removeAllActions ammobox
Posted on September 2, 2017 - 22:36 (UTC)
Lou Montana
calling or spawning BIS_fnc_Arsenal with arguments ["AmmoboxInit", [myBox, true]] will show a "%ALL" error (BIS_fnc_error) when the player actually uses it.
Use [ myCrate, "%ALL", true ] call BIS_fnc_removeVirtualWeaponCargo to remove this "%ALL" parameter.