ACE3/documentation/feature/weaponselect.md

---
layout: wiki
title: Weapon Select
description: 
group: feature
parent: wiki
---

## Overview

### Weapon select
The number key can be used to quickly switch between weapons. (1 key - pistol, 2 key - rifle, 3 key - grenade launcher, 4 key - rocket launcher, 5 key - binocular)

### Holster weapon
Adds the ability to holster a weapon on the back. (0 key)

### Engine select
Quickly turn engine on and off (1 key - turn off, 2 key - turn on)

### Weapon select
Quickly switch between vehicle weapons (1-3 key)

### Grenade select
To prevent accidents a grenade has to be selected before it can be thrown. Toggles between explosive and non-explosive grenades. When spamming the throw key, the player won't automatically switch to frag grenades when all smokes are used up. Also shows an indicator to quickly see how many grenades are left when selecting and after throwing (6 key - switch between frag grenades, 7 key - switch between other grenades)


## Usage

Short overview of how to use the feature, e.g. menu options, key bindings, 
instructions. May not apply to all modules.


## Dependencies

`ace_common`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`---`
			`layout: wiki`
			`title: Weapon Select`
add description fields to frontmatter header 2015-05-15 07:45:15 +00:00			`description:`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`group: feature`
			`parent: wiki`
			`---`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H1s to H2 2015-05-14 14:13:04 +00:00			`## Overview`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H2s to H3s 2015-05-14 14:04:45 +00:00			`### Weapon select`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`The number key can be used to quickly switch between weapons. (1 key - pistol, 2 key - rifle, 3 key - grenade launcher, 4 key - rocket launcher, 5 key - binocular)`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H2s to H3s 2015-05-14 14:04:45 +00:00			`### Holster weapon`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`Adds the ability to holster a weapon on the back. (0 key)`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H2s to H3s 2015-05-14 14:04:45 +00:00			`### Engine select`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`Quickly turn engine on and off (1 key - turn off, 2 key - turn on)`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H2s to H3s 2015-05-14 14:04:45 +00:00			`### Weapon select`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`Quickly switch between vehicle weapons (1-3 key)`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H2s to H3s 2015-05-14 14:04:45 +00:00			`### Grenade select`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`To prevent accidents a grenade has to be selected before it can be thrown. Toggles between explosive and non-explosive grenades. When spamming the throw key, the player won't automatically switch to frag grenades when all smokes are used up. Also shows an indicator to quickly see how many grenades are left when selecting and after throwing (6 key - switch between frag grenades, 7 key - switch between other grenades)`

Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H1s to H2 2015-05-14 14:13:04 +00:00			`## Usage`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`Short overview of how to use the feature, e.g. menu options, key bindings,`
			`instructions. May not apply to all modules.`

Insert additional newlines 2015-05-14 14:02:01 +00:00
Change H1s to H2 2015-05-14 14:13:04 +00:00			`## Dependencies`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Document module dependencies Add a list of dependencies to each module's documentation. Also add a note to the documenation of modules which are a dependency for many other modules. Dependency lists are pulled from each module's config.cpp. 2015-05-13 19:31:53 +00:00			`ace_common`