Skip to content

Commit 3798f3f

Browse files
MetadoriusMetadorius
committed
Move doc section to the proper place
1 parent 81f29ff commit 3798f3f

File tree

1 file changed

+65
-65
lines changed

1 file changed

+65
-65
lines changed

‎docs/User-Interface.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -615,70 +615,6 @@ ShowWeedsCounter=true ; boolean
615615
Default position for weeds counter overlaps with [harvester counter](#harvester-counter).
616616
```
617617

618-
## Tooltips
619-
620-
![image](_static/images/tooltips-01.png)
621-
*Extended tooltips used in [CnC: Final War](https://www.moddb.com/mods/cncfinalwar)*
622-
623-
- Sidebar tooltips can now display extended information about the TechnoType/SWType when hovered over it's cameo. In addition the low character limit is lifted when the feature is enabled via the corresponding tag, allowing for 1024 character long tooltips.
624-
- TechnoType's tooltip would display it's name, cost, power, build time and description (when applicable).
625-
- SWType's tooltip would display it's name, cost, and recharge time (when applicable).
626-
- If `SW.Shots` from Ares is used, a C-style format string default to `Shots: %d` is appended. The format is customizable in csf. If a 2-parameter format (like `%d/%d shots left`) is used, the second integer is `SW.Shots`.
627-
- Extended tooltips don't use `TXT_MONEY_FORMAT_1` and `TXT_MONEY_FORMAT_2`. Instead you can specify cost, power and time labels (displayed before correspoding values) with the corresponding tags. Characters `$ U+0024`, `⚡ U+26A1` and `⌚ U+231A` are used by default.
628-
- Fixed a bug when switching build queue tabs via QWER didn't make tooltips disappear as they should, resulting in stuck tooltips.
629-
- The tooltips can now go over the sidebar bounds to accommodate for longer contents. You can control maximum text width with a new tag (paddings are excluded from the number you specify).
630-
- `AnchoredToolTips` positions the tooltip always to the left of sidebar, only applies to if `ExtendedToolTips` is set to true and they are enabled in user settings.
631-
632-
In `uimd.ini`:
633-
```ini
634-
[ToolTips]
635-
ExtendedToolTips=false ; boolean
636-
AnchoredToolTips=false ; boolean
637-
CostLabel=<none> ; CSF entry key
638-
PowerLabel=<none> ; CSF entry key
639-
PowerBlackoutLabel=<none> ; CSF entry key
640-
TimeLabel=<none> ; CSF entry key
641-
SWShotsFormat=<none> ; CSF entry key
642-
MaxWidth=0 ; integer, pixels
643-
```
644-
In `rulesmd.ini`:
645-
```ini
646-
[SOMENAME] ; TechnoType or SWType
647-
UIDescription=<none> ; CSF entry key
648-
```
649-
650-
- The descriptions are designed to be toggleable by users. For now you can only do that externally via client or manually.
651-
652-
In `RA2MD.INI`:
653-
```ini
654-
[Phobos]
655-
ToolTipDescriptions=true ; boolean
656-
```
657-
658-
```{note}
659-
Same as with harvester counter, you can download the improved font (v4 and higher; can be found on [Phobos supplementaries repo](https://github.com/Phobos-developers/PhobosSupplementaries)) or draw your own icons.
660-
```
661-
662-
- The background color and opacity of tooltips can now be customized globally or per side.
663-
664-
In `rulesmd.ini`:
665-
```ini
666-
[SOMESIDE] ; Side
667-
ToolTip.Background.Color=0,0,0 ; integer - R,G,B, defaults to [AudioVisual] -> ToolTip.Background.Color, which defaults to 0,0,0
668-
ToolTip.Background.Opacity=100 ; integer, ranged in [0, 100], defaults to [AudioVisual] -> ToolTip.Background.Opacity, which defaults to 100
669-
ToolTip.Background.BlurSize=0.0 ; float, defaults to [AudioVisual] -> ToolTip.Background.BlurSize, which defaults to 0.0
670-
```
671-
672-
```{note}
673-
The blur effect is resource intensive. Please make sure you really want to enable this effect, otherwise leave it to 0.0 so it stays disabled.
674-
```
675-
676-
In `RA2MD.INI`:
677-
```ini
678-
[Phobos]
679-
ToolTipBlur=false ; boolean, whether the blur effect of tooltips will be enabled.
680-
```
681-
682618
### SuperWeapon Sidebar
683619

684620
![image](_static/images/sw_sidebar.png)
@@ -749,4 +685,68 @@ SuperWeaponSidebar.RequiredSignificance=0 ; integer
749685

750686
```{hint}
751687
While the feature is usable without any extra graphics, you can find example assets to use with vanilla graphics on [Phobos supplementaries repo](https://github.com/Phobos-developers/PhobosSupplementaries)).
752-
```
688+
```
689+
690+
## Tooltips
691+
692+
![image](_static/images/tooltips-01.png)
693+
*Extended tooltips used in [CnC: Final War](https://www.moddb.com/mods/cncfinalwar)*
694+
695+
- Sidebar tooltips can now display extended information about the TechnoType/SWType when hovered over it's cameo. In addition the low character limit is lifted when the feature is enabled via the corresponding tag, allowing for 1024 character long tooltips.
696+
- TechnoType's tooltip would display it's name, cost, power, build time and description (when applicable).
697+
- SWType's tooltip would display it's name, cost, and recharge time (when applicable).
698+
- If `SW.Shots` from Ares is used, a C-style format string default to `Shots: %d` is appended. The format is customizable in csf. If a 2-parameter format (like `%d/%d shots left`) is used, the second integer is `SW.Shots`.
699+
- Extended tooltips don't use `TXT_MONEY_FORMAT_1` and `TXT_MONEY_FORMAT_2`. Instead you can specify cost, power and time labels (displayed before correspoding values) with the corresponding tags. Characters `$ U+0024`, `⚡ U+26A1` and `⌚ U+231A` are used by default.
700+
- Fixed a bug when switching build queue tabs via QWER didn't make tooltips disappear as they should, resulting in stuck tooltips.
701+
- The tooltips can now go over the sidebar bounds to accommodate for longer contents. You can control maximum text width with a new tag (paddings are excluded from the number you specify).
702+
- `AnchoredToolTips` positions the tooltip always to the left of sidebar, only applies to if `ExtendedToolTips` is set to true and they are enabled in user settings.
703+
704+
In `uimd.ini`:
705+
```ini
706+
[ToolTips]
707+
ExtendedToolTips=false ; boolean
708+
AnchoredToolTips=false ; boolean
709+
CostLabel=<none> ; CSF entry key
710+
PowerLabel=<none> ; CSF entry key
711+
PowerBlackoutLabel=<none> ; CSF entry key
712+
TimeLabel=<none> ; CSF entry key
713+
SWShotsFormat=<none> ; CSF entry key
714+
MaxWidth=0 ; integer, pixels
715+
```
716+
In `rulesmd.ini`:
717+
```ini
718+
[SOMENAME] ; TechnoType or SWType
719+
UIDescription=<none> ; CSF entry key
720+
```
721+
722+
- The descriptions are designed to be toggleable by users. For now you can only do that externally via client or manually.
723+
724+
In `RA2MD.INI`:
725+
```ini
726+
[Phobos]
727+
ToolTipDescriptions=true ; boolean
728+
```
729+
730+
```{note}
731+
Same as with harvester counter, you can download the improved font (v4 and higher; can be found on [Phobos supplementaries repo](https://github.com/Phobos-developers/PhobosSupplementaries)) or draw your own icons.
732+
```
733+
734+
- The background color and opacity of tooltips can now be customized globally or per side.
735+
736+
In `rulesmd.ini`:
737+
```ini
738+
[SOMESIDE] ; Side
739+
ToolTip.Background.Color=0,0,0 ; integer - R,G,B, defaults to [AudioVisual] -> ToolTip.Background.Color, which defaults to 0,0,0
740+
ToolTip.Background.Opacity=100 ; integer, ranged in [0, 100], defaults to [AudioVisual] -> ToolTip.Background.Opacity, which defaults to 100
741+
ToolTip.Background.BlurSize=0.0 ; float, defaults to [AudioVisual] -> ToolTip.Background.BlurSize, which defaults to 0.0
742+
```
743+
744+
```{note}
745+
The blur effect is resource intensive. Please make sure you really want to enable this effect, otherwise leave it to 0.0 so it stays disabled.
746+
```
747+
748+
In `RA2MD.INI`:
749+
```ini
750+
[Phobos]
751+
ToolTipBlur=false ; boolean, whether the blur effect of tooltips will be enabled.
752+
```

0 commit comments

Comments
 (0)