ACE3/docs/wiki/framework/overheating-framework.md
PabstMirror 916346ae59
General - Format config class defines to coding guidelines (+tool) (#8520)
* General - Format config class defines to coding guidelines (+tool)

* Update tools/config_style_checker.py

Co-authored-by: jonpas <jonpas33@gmail.com>

* Update tools/config_style_checker.py

Co-authored-by: jonpas <jonpas33@gmail.com>

Co-authored-by: jonpas <jonpas33@gmail.com>
2021-10-15 13:47:05 -05:00

64 lines
1.8 KiB
Markdown

---
layout: wiki
title: Overheating Framework
description: Explains how to set-up weapon overheating with ACE3 overheating system.
group: framework
order: 5
parent: wiki
mod: ace
version:
major: 3
minor: 0
patch: 0
---
## 1. Config Values
### 1.1 Barrel Switching
```cpp
class CfgWeapons {
class MyMG {
ace_overheating_mrbs = 3000; //Mean Rounds Between Stoppages (this will be scaled based on the barrel temp)
ace_overheating_slowdownFactor = 1; //Slowdown Factor (this will be scaled based on the barrel temp)
ace_overheating_allowSwapBarrel = 1; // 1 to enable barrel swap. 0 to disable. Meant for machine guns where you can easily swap the barrel without dismantling the whole weapon.
ace_overheating_dispersion = 0.75; //Dispersion Factor (this will be scaled based on the barrel temp)
};
};
```
### 1.2 Custom jam types
```cpp
class CfgWeapons {
class Pistol_Base_F;
class MyRevolver: Pistol_Base_F {
ace_overheating_jamTypesAllowed = ["Fire","Dud"]; //Allowed and default values are ["Eject", "Extract", "Feed", "Fire", "Dud"]. In the example here a revolver does not eject, extract, or feed on each shot to those values are removed.
};
```
### 1.3 Custom jam clearing animation
```cpp
class CfgWeapons {
class MyMG {
ACE_clearJamAction = "GestureReloadMX"; // Custom jam clearing action. Default uses reload animation, use an empty string to undefine
};
};
```
### 1.4 Cook Off
```cpp
class CfgWeapons {
class Rifle_Long_Base_F ;
class MySniper: Rifle_Long_Base_F {
ace_overheating_closedBolt = 1; // Closed bolt, can cook off from barrel heat.
};
class MyMG: Rifle_Long_Base_F {
ace_overheating_closedBolt = 0; // Open bolt, can only cook off on failure to fire type jams.
};
};
```