Add Arsenal feature doc (#5937)

* Add first draft of the arsenal feature page

* Fill out the loadout section, add doc for new shortcuts

* Add features part of the documentation

* Fix minor typos

* Fix typos, remove inline code highlighting for words
This commit is contained in:
Josuan Albin 2017-12-21 15:25:22 +01:00 committed by Jo David
parent ead5fb4a5e
commit 06db96663f

View File

@ -0,0 +1,89 @@
---
layout: wiki
title: ACE Arsenal
description: Adds an interface that allow player to edit their loadouts.
group: feature
category: general
parent: wiki
mod: ace
version:
major: 3
minor: 12
patch: 0
---
## 1. Overview
### 1.1 Features
ACE Arsenal has a pretty large number of improvements over BI Virtual Arsenal, here is a non exhaustive list:
- The ability to select the magazine loaded into your primary / secondary / handgun without leaving ACE Arsenal.
- Search bars for both the left and right panels.
- New tabs to add weapon accessories to a container.
- A "Clear container" button to remove all items from a container.
- Unique items support.<sup>*</sup>
- Loadouts can be shared with other players.
- Mission makers can save "Default loadouts" that will be available in their own tab independently from player saved loadouts.
- A setting to disable mod icons to increase performance even further.
- An other setting to invert horizontal camera controls.
- Settings to disable the "Default loadouts" and "Public loadouts" tabs.
<sup>*</sup> Items not currently available in ACE Arsenal but in the unit's inventory, unique items will be omitted when loading loadouts and they can only be removed from containers.
### 1.2 Loadouts
<div class="panel callout">
<p>Loadouts from BI Virtual Arsenal will not show up in ACE Arsenal and vice versa.
Insignias, faces, and voices are NOT saved</p>
</div>
The loadouts screen is separated into 3 tabs:
- "My loadouts" for loadouts saved into your profile.
- "Default loadouts" for loadouts saved in the mission.
- "Public loadouts" for loadouts made public by other players (does not persist after the owner disconnects).
"Default loadouts" and "Public loadouts" tabs can be disabled by the mission maker.
Loadout names are unique, you cannot have two loadouts with the same name, however you are able to rename loadouts.
Saving loadouts from the default and public tabs will save them in your profile, they will show up in the "My loadouts" tab if you switch back to it.
All loadouts can be loaded, however items not available or missing, will NOT be added. This limitation applies to all tabs as well as imported loadouts.
The color coding for loadouts is as follows:
- White: All items are available and will be loaded.
- Grey: Some items in that loadout are not available in that box.
- Red: Missing mods / class not defined, this takes precedence over grey if there is also unavailable items.
## 2. Shortcuts
<div class="panel callout">
<h5>Note:</h5>
<p><kbd>Ctrl</kbd> + <kbd>V</kbd> does NOT work in multiplayer due to a BI safety, however <kbd>Ctrl</kbd> + <kbd>C</kbd> does since it's using the ACE3 clipboard extension.</p>
</div>
### 2.1 Outside of search bars
- <kbd>Ctrl</kbd> + <kbd>C</kbd>: Export current loadout to clipboard.
- <kbd>Ctrl</kbd> + <kbd>V</kbd>: Import loadout from clipboard.
- <kbd>Backspace</kbd>: Hide / show the UI (does not work on loadouts screen).
- Arrow keys can be used to naviguate the left and right panels.
- <kbd>Shift</kbd> + <kbd>LMB</kbd> on the `+` or `-` buttons on the right panel to add or remove 5 of the selected item.
- <kbd>Ctrl</kbd> + <kbd>F</kbd> Selects the left search bar.
<div class="panel callout">
<h5>Note:</h5>
<p><kbd>Shift</kbd> + arrow keys can be used to add or remove a large amount of items in a short amount of time from the right panel.</p>
</div>
### 2.2 Inside of search bars
- Search bars support copy / cut and paste (same limitations as importing apply in multiplayer).
- <kbd>Ctrl</kbd> + <kbd>A</kbd> is supported.
- <kbd>Enter</kbd> validates the search.
- <kbd>RMB</kbd> clears the text field.
- Arrow keys can be used to move the caret.
- <kbd>Ctrl</kbd> + <kbd>F</kbd> switches which search bar is selected.
{% include dependencies_list.md component="arsenal" %}