Merge pull request #5 from jonpas/docpass11_3

Documentation Pass 11 Additions 3
acemod · Aug 25, 2015 · a53221c · a53221c
2 parents e5cf6bc + ac645ef
commit a53221c
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 40 deletions.
diff --git a/documentation/framework/dragging-framework.md b/documentation/framework/dragging-framework.md
@@ -39,56 +39,56 @@ You will **not** be able to carry / drag objects that are too heavy, the mass is
 
 `ace_dragging_fnc_setDraggable`
 
- Arguments |    | Type | Optional (default value)
---- | --------- | ---- | ------------------------
-0   | Any object | Object | Required
-1   | Enable dragging, true to enable, false to disable | Boolean | Required
-2   | Position to offset the object from player | Array | Optional (default: `[0, 0, 0]`)
-3   | Direction in degree to rotate the object | Number | Optional (default: `0`)
+   | Arguments | Type | Optional (default value)
+---| --------- | ---- | ------------------------
+0  | Any object | Object | Required
+1  | Enable dragging, true to enable, false to disable | Boolean | Required
+2  | Position to offset the object from player | Array | Optional (default: `[0, 0, 0]`)
+3  | Direction in degree to rotate the object | Number | Optional (default: `0`)
 **R** | None | None | Return value
 
 #### 2.1.1 Example 1
 
 `[foo, true, [0, 2, 0], 45] call ace_dragging_fnc_setDraggable;`
 
-Arguments |    | Explanation
---- | --------- | -----------
-0   | `foo` | My object
-1   | `true` | Dragging is enabled
-2   | `[0,2,0]` | 0 meters sideways, 2 meters forward, 0 meters upwards
-3   | `45` | Rotated by 45°
+   | Arguments | Explanation
+---| --------- | -----------
+0  | `foo` | My object
+1  | `true` | Dragging is enabled
+2  | `[0,2,0]` | 0 meters sideways, 2 meters forward, 0 meters upwards
+3  | `45` | Rotated by 45°
 
 #### 2.1.2 Example 2
 
 `[bar, false, [3, -2, 2], 20] call ace_dragging_fnc_setDraggable;`
 
-Arguments |     | Explanation
---- | --------- | -----------
-0   | `bar` | My object
-1   | `false` | Dragging is disabled
-2   | `[3, -2, 2]` | 3 meters sideways, 2 meters backwards, 2 meters upwards
-3   | `20` | Rotated by 20°
+   | Arguments | Explanation
+---| --------- | -----------
+0  | `bar` | My object
+1  | `false` | Dragging is disabled
+2  | `[3, -2, 2]` | 3 meters sideways, 2 meters backwards, 2 meters upwards
+3  | `20` | Rotated by 20°
 
 
 ### 2.2 Enabling / disabling carrying
 
 `ace_dragging_fnc_setCarryable`
 
-Arguments |     | Type | Optional (default value)
---- | --------- | ---- | ------------------------
-0   | Any object | Object | Required
-1   | Enable carrying, true to enable, false to disable | Boolean | Required
-2   | Position to offset the object from player | Array | Optional (default: `[0, 1, 1]`)
-3   | Direction in degree to rotate the object | Number | Optional (default: `0`)
+   | Arguments | Type | Optional (default value)
+---| --------- | ---- | ------------------------
+0  | Any object | Object | Required
+1  | Enable carrying, true to enable, false to disable | Boolean | Required
+2  | Position to offset the object from player | Array | Optional (default: `[0, 1, 1]`)
+3  | Direction in degree to rotate the object | Number | Optional (default: `0`)
 **R** | None | None | Return value
 
 #### 2.2.1 Example
 
 `[foo, true, [0, 3, 1], 10] call ace_dragging_fnc_setCarryable;`
 
-Arguments |    | Explanation
---- | --------- | -----------
-0   |  `foo` | My object
-1   |  `true`| Carrying is enabled
-2   | `[0,2,0]` | 0 meters sideways, 3 meters forward, 1 meter upwards
-3   | `10` | Rotated by 10°
+   | Arguments | Explanation
+---| --------- | -----------
+0  |  `foo` | My object
+1  |  `true`| Carrying is enabled
+2  | `[0,2,0]` | 0 meters sideways, 3 meters forward, 1 meter upwards
+3  | `10` | Rotated by 10°
diff --git a/documentation/framework/overpressure-framework.md b/documentation/framework/overpressure-framework.md
@@ -1,7 +1,7 @@
 ---
 layout: wiki
 title: Overpressure Framework
-description: Explains how to set-up launchers and cannon backblasts with ACE3 overpressure system.
+description: Explains how to set-up launchers and cannons with backblast and overpressure areas with the ACE3 overpressure system.
 group: framework
 order: 5
 parent: wiki
@@ -13,11 +13,10 @@ parent: wiki
 
 ```c++
 class CfgWeapons {
-
     class MyLauncher {
-        ACE_overpressure_angle = 60;  // cone in which the damage is applied (in degrees from the back end of the launcher)
-        ACE_overpressure_range = 15;  // range in meters in which the damage is applied
-        ACE_overpressure_damage = 0.7;  // damage multiplier
+        ace_overpressure_angle = 60;  // Cone in which the damage is applied (in degrees from the back end of the launcher)
+        ace_overpressure_range = 15;  // Range in meters in which the damage is applied
+        ace_overpressure_damage = 0.7;  // Damage multiplier
     };
 };
 ```
@@ -26,13 +25,21 @@ class CfgWeapons {
 
 ```c++
 class CfgWeapons {
-
     class MyBananaCannon {
-        ACE_overpressure_angle = 90;  // cone in which the damage is applied (in degrees from the muzzle of the cannon)
-        ACE_overpressure_range = 50;  // range in meters in which the damage is applied
-        ACE_overpressure_damage = 0.85;  // damage multiplier
+        ace_overpressure_angle = 90;  // Cone in which the damage is applied (in degrees from the muzzle of the cannon)
+        ace_overpressure_range = 50;  // Range in meters in which the damage is applied
+        ace_overpressure_damage = 0.85;  // Damage multiplier
     };
 };
 ```
 
-- You can note that the angle range and damage are higher, that's because this is a cannon and the backblast is higher.
+- You can note that the angle range and damage values are higher, that's because this is a cannon and the backblast area is bigger.
+
+
+## 2. Events
+
+### 2.1 Listenable
+
+Event Name | Description | Passed Parameter(s) | Locality
+---------- | ----------- | ------------------- | --------
+`"overpressure"` | Overpressure damage inflicted | `[_firer, _position, _direction, _weapon]` | Target