[Minor] Weekly Regular Documentation Revisions 03.31-04.06 - develop (#1597)

Author: DeathFishAtEase

CREDITS.md

@@ -363,7 +363,7 @@ This page lists all the individual contributions to the project by their author.
    - Fix [EIP 004C2C19](https://modenc.renegadeprojects.com/Internal_Error#eip_004C2C19) concerning the electric bolt
    - Fix `DefaultDisguise` showing wrong house colors for different players
    - Taking over Ares' AlphaImage respawn logic to reduce lags from it
-   - Allow voxel projectiles to use AnimPalette and FirersPalette
+   - Allow voxel projectiles to use `AnimPalette` and `FirersPalette`
    - Customize damaged speed ratio of drive/ship loco
    - Customize overpower logic
 - **Apollo** - Translucent SHP drawing patches

docs/Fixed-or-Improved-Logics.md

@@ -203,9 +203,9 @@ This page describes all ingame logics that are fixed or improved in Phobos witho
 - Fixed an issue that in air aircraft carriers being unable to attack when it is near by elevated bridges.
 - Fixed an issue that aircraft carriers cannot retract its spawned aircraft when on the bridge.
 - Fixed an issue where the shadow of jumpjet remained on the ground when it was above the elevated bridge.
-- Fixed an issue that laser, electric bolt and rad beam not support `Inviso=true` projectiles with `FlakScatter=true` to scatter
+- Fixed an issue that laser, electric bolt and rad beam not support `Inviso=true` projectiles with `FlakScatter=true` to scatter.
 - Fixed the bug that healing weapons could not automatically acquire aerial targets.
-- Allow voxel projectiles to use AnimPalette and FirersPalette.
+- Allow voxel projectiles to use `AnimPalette` and `FirersPalette`.
 - Fixed an issue where AI would select unreachable buildings and get stuck when looking for buildings like tank bunkers, bio reactors, etc.
 
 ## Fixes / interactions with other extensions
@@ -240,7 +240,7 @@ VoicePickup=    ; Sound entry
 ### Extended Aircraft Missions
 
 - Aircraft will now be able to use waypoints.
-- Aircraft can fly at a certain speed as much as possible, when the distance to the destination is less than half of `SlowdownDistance` or 8 cell distances divided by ROT, it will return to the airport. And now aircraft not have to fly directly above the airport before starting to descend.
+- Aircraft can fly at a certain speed as much as possible, when the distance to the destination is less than half of `SlowdownDistance` or 8 cell distances divided by `ROT`, it will return to the airport. And now aircraft not have to fly directly above the airport before starting to descend.
 - When a `guard` command (`[G]` by default) is issued, the aircraft will search for targets around the current location and return immediately when target is not found, target is destroyed or ammos are depleted.
   - If the target is destroyed but ammos are not depleted yet, it will also return because the aircraft's command is one-time.
 - When an `attack move` command (`[Ctrl]+[Shift]`) is issued, the aircraft will move towards the destination and search for nearby targets on the route for attack. Once ammo is depleted or the destination is reached, it will return.
@@ -492,6 +492,24 @@ Grinding.Weapon=                   ; WeaponType
 Grinding.Weapon.RequiredCredits=0  ; integer
 ```
 
+### Customize overpower logic
+
+- Now you can specific how building can be overpowerd.
+
+In `rulesmd.ini`:
+```ini
+[SOMEWARHEAD]
+ElectricAssaultLevel=1    ; integer
+
+[SOMEBUILDING]
+Overpower.KeepOnline=2    ; integer, negative values mean that cannot keep online
+Overpower.ChargeWeapon=1  ; integer, negative values mean that weapons can never be switched
+```
+
+```{note}
+Ares' [Battery Super Weapon](https://ares-developers.github.io/Ares-docs/new/superweapons/types/battery.html) won't be affected by this.
+```
+
 ### Exclude Factory from providing multiple factory bonus
 
 - It is now possible to exclude a building with `Factory` from counting towards `MultipleFactory` bonus.
@@ -530,24 +548,6 @@ In `rulesmd.ini`:
 BuildingWaypoints=false  ; boolean
 ```
 
-### Customize overpower logic
-
-- Now you can specific how building can be overpowerd.
-
-In `rulesmd.ini`:
-```ini
-[SOMEWARHEAD]
-ElectricAssaultLevel=1    ; integer
-
-[SOMEBUILDING]
-Overpower.KeepOnline=2    ; integer, negative values mean that cannot keep online
-Overpower.ChargeWeapon=1  ; integer, negative values mean that weapons can never be switched
-```
-
-```{note}
-Ares' [Battery Super Weapon](https://ares-developers.github.io/Ares-docs/new/superweapons/types/battery.html) won't be affected by this.
-```
-
 ## Infantry
 
 ### Prone speed customization
@@ -564,22 +564,6 @@ ProneSpeed.NoCrawls=1.5       ; floating point value, multiplier
 ProneSpeed=                   ; floating point value, multiplier, by default, use the corresponding global value according to Crawls
 ```
 
-## Unit
-
-### Damaged speed customization
-
-- In vanilla, units using drive/ship loco will has hardcoded speed multiplier when damaged. Now you can customize it.
-- The max valuebale value is 1.0, you cannot make unit get faster on yellow condition by it.
-
-In `rulesmd.ini`
-```ini
-[General]
-DamagedSpeed=0.75        ; double
-
-[SOMEUNIT]
-DamagedSpeed=            ; double
-```
-
 ## Particle systems
 
 ### Fire particle target coordinate adjustment when firer rotates
@@ -920,6 +904,20 @@ AircraftLevelLightMultiplier=1.0  ; floating point value, percents or absolute
 JumpjetLevelLightMultiplier=0.0   ; floating point value, percents or absolute
 ```
 
+### Damaged speed customization
+
+- In vanilla, units using drive/ship loco will has hardcoded speed multiplier when damaged. Now you can customize it.
+- The max valuebale value is 1.0, you cannot make unit get faster on yellow condition by it.
+
+In `rulesmd.ini`:
+```ini
+[General]
+DamagedSpeed=0.75        ; floating point value, multiplier
+
+[SOMETECHNO]             ; TechnoType
+DamagedSpeed=            ; floating point value, multiplier
+```
+
 ### Exploding object customizations
 
 - By default `Explodes=true` TechnoTypes have all of their passengers killed when they are destroyed. This behaviour can now be disabled by setting `Explodes.KillPassengers=false`.
@@ -1117,7 +1115,7 @@ In `rulesmd.ini`:
 ```ini
 [General]
 SubterraneanHeight=-256  ; integer, height in leptons (1/256th of a cell)
-SubterraneanSpeed=7.5    ; floating point value
+SubterraneanSpeed=19     ; floating point value
 
 [SOMETECHNO]             ; TechnoType
 SubterraneanHeight=      ; integer, height in leptons (1/256th of a cell)
@@ -1426,10 +1424,10 @@ KeepTargetOnMove.ExtraDistance=0  ; floating point value, distance in cells
 
 In `rulesmd.ini`:
 ```ini
-[SOMEVEHICLE]           ; VehicleType
-Sinkable=               ; bool
-SinkSpeed=5             ; integer, lepton per frame
-Sinkable.SquidGrab=true    ; bool
+[SOMEVEHICLE]              ; VehicleType
+Sinkable=                  ; boolean
+SinkSpeed=5                ; integer, leptons per frame
+Sinkable.SquidGrab=true    ; boolean
 ```
 
 ### Stationary vehicles
@@ -1604,7 +1602,7 @@ Debris.Conventional=false  ; boolean
 In `rulesmd.ini`:
 ```ini
 [SOMEWARHEAD]                   ; WarheadType
-Rocker.AmplitudeMultiplier=1.0  ; double
+Rocker.AmplitudeMultiplier=1.0  ; floating point value, multiplier
 Rocker.AmplitudeOverride=       ; integer
 ```
 

docs/New-or-Enhanced-Logics.md

@@ -1619,7 +1619,7 @@ RecountBurst=       ; boolean
 - Similar to `DeathWeapon` in that it is fired after a TechnoType is killed, but with the difference that it will be fired on whoever dealt the damage that killed the TechnoType. If TechnoType died of sources other than direct damage dealt by another TechnoType, `RevengeWeapon` will not be fired.
   - `RevengeWeapon.AffectsHouses` can be used to filter which houses the damage that killed the TechnoType is allowed to come from to fire the weapon.
   - It is possible to grant revenge weapons through [attached effects](#attached-effects) as well.
-  - Ìf a Warhead has `SuppressRevengeWeapons` set to true, it will not trigger revenge weapons. `SuppressRevengeWeapons.Types` can be used to list WeaponTypes affected by this, if none are listed all WeaponTypes are affected.
+  - If a Warhead has `SuppressRevengeWeapons` set to true, it will not trigger revenge weapons. `SuppressRevengeWeapons.Types` can be used to list WeaponTypes affected by this, if none are listed all WeaponTypes are affected.
 
 In `rulesmd.ini`:
 ```ini
@@ -1681,7 +1681,7 @@ WarpOutWeapon=                          ; WeaponType
 
 ### Fast access vehicle
 
-- Now you can let infantry or vehicle passengers quickly enter or leave the transport vehicles without queuing. Defaults to `[General]->NoQueueUpToEnter` or `[General]->NoQueueUpToUnload`.
+- Now you can let infantry or vehicle passengers quickly enter or leave the transport vehicles without queuing. Defaults to `[General] -> NoQueueUpToEnter` or `[General] -> NoQueueUpToUnload`.
 
 In `rulesmd.ini`:
 ```ini
@@ -1898,18 +1898,18 @@ While this feature can provide better performance than a large `CellSpread` valu
 ### Fire weapon when kill
 
 - `KillWeapon` will be fired at the target TechnoType's location once it's been killed by this Warhead.
-  - `KillWeapon.AffectsHouses` is used to filter which houses targets can belong to be considered valid for KillWeapon.
-- Ìf a TechnoType has `SuppressKillWeapons` set to true, it will not trigger KillWeapon upon being killed. `SuppressKillWeapons.Types` can be used to list WeaponTypes affected by this, if none are listed all WeaponTypes are affected.
+  - `KillWeapon.AffectsHouses` is used to filter which houses targets can belong to be considered valid for `KillWeapon`.
+- If a TechnoType has `SuppressKillWeapons` set to true, it will not trigger `KillWeapon` upon being killed. `SuppressKillWeapons.Types` can be used to list WeaponTypes affected by this, if none are listed all WeaponTypes are affected.
 
  In `rulesmd.ini`:
 ```ini
-[SOMEWARHEAD]                   ; Warhead
+[SOMEWARHEAD]                   ; WarheadType
 KillWeapon=                     ; WeaponType
-KillWeapon.AffectsHouses=all    ; list of Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
+KillWeapon.AffectsHouses=all    ; List of Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
 
 [SOMETECHNO]                    ; TechnoType
 SuppressKillWeapons=false       ; boolean
-SuppressKillWeapons.Types=      ; list of WeaponTypes
+SuppressKillWeapons.Types=      ; List of WeaponTypes
 ```
 
 ### Generate credits on impact
@@ -2174,21 +2174,6 @@ Strafing.UseAmmoPerShot=false  ; boolean
 Strafing.EndDelay=             ; integer, game frames
 ```
 
-### Weapon targeting filter
-
-![image](_static/images/weaponfilter.gif)
-*`Weapon target filter - different weapon used against enemies & allies as well as units & buildings in [Project Phantom](https://www.moddb.com/mods/project-phantom)*
-
-- You can now specify which targets or houses a weapon can fire at. This also affects weapon selection, other than certain special cases where the selection is fixed.
-  - Note that `CanTarget` explicitly requires either `all` or `empty` to be listed for the weapon to be able to fire at cells containing no TechnoTypes.
-
-In `rulesmd.ini`:
-```ini
-[SOMEWEAPON]         ; WeaponType
-CanTarget=all        ; List of Affected Target Enumeration (none|land|water|empty|infantry|units|buildings|all)
-CanTargetHouses=all  ; List of Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
-```
-
 ### Visual effect scatter
 
 - You can now add a random offset to visual effect's (`IsLaser=true`, `IsElectricBolt=true` or `IsRadBeam=true`) target location if set `VisualScatter` to true.
@@ -2204,5 +2189,20 @@ VisualScatter=false     ; boolean
 ```
 
 ```{note}
-This function is only used as an additional scattering visual display, which is different from `BallisticScatter` and can be used simultaneously, without affecting the actual explosion position of the projectile.
+This function is only used as an additional scattering visual display, which is different from `BallisticScatter.(Min/Max)` and can be used simultaneously, without affecting the actual explosion position of the projectile.
+```
+
+### Weapon targeting filter
+
+![image](_static/images/weaponfilter.gif)
+*`Weapon target filter - different weapon used against enemies & allies as well as units & buildings in [Project Phantom](https://www.moddb.com/mods/project-phantom)*
+
+- You can now specify which targets or houses a weapon can fire at. This also affects weapon selection, other than certain special cases where the selection is fixed.
+  - Note that `CanTarget` explicitly requires either `all` or `empty` to be listed for the weapon to be able to fire at cells containing no TechnoTypes.
+
+In `rulesmd.ini`:
+```ini
+[SOMEWEAPON]         ; WeaponType
+CanTarget=all        ; List of Affected Target Enumeration (none|land|water|empty|infantry|units|buildings|all)
+CanTargetHouses=all  ; List of Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
 ```

docs/Whats-New.md

@@ -319,6 +319,7 @@ New:
 - Custom exit cell for infantry factory (by Starkku)
 - Option for vehicles to keep target when issued move command (by Starkku)
 - Skip anim delay for burst fire (by TaranDahl)
+- Extending `Power` to all TechnoTypes (by Morton)
 - New Parabola trajectory (by CrimRecya)
 - Type select for buildings (code by TaranDahl, doc by Ollerus)
 - Raise alert when technos are taking damage (by TaranDahl)
@@ -332,7 +333,6 @@ New:
 - Extended gattling rate down logic (by CrimRecya)
 - Sell or undeploy building on impact (by CrimRecya)
 - No rearm and reload in EMP or temporal (by CrimRecya)
-- Draw visual effects for airburst weapons (by CrimRecya)
 - Technos recount current burst index when change the firing weapon (by CrimRecya)
 - Shield armor inheritance customization (by Ollerus)
 - Damaged unit image changes (by Fryone)
@@ -351,9 +351,10 @@ New:
 - Laser, electric bolt and rad beam scatter (by CrimRecya)
 - [Airburst weapon firing/source coordinate customizations](Fixed-or-Improved-Logics.md#airburst--splits) (by Starkku)
 - [AlternateFLH on-turret toggle](Fixed-or-Improved-Logics.md#alternate-flh-customizations) (by Starkku)
-- Prone speed customization (by TaranDahl)
-- Customize damaged speed ratio of drive/ship loco (by NetsuNegi)
-- Customize overpower logic (by NetsuNegi)
+- [Fire weapon when kill](New-or-Enhanced-Logics.md#fire-weapon-when-kill) (by Ollerus)
+- [Prone speed customization](Fixed-or-Improved-Logics.md#prone-speed-customization) (by TaranDahl)
+- [Customize damaged speed ratio of drive/ship loco](Fixed-or-Improved-Logics.md#damaged-speed-customization) (by NetsuNegi)
+- [Customize overpower logic](Fixed-or-Improved-Logics.md#customize-overpower-logic) (by NetsuNegi)
 
 Vanilla fixes:
 - Prevent the units with locomotors that cause problems from entering the tank bunker (by TaranDahl)
@@ -533,9 +534,8 @@ New:
 - Allow infantry to use land sequences in water (by Starkku)
 - `<Player @ X>` can now be used as owner for pre-placed objects on skirmish and multiplayer maps (by Starkku)
 - Allow customizing charge turret delays per burst on a weapon (by Starkku)
+- Draw visual effects for airburst weapons (by CrimRecya)
 - Unit `Speed` setting now accepts floating point values (by Starkku)
-- Extending `Power` to all TechnoTypes (by Morton)
-- Fire weapon when kill (by Ollerus)
 
 Vanilla fixes:
 - Allow AI to repair structures built from base nodes/trigger action 125/SW delivery in single player missions (by Trsdy)
@@ -710,6 +710,7 @@ Fixes / interactions with other extensions:
 - Suppressed Ares' swizzle warning when parsing `Tags` and `TaskForces` (by Trsdy)
 - Fixed Academy *(Ares feature)* not working on the initial payloads *(Ares feature)* of vehicles built from a war factory (by Trsdy, supersedes Aephiex impl.)
 - Fixed Ares' InitialPayload not being created for vehicles spawned by trigger actions (by Trsdy)
+- Taking over Ares' AlphaImage respawn logic to reduce lags from it (by NetsuNegi)
 </details>
 
 ### 0.3.0.1
@@ -882,7 +883,7 @@ Vanilla fixes:
 - Fixed railgun particles being drawn to wrong coordinate against buildings with non-default `TargetCoordOffset` or when force-firing on bridges (by Starkku)
 - Fixed building `TargetCoordOffset` not being taken into accord for several things like fire angle calculations and target lines (by Starkku)
 - Allowed observers to see a selected building's radial indicator (by Trsdy)
-- Allow voxel projectiles to use AnimPalette and FirersPalette (by NetsuNegi)
+- Allow voxel projectiles to use `AnimPalette` and `FirersPalette` (by NetsuNegi)
 
 Phobos fixes:
 - Fixed shields being able to take damage when the parent TechnoType was under effects of a `Temporal` Warhead (by Starkku)