ACE3/documentation/feature/overheating.md

---
layout: wiki
title: Overheating
description: Weapon temperature and jamming, barrel swapping.
group: feature
category: realism
parent: wiki
---

## 1. Overview

### 1.1 Weapon Jamming
Adds a probability to jam a weapon when firing. Jams can be cleared by reloading or by using the clear jam-key.

### 1.2 Temperature simulation
Introduces weapon temperature simulation depending on weapon and bullet mass. Hot weapons are more prone to jamming. Depending on weapon type the accuracy and in extreme cases the muzzle velocity might be reduced on high temperatures. Adds smoke puff and heat refraction effects to indicate this.

### 1.3 Spare barrels
Adds the ability to changes barrels on machine guns to compensate for those effects.


## 2. Usage

### 2.1 Clearing a jammed weapon
- To clear a jammed weapon, press <kbd>SHIFT</kbd> + <kbd>R</kbd> (ACE3 default key bind `Clear jam`).

### 2.2 Swapping barrels
- For this you need a `Spare barrel` and a compatible weapon.
- Press self interaction <kbd>Ctrl</kbd> + <kbd>⊞&nbsp;Win</kbd> (ACE3 default key bind `Self Interaction Key`).
- Select `Equipment`.
- Select `Swap barrel`.

### 2.3 Checking your barrel temperature
- Press self interaction <kbd>Ctrl</kbd> + <kbd>⊞&nbsp;Win</kbd>.
- Select `Equipment`.
- Select `Check weapon temperature`. 

**NOTE** When the bar is half full (yellow) it means the barrel is around 500°c. 
Your weapon will be even more prone to jams, and it'll get worse if you don't let the barrel cool down or swap it.

## 3. Dependencies

`ace_interaction`
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: Overheating`
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`description: Weapon temperature and jamming, barrel swapping.`
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`
add categories to feature docs 2015-07-29 17:11:50 +00:00			`category: realism`
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			`parent: wiki`
			`---`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`## 1. Overview`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 1.1 Weapon Jamming`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			`Adds a probability to jam a weapon when firing. Jams can be cleared by reloading or by using the clear jam-key.`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 1.2 Temperature simulation`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			`Introduces weapon temperature simulation depending on weapon and bullet mass. Hot weapons are more prone to jamming. Depending on weapon type the accuracy and in extreme cases the muzzle velocity might be reduced on high temperatures. Adds smoke puff and heat refraction effects to indicate this.`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 1.3 Spare barrels`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			`Adds the ability to changes barrels on machine guns to compensate for those effects.`
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
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`## 2. Usage`
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
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 2.1 Clearing a jammed weapon`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			- To clear a jammed weapon, press <kbd>SHIFT</kbd> + <kbd>R</kbd> (ACE3 default key bind `Clear jam`).
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 2.2 Swapping barrels`
			- For this you need a `Spare barrel` and a compatible weapon.
Documentation pass 8 - Finished: MicroDAGR doc, note that the images can't be viewed properly on GitHub. - Coding guidelines are more readable now, added the STRING family of macros to it. - How to enable dragging / carrying added to dragging / carrying framework with a BIG disclaimer that the functions are not public and may change. - Shortcut updated to fit the convention established in the shortcut page. 2015-06-30 14:04:00 +00:00			- Press self interaction <kbd>Ctrl</kbd> + <kbd>⊞ Win</kbd> (ACE3 default key bind `Self Interaction Key`).
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			- Select `Equipment`.
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			- Select `Swap barrel`.
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
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`### 2.3 Checking your barrel temperature`
Documentation pass 8 - Finished: MicroDAGR doc, note that the images can't be viewed properly on GitHub. - Coding guidelines are more readable now, added the STRING family of macros to it. - How to enable dragging / carrying added to dragging / carrying framework with a BIG disclaimer that the functions are not public and may change. - Shortcut updated to fit the convention established in the shortcut page. 2015-06-30 14:04:00 +00:00			`- Press self interaction <kbd>Ctrl</kbd> + <kbd>⊞ Win</kbd>.`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			- Select `Equipment`.
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			- Select `Check weapon temperature`.
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass 6 - Added AMG doc - Clarified overheating doc - Getting started remade - Vector doc moved from getting started to vector - Classnames updated - Switchunits doc fixed - Rangecard doc added 2015-05-31 14:30:05 +00:00			`NOTE When the bar is half full (yellow) it means the barrel is around 500°c.`
			`Your weapon will be even more prone to jams, and it'll get worse if you don't let the barrel cool down or swap it.`

Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH. 2015-05-28 15:22:45 +00:00			`## 3. 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_interaction`