Skip to content

Commit ad05c75

Browse files
DeathFishAtEaseMetadorius
authored andcommitted
[Minor] Weekly Regular Documentation Revisions 06.09-06.15 - develop (#1709)
1 parent 6874879 commit ad05c75

13 files changed

+3655
-3133
lines changed

docs/Fixed-or-Improved-Logics.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ This page describes all ingame logics that are fixed or improved in Phobos witho
230230
- Fixed the bug that uncontrolled scatter when elite techno attacked by aircraft or some unit try crush it.
231231
- Second weapon with `ElectricAssault=yes` will not unconditionally attack your building with `Overpowerable=yes`.
232232
- Infantry support `IsGattling=yes`.
233-
- Fixed the issue that the widespread damage caused by detonation on the bridge/ground cannot affect objects on the ground/bridge who are in the opposite case.
233+
- Fixed an issue that the widespread damage caused by detonation on the bridge/ground cannot affect objects on the ground/bridge who are in the opposite case.
234234
- Fixed the bug that `DamageSelf` and `AllowDamageOnSelf` are ineffective on airforce.
235235
- Fixed the bug that damaged particle dont disappear after building has repaired by engineer.
236236
- Fixed the issue of incorrect position of `TrailerAnim` in `VoxelAnim`.
@@ -294,7 +294,7 @@ In `rulesmd.ini`:
294294
[General]
295295
ExtendedAircraftMissions=false ; boolean
296296

297-
[SOMEAIRCRAFT] ; AircraftType
297+
[SOMEAIRCRAFT] ; AircraftType
298298
ExtendedAircraftMissions.SmoothMoving= ; boolean, default to [General] -> ExtendedAircraftMissions
299299
ExtendedAircraftMissions.EarlyDescend= ; boolean, default to [General] -> ExtendedAircraftMissions
300300
ExtendedAircraftMissions.RearApproach= ; boolean, default to [General] -> ExtendedAircraftMissions
@@ -1796,7 +1796,7 @@ UseWeeds.ReadinessAnimationPercentage=0.9 ; double - when this many weeds
17961796

17971797
### Customizable debris trailer anim spawn delay
17981798

1799-
- You can now customize the generation interval of VoxelAnim's trailer animation
1799+
- You can now customize the generation interval of VoxelAnim's trailer animation.
18001800

18011801
In `rulesmd.ini`:
18021802
```ini
@@ -1858,20 +1858,6 @@ Rocker.AmplitudeMultiplier=1.0 ; floating point value, multiplier
18581858
Rocker.AmplitudeOverride= ; integer
18591859
```
18601860

1861-
### Customizable Warhead trigger conditions
1862-
1863-
- It is now possible to make warheads only trigger when target's HP is above and/or below certain percentage.
1864-
- Both conditions need to evaluate to true in order for the warhead to trigger.
1865-
- If set to `false`, `EffectsRequireVerses` makes the Phobos-introduced warhead effects trigger even if it can't damage the target because of it's current ArmorType (e.g. 0% in `Verses`).
1866-
1867-
In `rulesmd.ini`:
1868-
```ini
1869-
[SOMEWARHEAD] ; WarheadType
1870-
AffectsAbovePercent=0.0 ; floating point value, percents or absolute
1871-
AffectsBelowPercent=1.0 ; floating point value, percents or absolute
1872-
EffectsRequireVerses=false ; boolean
1873-
```
1874-
18751861
### Customizable Warhead animation behaviour
18761862

18771863
- It is possible to make game play random animation from `AnimList` by setting `AnimList.PickRandom` to true. The result is similar to what `EMEffect=true` produces, however it comes with no side-effects (`EMEffect=true` prevents `Inviso=true` projectiles from snapping on targets, making them miss moving targets).
@@ -1901,6 +1887,20 @@ CreateAnimsOnZeroDamage=false ; boolean
19011887
Conventional.IgnoreUnits=false ; boolean
19021888
```
19031889

1890+
### Customizable Warhead trigger conditions
1891+
1892+
- It is now possible to make warheads only trigger when target's HP is above and/or below certain percentage.
1893+
- Both conditions need to evaluate to true in order for the warhead to trigger.
1894+
- If set to `false`, `EffectsRequireVerses` makes the Phobos-introduced warhead effects trigger even if it can't damage the target because of it's current ArmorType (e.g. 0% in `Verses`).
1895+
1896+
In `rulesmd.ini`:
1897+
```ini
1898+
[SOMEWARHEAD] ; WarheadType
1899+
AffectsAbovePercent=0.0 ; floating point value, percents or absolute
1900+
AffectsBelowPercent=1.0 ; floating point value, percents or absolute
1901+
EffectsRequireVerses=false ; boolean
1902+
```
1903+
19041904
### Customizing decloak on damaging targets
19051905

19061906
- You can now specify whether or not the warhead decloaks objects that are damaged by the warhead.

docs/General-Info.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ There are three main types of Phobos builds:
99
- *development builds* - those are the builds which contain functionality that needs to be tested. They are numbered plainly starting from 0 and incrementing the number on each release. Mod authors still can include those versions with their mods if they want latest features, though we can't guarantee lack of bugs;
1010
- *nightly builds* - bleeding edge versions which can include prototypes, proofs of concepts, scrapped features etc., in other words - we can't guarantee anything in those builds and they absolutely should NOT be used in mod releases and should only be used to help with development and testing.
1111

12+
```{hint}
13+
You can find the downloads for these versions on the document's [main page](index.md#downloads).
14+
```
15+
1216
### Disabling development build warning
1317

1418
**DISCLAIMER:** We understand that everyone wants to try and use the new features as soon as they're released, but we can't do all the testing ourselves, so we only test the functionality on a basic level. We ask everyone who uses the new development build first to **test the new changes in every possible way first before disabling the development build warning** and proceeding to include the build in your mod release. This would allow us to concentrate on implementing the actual features, which is the most complex task. Learn more on testing [here](Contributing.md#testing).

docs/New-or-Enhanced-Logics.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,23 @@ In `rulesmd.ini`:
558558
IsDestroyableObstacle=false ; boolean
559559
```
560560

561+
### Engineer repair customization
562+
563+
- You can now set a maximum amount when engineer repair a building for either of them. 0 means the building will be repaired to full health.
564+
- Negative value means percentage. For example, `EngineerRepairAmount=-50` means you can only repair 50% of the building's health per Engineer.
565+
- If both the building and the engineer has `EngineerRepairAmount` set, the actual repair amount will be the minimum of them.
566+
- `BuildingRepairedSound` can now be set individually for each building type.
567+
568+
In `rulesmd.ini`:
569+
```ini
570+
[SOMEBUILDING] ; BuildingType
571+
EngineerRepairAmount=0 ; integer
572+
BuildingRepairedSound= ; Sound entry, default to [AudioVisual] -> BuildingRepairedSound
573+
574+
[SOMEINFANTRY] ; InfantryType
575+
EngineerRepairAmount=0 ; integer
576+
```
577+
561578
### Extended building upgrades
562579

563580
![image](_static/images/powersup.owner-01.png)
@@ -605,23 +622,6 @@ SpyEffect.VictimSuperWeapon= ; SuperWeaponType
605622
SpyEffect.InfiltratorSuperWeapon= ; SuperWeaponType
606623
```
607624

608-
### Engineer repair customization
609-
610-
- You can now set a maximum amount when engineer repair a building for either of them. 0 means the building will be repaired to full health.
611-
- Negative value means percentage. For example, `EngineerRepairAmount=-50` means you can only repair 50% of the building's health per Engineer.
612-
- If both the building and the engineer has `EngineerRepairAmount` set, the actual repair amount will be the minimum of them.
613-
- `BuildingRepairedSound` can now be set individually for each building type.
614-
615-
In `rulesmd.ini`
616-
```ini
617-
[SOMEBUILDING] ; BuildingType
618-
EngineerRepairAmount=0 ; integer
619-
BuildingRepairedSound= ; Sound entry, default to [AudioVisual] -> BuildingRepairedSound
620-
621-
[SOMEINFANTRY] ; InfantryType
622-
EngineerRepairAmount=0 ; integer
623-
```
624-
625625
## Infantry
626626

627627
### Customizable FLH when infantry is prone or deployed
@@ -1731,7 +1731,7 @@ VoiceCreated= ; Sound entry
17311731
In `rulesmd.ini`:
17321732
```ini
17331733
[General]
1734-
BerzerkTargeting=all ; AffectedHouse enumeration
1734+
BerzerkTargeting=all ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
17351735
```
17361736

17371737
### Tiberium eater
@@ -1755,7 +1755,7 @@ TiberiumEater.CellN= ; X,Y - cell offset
17551755
TiberiumEater.CashMultiplier=1.0 ; floating point value
17561756
TiberiumEater.AmountPerCell=0 ; integer
17571757
TiberiumEater.Display=true ; boolean
1758-
TiberiumEater.Display.Houses=all ; AffectedHouse enumeration
1758+
TiberiumEater.Display.Houses=all ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
17591759
TiberiumEater.Anims= ; List of AnimationTypes
17601760
TiberiumEater.Anims.Tiberium0= ; List of AnimationTypes
17611761
TiberiumEater.Anims.Tiberium1= ; List of AnimationTypes
@@ -1894,7 +1894,8 @@ FireUp.ResetInRetarget=true ; boolean
18941894
All new Warhead effects
18951895
- Can be used with `CellSpread` and Ares' GenericWarhead superweapon where applicable.
18961896
- Cannot be used with `MindControl.Permanent=yes` of Ares.
1897-
- Respect `Verses` where applicable unless `EffectsRequireVerses` is set to `false`. If target has an active shield, its armor type is used instead unless warhead can penetrate the shield.
1897+
- Respect `Verses` where applicable unless `EffectsRequireVerses` is set to `false`.
1898+
- If target has an active [shield](#shields), its armor type is used instead unless warhead can penetrate the shield.
18981899
```
18991900

19001901
### Break Mind Control on impact
@@ -2105,7 +2106,7 @@ In `rulesmd.ini`:
21052106
TransactMoney=0 ; integer - credits added or subtracted
21062107
TransactMoney.Display=false ; boolean
21072108
TransactMoney.Display.AtFirer=false ; boolean
2108-
TransactMoney.Display.Houses=All ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
2109+
TransactMoney.Display.Houses=all ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
21092110
TransactMoney.Display.Offset=0,0 ; X,Y, pixels relative to default
21102111
```
21112112

docs/User-Interface.md

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,32 @@ IngameScore.LoseTheme= ; Soundtrack theme ID
3636

3737
- You can now configure various types of numerical counters to be displayed over Techno to represent its attributes, such as health points or shield points and can be turned on or off via a [new hotkey](#toggle-digital-display).
3838
- `InfoIndex` defines the specific `InfoType`.
39-
- In `InfoType=Spawns`, 0 - alive spawns, 1 - docked spawns, 2 - launching spawns.
40-
- In `InfoType=Tiberium`, 0 - all, 1 - the first tiberium, 2 - the second tiberium, ...
41-
- In `InfoType=SpawnTimer`, 0 - the fastest spawnee, 1 - the first spawnee, 2 - the second spawnee, ...
42-
- In `InfoType=SuperWeapon`, 0 - the first SW of all, 1 - SW, 2 - SW2, 3 - the first SWs' SW, ...
43-
- In `InfoType=FactoryProcess`, 0 - the first factory in production, 1 - primary factory, 2 - secondary factory.
39+
- In `InfoType=Spawns`,
40+
- 0 - alive spawns,
41+
- 1 - docked spawns,
42+
- 2 - launching spawns.
43+
<br><br>
44+
- In `InfoType=Tiberium`,
45+
- 0 - all,
46+
- 1 - the first tiberium,
47+
- 2 - the second tiberium,
48+
<br>...
49+
- In `InfoType=SpawnTimer`,
50+
- 0 - the fastest spawnee,
51+
- 1 - the first spawnee,
52+
- 2 - the second spawnee,
53+
<br>...
54+
- In `InfoType=SuperWeapon`,
55+
- 0 - the first SW of all,
56+
- 1 - `[BuildingType] -> SuperWeapon`,
57+
- 2 - `[BuildingType] -> SuperWeapon2`,
58+
- 3 - the first SW in `[BuildingType] -> SuperWeapons`,
59+
<br>...
60+
- In `InfoType=FactoryProcess`,
61+
- 0 - the first factory in production,
62+
- 1 - primary factory,
63+
- 2 - secondary factory.
64+
<br><br>
4465
- `Anchor.Horizontal` and `Anchor.Vertical` set the anchor point from which the display is drawn (depending on `Align`) relative to unit's center/selection box. For buildings, `Anchor.Building` is used instead.
4566
- `Offset` and `Offset.ShieldDelta` (the latter applied when a shield is active) can be used to further modify the position.
4667
- By default, values are displayed in `current/maximum` format (i.e. `20/40`).
@@ -65,10 +86,10 @@ In `rulesmd.ini`:
6586
0=SOMEDIGITALDISPLAYTYPE
6687

6788
[AudioVisual]
68-
Buildings.DefaultDigitalDisplayTypes= ; list of DigitalDisplayTypes
69-
Infantry.DefaultDigitalDisplayTypes= ; list of DigitalDisplayTypes
70-
Vehicles.DefaultDigitalDisplayTypes= ; list of DigitalDisplayTypes
71-
Aircraft.DefaultDigitalDisplayTypes= ; list of DigitalDisplayTypes
89+
Buildings.DefaultDigitalDisplayTypes= ; List of DigitalDisplayTypes
90+
Infantry.DefaultDigitalDisplayTypes= ; List of DigitalDisplayTypes
91+
Vehicles.DefaultDigitalDisplayTypes= ; List of DigitalDisplayTypes
92+
Aircraft.DefaultDigitalDisplayTypes= ; List of DigitalDisplayTypes
7293

7394
[SOMEDIGITALDISPLAYTYPE] ; DigitalDisplayType
7495
; Generic
@@ -82,7 +103,7 @@ Anchor.Vertical=top ; Vertical position enumeration (
82103
Anchor.Building=top ; Hexagon vertex enumeration (top|lefttop|leftbottom|bottom|rightbottom|righttop)
83104
Percentage=false ; boolean
84105
HideMaxValue=false ; boolean
85-
VisibleToHouses=owner ; Affected house enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
106+
VisibleToHouses=owner ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
86107
VisibleToHouses.Observer=true ; boolean
87108
VisibleInSpecialState=true ; boolean
88109
ValueScaleDivisor= ; integer
@@ -98,9 +119,9 @@ Palette=palette.pal ; filename with .pal extension
98119
Shape.Spacing= ; integers - horizontal, vertical spacing between digits
99120
Shape.PercentageFrame=false ; boolean
100121

101-
[SOMETECHNOTYPE]
122+
[SOMETECHNOTYPE] ; TechnoType
102123
DigitalDisplay.Disable=false ; boolean
103-
DigitalDisplayTypes= ; list of DigitalDisplayTypes
124+
DigitalDisplayTypes= ; List of DigitalDisplayTypes
104125
DigitalDisplay.Health.FakeAtDisguise=true ; boolean
105126
```
106127

@@ -114,6 +135,21 @@ DigitalDisplay.Enable=false ; boolean
114135
An example shape file for digits can be found on [Phobos supplementaries repo](https://github.com/Phobos-developers/PhobosSupplementaries).
115136
```
116137

138+
````{note}
139+
`Shape.PercentageFrame` effectively provides the ultimate solution for all static data display effects: it allows mapping the current value to a specific static frame index in a shape file sequence by calculating its proportional ratio to the total value, where the concrete image on this frame is entirely user-defined.
140+
141+
```{hint}
142+
You can create a circular health bar for technos, where the different frames of this ring Shape file correspond to the state of the circular health bar at varying degrees of damage.
143+
144+
![image](_static/images/ring-health-bar.gif)
145+
*Example of a ring-shaped health bar*
146+
147+
The arrangement of static images on the plane is entirely up to you to draw freely, without being constrained by pre-established frameworks (e.g., the original rule for health bars was to start at a fixed coordinate, fetch a pip from a fixed frame of a fixed file at fixed intervals, and then arrange them horizontally), choosing from inherently limited options.
148+
```
149+
150+
Of course, this is just the implementation method. To balance freedom with efficiency—that is, how to efficiently draw the patterns you need—you still need to independently explore a workflow that suits you.
151+
````
152+
117153
### Flashing Technos on selecting
118154

119155
- Selecting technos, controlled by player, now may show a flash effect by setting `SelectionFlashDuration` parameter higher than 0.

docs/Whats-New.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -391,10 +391,11 @@ New:
391391
- [Turretless vehicles with `Voxel=no` support use `FireUp` like infantry](New-or-Enhanced-Logics.md#turretless-shape-vehicle-fireup) (by FlyStar)
392392
- Infantry support `IsGattling=yes` (by FlyStar)
393393
- [Several new Infotypes, no display in specific status and a new single frame display method](User-Interface.md#digital-display) (by CrimRecya)
394-
- Targeting limitation for berzerk technos (by TaranDahl)
394+
- [Targeting limitation for berzerk technos](New-or-Enhanced-Logics.md#targeting-limitation-for-berzerk-technos) (by TaranDahl)
395395
- Allowed faking digital display for `InfoType=Health` at disguise (by Ollerus)
396+
- [Warhead activation target health thresholds](Fixed-or-Improved-Logics.md#customizable-warhead-trigger-conditions) (by FS-21 & Kerbiter)
396397
- [Customize limit and sound when engineer repair a building](New-or-Enhanced-Logics.md#engineer-repair-customization) (by NetsuNegi)
397-
- Customizable debris trailer anim spawn delay (by CrimRecya)
398+
- [Customizable debris trailer anim spawn delay](Fixed-or-Improved-Logics.md#customizable-debris-trailer-anim-spawn-delay) (by CrimRecya)
398399
399400
Vanilla fixes:
400401
- Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)
@@ -418,7 +419,7 @@ Vanilla fixes:
418419
- Fixed an issue where airstrike flare line drawn to target at lower elevation would clip (by Starkku)
419420
- Fixed the bug that uncontrolled scatter when elite techno attacked by aircraft or some unit try crush it (by NetsuNegi)
420421
- Second weapon with `ElectricAssault=yes` will not unconditionally attack your building with `Overpowerable=yes` (by FlyStar)
421-
- Fixed the issue that the widespread damage caused by detonation on the bridge/ground cannot affect objects on the ground/bridge who are in the opposite case (by CrimRecya)
422+
- Fixed an issue that the widespread damage caused by detonation on the bridge/ground cannot affect objects on the ground/bridge who are in the opposite case (by CrimRecya)
422423
- Fixed the bug that `DamageSelf` and `AllowDamageOnSelf` are ineffective on airforce (by NetsuNegi)
423424
- Fixed the bug that damaged particle dont disappear after building has repaired by engineer (by NetsuNegi)
424425
- Fixed the issue of incorrect position of `TrailerAnim` in `VoxelAnim` (by CrimRecya)
@@ -603,7 +604,6 @@ New:
603604
- Draw visual effects for airburst weapons (by CrimRecya)
604605
- Unit `Speed` setting now accepts floating point values (by Starkku)
605606
- `Strafing` is now disabled by default when using `Trajectory` (by CrimRecya)
606-
- Warhead activation target health thresholds (by FS-21, Kerbiter)
607607
608608
Vanilla fixes:
609609
- Allow AI to repair structures built from base nodes/trigger action 125/SW delivery in single player missions (by Trsdy)
296 KB
Loading

0 commit comments

Comments
 (0)