Refuel framework doc update

* Fixed one explanation * Unified terminology * Changed order to mirror that of rearm-doc update in PR #9114
acemod · Jan 26, 2023 · d901869 · d901869
1 parent 6b3aa3e
commit d901869
Showing 1 changed file with 41 additions and 41 deletions.
diff --git a/docs/wiki/framework/refuel-framework.md b/docs/wiki/framework/refuel-framework.md
@@ -18,11 +18,11 @@ version:
 ```cpp
 class CfgVehicles {
     class MyFuelTruck {
-        ace_refuel_fuelCargo = 3000; // Fuel cargo
+        ace_refuel_fuelCargo = 3000; // Maximum fuel cargo amount (in liters)
         ace_refuel_hooks[] = {{0.38,-3.17,-.7},{-0.41,-3.17,-.7}}; // Nozzle hooks positions
     };
     class MyCar {
-        ace_refuel_fuelCapacity = 100; // Fuel tank volume
+        ace_refuel_fuelCapacity = 100; // Fuel tank volume (in liters)
     };
     class MyElectricCar {
         ace_refuel_canReceive = 0; // For vehicles which can't be refueled
@@ -38,53 +38,43 @@ class CfgVehicles {
 
 ## 2. Functions
 
-### 2.1 Getting the fuel supply
+### 2.1 Make an object into a refuel source
+*Added in ACE3 3.11.0*
 
-`ace_refuel_fnc_getFuel`
+`ace_refuel_fnc_makeSource`
 
    | Arguments | Type | Optional (default value)
 ---| --------- | ---- | ------------------------
-0  | Fuel Truck | Object | Required
-**R** | Fuel left (in liters) | Number | Return value
+0  | Fuel Source | Object | Required
+1  | Amount (in liters) | Number | Optional (default: `0`)
+2  | Hooks positions | Array | Optional (default: `[[0,0,0]]`)
+**R** | None | None | Return value
 
 #### 2.1.1 Example
 
-`[fuelTruck] call ace_refuel_fnc_getFuel;`
+`[cursorObject, 100] call ace_refuel_fnc_makeSource`
 
    | Arguments | Explanation
 ---| --------- | -----------
-0  | `fuelTruck` | My fuel truck object
+0  | `cursorObject` | Fuel source object
+1  | `100` | Fuel amount (in liters)
 
-### 2.2 Make a jerry can
+### 2.2 Getting the fuel supply
 
-`ace_refuel_fnc_makeJerryCan`
+`ace_refuel_fnc_getFuel`
 
    | Arguments | Type | Optional (default value)
 ---| --------- | ---- | ------------------------
-0  | My Object | Object | Required
-1  | Fuel amount (in liters) | Number | Optional (default: `20`)
-**R** | None | None | Return value
-
-#### 2.2.1 Example 1
-
-`[can] call ace_refuel_fnc_makeJerryCan;`
-
-   | Arguments | Explanation
----| --------- | -----------
-0  | `can` | My jerry can object
-
-The jerry can will have the default 20 liters volume.
+0  | Fuel Truck | Object | Required
+**R** | Fuel amount left (in liters) | Number | Return value
 
-#### 2.2.2 Example 2
+#### 2.2.1 Example
 
-`[can, 200] call ace_refuel_fnc_makeJerryCan;`
+`[fuelTruck] call ace_refuel_fnc_getFuel;`
 
    | Arguments | Explanation
 ---| --------- | -----------
-0  | `can` | My jerry can object
-1  | `200` | Vehicle class name
-
-The jerry can will now have a volume of 200 liters.
+0  | `fuelTruck` | My fuel truck object
 
 ### 2.3 Setting the fuel supply
 
@@ -102,26 +92,36 @@ The jerry can will now have a volume of 200 liters.
 
    | Arguments | Explanation
 ---| --------- | -----------
-0  | `fuelTruck` | My fuel truck object
-1  | `428` | New fuel supply
+0  | `fuelTruck` | Fuel truck object
+1  | `428` | New fuel amount (in liters)
 
-### 2.4 Make an object into a refuel source
-*Added in ACE3 3.11.0*
+### 2.4 Make a jerry can
 
-`ace_refuel_fnc_makeSource`
+`ace_refuel_fnc_makeJerryCan`
 
    | Arguments | Type | Optional (default value)
 ---| --------- | ---- | ------------------------
-0  | Fuel Source | Object | Required
-1  | Amount (in liters) | Number | Optional (default: `0`)
-2  | Hooks positions | Array | Optional (default: `[[0,0,0]]`)
+0  | Jerry Can | Object | Required
+1  | Amount (in liters) | Number | Optional (default: `20`)
 **R** | None | None | Return value
 
-#### 2.4.1 Example
+#### 2.4.1 Example 1
 
-`[cursorObject, 100] call ace_refuel_fnc_makeSource`
+`[can] call ace_refuel_fnc_makeJerryCan;`
 
    | Arguments | Explanation
 ---| --------- | -----------
-0  | `cursorObject` | Fuel source object
-1  | `100` | Fuel supply
+0  | `can` | Jerry can object
+
+The jerry can will have the default 20 liters volume.
+
+#### 2.4.2 Example 2
+
+`[can, 200] call ace_refuel_fnc_makeJerryCan;`
+
+   | Arguments | Explanation
+---| --------- | -----------
+0  | `can` | Jerry can object
+1  | `200` | Amount (in liters)
+
+The jerry can will now have a volume of 200 liters.