BIS fnc arsenal: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix description) |
Lou Montana (talk | contribs) (Fix description) |
||
Line 11: | Line 11: | ||
|s1= [mode, params] call [[BIS_fnc_arsenal]] | |s1= [mode, params] call [[BIS_fnc_arsenal]] | ||
|p1= mode: [[String]] - mode, can be "Open" | |p1= 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 | |||
|p2= params: [[Anything]] - mode parameters: | |p2= params: [[Anything]] - mode parameters: | ||
* '''"Open"''' | * '''"Open"''': [allItems] | ||
** | ** allItems: [[Boolean]] - (Optional, default [[false]]) [[true]] to open full [[Arsenal]] with all items available | ||
* '''"Preload"''' | * '''"Preload"''': no parameters | ||
* '''"AmmoboxInit"''': [ammobox, allItems, condition] | |||
* '''"AmmoboxInit"''' | ** ammobox: [[Object]] - Object which should get a virtual ammobox | ||
** | ** allItems: [[Boolean]] - (Optional, default [[false]]) [[true]] to make all items available | ||
** | ** condition: [[Code]] - (Optional, default {{ic|{ [[true]] }<nowiki/>}}) 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'') | |||
* '''"AmmoboxExit"''' | *** _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 [[Arma 3: Arsenal|Arsenal]] was added | |||
|r1= [[Nothing]] | |r1= [[Nothing]] |
Revision as of 14:49, 15 July 2021
Description
- Description:
- Function used for the Virtual Arsenal. The function features four different modes, each mode comes with its own parameters.
- Execution:
- call
- Groups:
- Inventory
Syntax
- Syntax:
- [mode, params] call BIS_fnc_arsenal
- Parameters:
- mode: String - mode, can be one of:
- params: Anything - mode parameters:
- "Open": [allItems]
- "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]
- 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: 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