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

documentation pass 11

Browse Source 
- Updated information center
- Update mortar doc
- Updated medical doc
- Updated maptools doc
- Updated huntIR doc
- Added framework doc
- disposables
- explosives
This commit is contained in:
alganthe 2015-08-16 13:19:20 +02:00
parent dc06927418
commit a420bccb02
7 changed files with 277 additions and 49 deletions

2
documentation/feature/huntIR.md

@ -29,7 +29,7 @@ Shortcut | Action
------------ | -------------
<kbd>A</kbd> | Lower zoom level
<kbd>D</kbd> | Increase zoom level
<kbd>N</kbd> | Toggle NV and TI modes
<kbd>N</kbd> | Toggle NV
<kbd>S</kbd> | Next camera
<kbd>W</kbd> | Previous camera
<kbd>←</kbd> | Rotate camera anticlockwise

2
documentation/feature/maptools.md

@ -29,7 +29,7 @@ If you are equipped with a vanilla GPS it will be shown on the map. (You don't n
- Note that you can drag the Roamer (map tool) around with <kdd> LMB </kbd> and rotate it with <kbd>Ctrl</kbd> + <kbd>LMB</kbd>.
### 2.2 Drawing lines
- To draw lines `Map Tools` are not required.
- To draw lines `Map Tools` are required.
- Press <kbd>ALT</kbd> + <kbd>LMB</kbd> to start the line, left click again to end it.
- To delete a line press <kbd>Del</kbd> around the center of the line.
- Note that you can change the color of the lines by clicking on one of the coloured column on top of the screen (While the map is opened)

87
documentation/feature/medical-system.md

@ -5,9 +5,9 @@ description: ACE provide users with a more realistic medical system and comes in
group: feature
order: 4
category: realism
parent: wiki
parent: wiki
---
**Disclaimer:** The documentation for the medical system being extremely long it's highly advised to use the table of contents at the top right corner of the page.
**Disclaimer:**The documentation for the medical system being extremely long it's highly advised to use the table of contents at the top right corner of the page.
## 1. Overview
ACE3 provides users with a more realistic medical system and comes in both a basic and an advanced version. This page will detail the differences between both systems and what they do as well as how to use them efficiently.
@ -109,6 +109,14 @@ Atropine | Serves no use in basic
- If the revive system is in place your character will not die until the revive timer is at 0. Even if a tank shoots your ass off an epinephrine shot will bring you back up after your wounds are treated. (The timer is invisible and may vary from mission to mission, it also depends on the amount of lives remaining you have.)
- You can't do an overdose in basic.
#### 2.1.4 Revive (Basic medical)
For the following procedure to work revive need to be enabled.
- A unit in the revive state will be unconscious and will stay unconscious until he is either woken up or the revive timer runs out.
- A unit in the revive state can't die from any source of damage, only the timer ending can kill it.
- To wake up a patient treat all of his wounds, make sure he isn't in pain then use epinephrine.
- Each successful revive removes a life from the unit, once the lives runs out the next time the unit will take fatal damage he will not enter the revive state and will die.
### 2.2 Advanced
Same as with basic, when hit an injury is sustained. Different though is that the type of injury and the severity of it are based upon how the damage was done and what caused it. This affects both blood loss and immediate consequences, such as being knocked out or being killed right away. When a player has sustained an injury, this will be indicated by flashing red on the screen; this means the player is bleeding.
@ -140,7 +148,7 @@ Same as with basic, when hit an injury is sustained. Different though is that th
- Sources: falling, vehicle crashes, punches.
- Effects: pain - light, bleeding - extremely slowly.
##### 2.2.1.5 Cut wounds**
##### 2.2.1.5 Cut wounds
- Slicing wounds made with a sharp instrument, leaving even edges. They may be as minimal as a paper cut or as significant as a surgical incision.
- Sources: vehicle crashes, grenades, explosions, artillery shells, backblast, stabs.
@ -288,5 +296,76 @@ Note that keeping the patient's vitals stable is very important while treating h
- You don't have to take epinephrine after you take morphine, just wait until your pulse stabilizes by itself (Provided that you are in a stable condition).
- Giving too much morphine to a patient (more than one every 10 minutes) will put him in cardiac arrest because of a blood pressure / heart rate too low.
## 3. Dependencies
#### 2.2.5 Revive (Advanced medical)
For the following procedure to work revive need to be enabled.
- A unit in the revive state will be unconscious and will stay unconscious until he is either woken up or the revive timer runs out.
- A unit in the revive state can't die from any source of damage, only the timer ending can kill it.
- To wake up a patient the use of a PAK is required.
- Each successful revive removes a life from the unit, once the lives runs out the next time the unit will take fatal damage he will not enter the revive state and will die.
- Each successful round of CPR (filled up completion bar) increase the time left in the revive state.
## 3. Guides
### 3.1 Loadouts
#### 3.1.1 Basic
- Soldier:
- 10 x Bandage (basic)
- 3 x Morphine Autoinjector
- 1 epinephrine Autoinjector
- Medic:
- 15-25 x Bandage (basic)
- 6 x Blood IV (500ml)
- 10 x Morphine Autoinjector
- 10 x Epinephrine Autoinjector
#### 3.1.2 Advanced
- Soldier :
- 3-6 x Bandage (basic)
- 3-6 x Bandage (elastic)
- 3-6 x Bandage (packing)
- 3-6 x QuikClot
- 1 x Morphine Autoinjector
- 1 x Epinephrine Autoinjector
- 1 x Tourniquet
- **Optional**: 1 x Saline IV (500ml) - used only by qualified medic
- Combat First Responder (CFR):
- 10-15 x Bandage (basic)
- 10-15 x Bandage (elastic)
- 10-15 x Bandage (packing)
- 10-15 x QuikClot
- 3 x Tourniquet
- 4 x Saline IV (500ml)
- 5 x Morphine Autoinjector
- 5 x Epinephrine Autoinjector
- 8 x Atropine Autoinjector
- Medic:
- 10-15 x Bandage (basic)
- 15-20 x Bandage (elastic)
- 15-20 x Bandage (packing)
- 10-15 x QuikClot
- 5 x Tourniquet
- 6 x Saline IV (500ml)
- 8 x Morphine Autoinjector
- 8 x Epinephrine Autoinjector
- 12 x Atropine Autoinjector
- 1-3 x *Surgical kit*
- 1-3 x *Personal Aid Kit*
- Paramedic:
- 10-15 x Bandage (basic)
- 15-20 x Bandage (elastic)
- 15-20 x Bandage (packing)
- 10-15 x QuikClot
- 5 x Tourniquet
- 2 x Saline IV (500ml)
## 4. Dependencies
`ace_interaction`, `ace_modules`, `ace_apl`

60
documentation/feature/mk6mortar.md

@ -17,50 +17,28 @@ ACE3 adds wind deflection for shells as well as a rangetable to accurately take
### 2.1 Switching charge
- Press <kbd>F</kbd> (Arma 3 default key bind `Fire Mode Switch`) to switch between charges
### 2.2 Working with the rangetable
- To open the table:
- Self interact <kbd>Ctrl</kbd> + <kbd>⊞&nbsp;Win</kbd>
- Select `equipment`.
- Select `Open 82mm Rangetable`.
### 2.2 Opening the table
- Self interact <kbd>Ctrl</kbd> + <kbd>⊞&nbsp;Win</kbd>
- Select `equipment`.
- Select `Open 82mm Rangetable`.
- Using the table:
- Get the distance and elevation difference between you and the target for this you can use map tools. For this example we'll say we're 2 000m away and 50m below (we're at 20m they are at 70m, 70-20=50).
- Select the charge you want to use (0 = close / 1 = medium / 2 = far). For this case we're using charge 2.
- Check the range column on the table, we're at 2 000 then look at the corresponding entry in the column on the right (ELEV = elevation) For this example it's 1339.
- After that's done move by one column on the right that's the elevation for 100m heigh so in our case we're subtracting 2 (4:2 = 2) if our target was 300m above us we would have to subtract 12 from our elevation (3x4 = 12).
- Once you finished your maths, it's time to aim, get the cross of the mortar on target, if you don't see it use a waypoint if possible. In our case ELEV is 1339-2 = 1337.
- On the right side of the screen, while looking through the mk6 scope you should see ELV, we need to match this number with the one we found.
- To adjust the ELV use <kbd>Page Up</kbd> and <kbd>page Down</kbd>.
- Once the number you found and ELV are the same FIRE !
- On top of that you can calculate the time the shell will take to land by using the third row from the left, in our case the shell need to travel 2000m that's 20xthe number indicated. so 20x0,5 = 10s.
### 2.2 Getting your shells to land where you want.
For this you need a `82mm Rangetable`, `Map Tools` and a `Vector 21` are also recommended.
### 2.3 Working with the rangetable (Crosswinds enabled)
- Same as above there's just an extra step, I'll provide an other example in case you forgot.
- Get the distance and elevation difference between you and the target for this you can use map tools. For this example we'll say we're 2 400m away and 223m below (we're at 2m they are at 225, 225-2=223)
- Select the charge you want to use (0 = close / 1 = medium / 2 = far). For this case we're using charge 2.
- Check the range column on the table, we're 2 400m a then look at the corresponding entry in the column on the right (ELEV = elevation) For this example it's 1145.
- After that's done move by one column on the right that's the elevation for 100m heigh so in our case we're subtracting 22 (2,2 x 10 (2,2 because we're around 220m below)).
- Extra step needed here, a kestrel 4500 IS NEEDED.
- Pick the crosswind on your kestrel (for this refer to the kestrel documentation).
- For this example the crosswind is of 2 MPS on my table I can see under Azimuth correction that for each 1MPS I need to correct by 2.5 mill.
- So in this case i'm subtracting 5 mill from the ELV.
- It's MATH TIME the ELV given by the table is 1 145, we subtract 22 because of the heigh, we also subtract 5 for the crosswind ( 1 145-22-5 = 1 118 ).
- After you finished your maths, it's time to aim, get the cross of the mortar on target, if you don't see it use a waypoint if possible. In our case ELEV is 1 118.
- On the right side of the screen, while looking through the mk6 scope you should see ELV, we need to match this number with the one we found.
- FIREEEE !!!!
- Little advantage of having crosswind enabled is that you don't have to calculate the flight time, it's marked on the table in this case it's 33,8s.
- Get the distance and elevation difference between you and the target for this you can use map tools.
- Select the charge you want to use (0 = close / 1 = medium / 2 = far).
- Open the `82mm Rangetable`
- Calculate the correct ELEV (elevation):
- Open the `Rangetable` and click on the charge you're using.
- Find your range under the `RANGE` collumn
- Under the `ELEV` collumn find the number that match your range, that's the base elevation you're going to work with.
- Under the `D ELEV for 100m DR` find the number that match your ELEV and compensate:
- Example, if you're 200m above your target multiply the number by 2 and add it to your ELEV.
- If you're 200m below the target multiply the number by 2 and substract it to your ELEV.
- The lower the elev the closer to you it will land.
- Once you finished calculating the ELEV align the barrel of the mortar with your target (directly looking at it) and set your ELEV to what you calculated by using <kbd>Page Up</kbd> and <kbd>Page Down</kbd>.
- Once the ELEV is correctly set and the barrel is facing the right direction, shoot and enjoy your bananas while watching hell rain on your enemies.
## 3. Dependencies
`ace_interaction`

40
documentation/framework/disposables-framework.md Normal file

@ -0,0 +1,40 @@
---
layout: wiki
title: Disposable framework
description:
group: framework
order: 5
parent: wiki
---
## 1. Making a launcher disposable
### 1.1 CfgWeapons
```
class CfgWeapons {
class Launcher_Base_F;
class launch_banana: Launcher_Base_F {
ACE_UsedTube = "launch_banana_Used_F"; // The class name of the used tube.
magazines[] = {"ACE_PreloadedMissileDummy"}; // The dummy magazine
};
class launch_banana_Used_F: launch_banana { // the used tube should be a sub class of the disposable launcher
scope = 1;
ACE_isUsedLauncher = 1;
author = "someone";
displayName = "Used banana launcher";
descriptionShort = "A used banana launcher";
magazines[] = {"ACE_FiredMissileDummy"}; // This will disable the used launcher class from being fired again.
//picture = "";
//model = "";
weaponPoolAvailable = 0;
};
};
```
### 1.2 Notes
- This is just the necessary to make a launcher disposable, this is not a guide to make your own launcher.

127
documentation/framework/explosives-framework.md Normal file

@ -0,0 +1,127 @@
---
layout: wiki
title: Explosives framework
description:
group: framework
order: 5
parent: wiki
---
## 1. Explosives
### 1.1 Setting the magazine
```
class CfgMagazines {
class CA_Magazine;
class banana_satchel_remote_mag: CA_Magazine {
ACE_Placeable = 1; // Can be placed
useAction = 0; // Disable the vanilla interaction
ACE_SetupObject = "banana_satchel_place"; // The object placed before te explosive is armed.
class ACE_Triggers { // Trigger configurations
SupportedTriggers[] = {"Timer","Command", "MK16_Transmitter", "DeadmanSwitch"}; // Triggers that can be used.
class Timer {
FuseTime = 0.5; // Time for the fuse to burn.
};
class Command {
FuseTime = 0.5;
};
class MK16_Transmitter: Command {};
class DeadmanSwitch: Command {};
};
};
};
```
### 1.2 Setting the ammo
```
class CfgAmmo {
class PipeBombBase;
class SatchelCharge_Remote_Ammo: PipeBombBase {
soundActivation[] = {"", 0, 0, 0}; // No sound on activation.
soundDeactivation[] = {"", 0, 0, 0}; // No sound on deactivation.
};
};
```
Some optionnal parameters:
- triggerWhenDestroyed = 1; // Explode when the object is shot and destroyed (after being placed) (0= disabled, 1= enabled).
- ACE_explodeOnDefuse = 0.02; // Add a chance for the explosive to detonate after being disarmed. (in percent)
### 1.3 Adding the place item
```
class CfgVehicles {
class ACE_Explosives_Place;
class banana_satchel_place: ACE_Explosives_Place {
displayName = "Banana satchel"; // Name of the item
model = ""; // Path to your model
ACE_offset[] = {0,0,0}; // Offset of the interaction point from the model in meters on the X,Y,Z axis.
};
};
```
## 2. Mines
### 2.1 Setting the magazine
_Pretty much the same as Explosives except that we inherit from_ `ATMine_Range_Mag` _instead of_ `CA_Magazine`
```
class CfgMagazines {
class ATMine_Range_Mag;
class BananaMine_Range_Mag: ATMine_Range_Mag {
ACE_SetupObject = "BananaMine_Place"; // The object placed before the mine is armed.
class ACE_Triggers { // Triggers
SupportedTriggers[] = {"PressurePlate"}; // This mine only support pressure plate activation.
class PressurePlate {
digDistance = 0.05;
};
};
};
};
```
### 2.2 Setting up the Ammo
The class you inherit from depends of what type of trigger you are using, for `PressurePlate` and `Tripwire` you can skip this step, for timers and clackers refer to the Explosives entry.
Directional mines inherit from `DirectionalBombBase`.
## 3. Adding your own detonators
```
class CfgWeapons {
class ACE_ItemCore; // ACE3 base item class.
class ACE_Clacker; // Clacker base class.
class banana_clacker: ACE_Clacker {
displayName = "banana clacker"; // Name of the item.
picture = ""; // Path to the item's picture.
ACE_Range = 9000; // Explosives activation range in meters.
};
};
```
## 4. Trigger list
Name | Use
---- | -----
Command | Explode when activated via clacker.
MK16_Transmitter | Explode when activated via M26 clacker.
DeadManSwitch | Explode after activated via the switch or the person dies.
Cellphone | Explode when the number is called.
PressurePlate | Explode upon being stepped upon.
IRSensor | Explode after movement is detected in front of the mine.
Timer | Explode after timer drop to 0.
Tripwire | Explode when something touch the tripwire.
## 5. Events

8
documentation/user/information-center.md

@ -39,10 +39,14 @@ Downloaded ACE3 and have no idea where to start? This page serves as a starting
**A:** Fun fact, it isn't, you need to come from the direction of the laser, (laser is pointing to the east, you come from the west) and you drop the GBU, it will then guide itself to the target. The reasoning behind that is that the vehicle or building laser designated would obstruct the laser and the GBU would then be unable to lock on it. </br>
**Q:** I take vanilla damage with ACE 3.1.1</br>
**A:** This has been fixed on ACE3 master and will be fixed in the next release, in the meantime Basic medical doesn't have that issue. </br>
**A:** This has been fixed in 3.2.0</br>
**Q:** I'm having dll errors.</br>
**A:** Remove ACE3 from your Arma 3 folder and repeat the installation process (don't forget to re-download).</br>
**A:** Start the game once with the arma3 launcher, close it then open it with your usual launcher (arma3sync or PW6).</br>
The simple explanation to that is that battleye break itself and only starting it with the arma3 launcher fixes it.</br>
**Q:** ACE fonts is outdated.</br>
**A:** This happens because you're using the mod (stable) with the dev version on your P drive, remove simlinks in ARMA3 root and the P drive.
### 1.3 Compatibility