Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Grenades - Add missing documentation on flares and incendiaries (#9984)

Browse Source 
Update grenades-framework.md
This commit is contained in:
johnb432 2024-04-29 09:34:35 +02:00 committed by GitHub
parent 0f5b7c8762
commit 3987c62acc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 40 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/wiki/framework/grenades-framework.md
View File

@ -1,7 +1,7 @@
---
layout: wiki
title: Grenades Framework
description: Explains how to set-up flashbangs, particularly multi-bangs.
description: Explains how to set-up incendiary, flares and flashbangs, particularly multi-bangs.
group: framework
parent: wiki
order: 7
@ -14,11 +14,12 @@ version:
## 1. Overview
ACE provides a simple interface for creating flashbang grenades and specifying their properties. It is important that one sets `timeToLive` to be greater than the total possible time until the last explosion, i.e, `ace_grenades_flashbangBangs * ace_grenades_flashbangInterval + ace_grenades_flashbangIntervalMaxDeviation`. Any explosions that occur after the `timeToLive` has expired will occur at `(0,0)`.
ACE provides a simple interface for creating incendiary, flare and flashbang grenades, as well as specifying their properties. For flashbangs, it is important that one sets `timeToLive` to be greater than the total possible time until the last explosion, i.e, `ace_grenades_flashbangBangs * ace_grenades_flashbangInterval + ace_grenades_flashbangIntervalMaxDeviation`. Any explosions that occur after the `timeToLive` has expired will occur at `(0,0)`.
## 2. Config Values
### 2.1 Flashbang Config Values
There are several config entries specific to ACE flashbangs. All successive values can be left undefined and they will be given the defaults shown in the first example below, with the exception of `ace_grenades_flashbang`, which is equal to `0` if left undefined.
```cpp
@ -53,22 +54,55 @@ class CfgAmmo {
};
```
### 2.1 ace_grenades_flashbang
#### 2.1.1 ace_grenades_flashbang
If set to zero or left undefined, the grenade is not treated as a flashbang. If it is set to 1, the grenade will be treated as a flashbang with the associated effects.
### 2.2 ace_grenades_flashbangBangs
#### 2.1.2 ace_grenades_flashbangBangs
The flashbang will explode as many times as is specified. The default is 1.
### 2.3 ace_grenades_flashbangInterval
#### 2.1.3 ace_grenades_flashbangInterval
The average amount of time in seconds, after `explosionTime` has passed, between each subsequent bang.
### 2.4 ace_grenades_flashbangIntervalMaxDeviation
#### 2.1.4 ace_grenades_flashbangIntervalMaxDeviation
The amount of randomness in the fuse time.
### 2.2 Incendiary Config Values
```cpp
class CfgAmmo {
class ACE_G_M14 {
ace_grenades_incendiary = 1;
};
};
```
#### 2.2.1 ace_grenades_incendiary
If set to zero or left undefined, the grenade is not treated as an incendiary. If it is set to 1, the grenade will be treated as an incendiary with the associated effects.
### 2.3 Flare Config Values
```cpp
class CfgAmmo {
class ACE_G_Handflare_White {
ace_grenades_flare = 1;
ace_grenades_color[] = {0.5,0.5,0.5,0.5}; // R, G, B, light intensity
};
};
```
#### 2.3.1 ace_grenades_flare
If set to zero or left undefined, the grenade is not treated as a flare. If it is set to 1, the grenade will be treated as a flare with the associated effects.
#### 2.3.1 ace_grenades_color
Sets the color of the emitted light. The first 3 values of the array of the color, the last is the light intensity.
## 3. Events
### 3.1 Listenable