Exclusive SuperWeapon Sidebar (#1384)

- It is possible to put sw cameos on the left of screen like C&C3 when
`SuperWeaponSidebar` is true. Cameos arranged in a pyramid shape. In
theory, it should be compatible with Ares.
- 当 `SuperWeaponSidebar`
为true时，可以把超级武器的图标排列在屏幕左侧了，就像命令与征服3中那样。图标按照金字塔形状排列。理论上它应该是兼容Ares的。
- `SuperWeaponSidebar.Interval` controls the distance between two column
cameos (excluding the background). When you need to make a background,
the width of the background should be (`SuperWeaponSidebar.Interval` +
cameo fixed width 60).
- `SuperWeaponSidebar.Interval`
控制两列图标之间的横向间距（图标背景不包含在内）。如果你需要制作图标的背景，那么背景的宽度应该是
`SuperWeaponSidebar.Interval` + 图标的宽度（60像素）。
- `SuperWeaponSidebar.LeftOffset` controls the distance between the left
side of cameo and the left side of its column (background). This will
not be greater than `SuperWeaponSidebar.Interval`.
- `SuperWeaponSidebar.LeftOffset` 控制图标距离背景左边缘的距离，这将不会超过
`SuperWeaponSidebar.Interval` 的值。
- `SuperWeaponSidebar.CameoHeight` controls the distance from the top of
the previous cameo to the top of the next cameo. That is, the space
between the upper and lower cameos is (`SuperWeaponSidebar.CameoHeight`
- cameo fixed height 48). This will not be less than 48. When you need
to make a background, this is the height of the background.
- `SuperWeaponSidebar.CameoHeight`
控制图标顶部到下一个图标顶部的距离（也就是每两个背景之间的纵向间距），图标的顶部到其背景的上边缘的距离即为
`SuperWeaponSidebar.CameoHeight` - 图标高度（48）像素。如果你需要制作图标的背景，那么背景的高度应该是
`SuperWeaponSidebar.CameoHeight` 的值。
- `SuperWeaponSidebar.Max` controls the maximum number of cameos on the
leftmost column, which also depends on the current game resolution.
  - `SuperWeaponSidebar.Max` 控制最左侧一列最多能有多少个图标，这也会受到当前游戏分辨率的影响。
- `SuperWeaponSidebar.MaxColumns` controls that maximum count of
columns.
  - `SuperWeaponSidebar.MaxColumns` 控制最多能显示多少列。
- Only sw with `SuperWeaponSidebar.Significance` not lower than
`SuperWeaponSidebar.RequiredSignificance` are allowed to be added to the
sw sidebar.
- 只有 `SuperWeaponSidebar.Significance` 值不低于
`SuperWeaponSidebar.RequiredSignificance` 的超级武器才允许被加入超级武器侧边栏。
- `SuperWeaponSidebarKeysEnabled` should be true that you can use
hotkeys about superweapon sidebar.
- `SuperWeaponSidebarKeysEnabled` 设为true时你才可以使用超级武器侧边栏的热键。
- You can also launch first 10 SW by hotkey in INTERFACE category.
- 你还可以设置10个快捷键来释放对应图标的超级武器。
- For localization of hotkey, add `TXT_FIRE_TACTICAL_SW_XX`,
`TXT_FIRE_TACTICAL_SW_XX_DESC`, `TXT_TOGGLE_SW_SIDEBAR` and
`TXT_TOGGLE_SW_SIDEBAR_DESC` into your `.csf` file.
- 如果需要本地化快捷键，只需要在你的 `csf` 文件中添加对应的 `TXT_FIRE_TACTICAL_SW_XX`,
`TXT_FIRE_TACTICAL_SW_XX_DESC`, `TXT_TOGGLE_SW_SIDEBAR` and
`TXT_TOGGLE_SW_SIDEBAR_DESC` 条目。

In `uimd.ini`:
```ini
[Sidebar]
SuperWeaponSidebar=false              ; boolean
SuperWeaponSidebar.Interval=0         ; integer, pixels
SuperWeaponSidebar.LeftOffset=0       ; integer, pixels
SuperWeaponSidebar.CameoHeight=48     ; integer, pixels
SuperWeaponSidebar.Max=0              ; integer
SuperWeaponSidebar.MaxColumns=        ; integer
```

In `rulesmd.ini`
```ini
[GlobalControls]
SuperWeaponSidebarKeysEnabled=false    ; boolean

[AudioVisual]
SuperWeaponSidebar.AllowByDefault=false   ; boolean

[SOMESIDE]
SuperWeaponSidebar.OnPCX=             ; filename - including the .pcx extension
SuperWeaponSidebar.OffPCX=            ; filename - including the .pcx extension
SuperWeaponSidebar.TopPCX=            ; filename - including the .pcx extension
SuperWeaponSidebar.CenterPCX=         ; filename - including the .pcx extension
SuperWeaponSidebar.BottomPCX=         ; filename - including the .pcx extension

[SOMESW]
SuperWeaponSidebar.Allow=             ; boolean
SuperWeaponSidebar.PriorityHouses=    ; list of house types
SuperWeaponSidebar.RequiredHouses=    ; list of house types
SuperWeaponSidebar.Significance=0     ; integer
```

In `ra2md.ini`
```ini
[Phobos]
SuperWeaponSidebar.RequiredSignificance=0   ; integer
```


![sw_sidebar-01-on](https://github.com/user-attachments/assets/0d5178d4-9562-4df3-84d1-00bb04ed3039)

![sw_sidebar-02-on](https://github.com/user-attachments/assets/153a0db0-618f-4682-ad85-e44d287e8af7)

---------

Co-authored-by: ZivDero <[email protected]>
Co-authored-by: 绯红热茶 <[email protected]>
Co-authored-by: Aephiex <[email protected]>
Co-authored-by: Kerbiter <[email protected]>

Author: 5 people

CREDITS.md

@@ -399,6 +399,7 @@ This page lists all the individual contributions to the project by their author.
   - Fix the bug that ships can travel on elevated bridges
   - Original `Arcing` elevation inaccuracy fix
   - Fix the bug that uncontrolled scatter when elite techno attacked by aircraft or some unit try crush it
+  - Exclusive SuperWeapon Sidebar
 - **Apollo** - Translucent SHP drawing patches
 - **ststl**:
   - Customizable `ShowTimer` priority of superweapons
@@ -473,6 +474,7 @@ This page lists all the individual contributions to the project by their author.
   - Aggressive attack move mission
   - Amphibious access vehicle
   - Fix an issue that spawned `Strafe` aircraft on aircraft carriers may not be able to return normally if aircraft carriers moved a short distance when the aircraft is landing
+  - Exclusive SuperWeapon Sidebar
 - **Ollerus**:
   - Build limit group enhancement
   - Customizable rocker amplitude

Phobos.vcxproj

@@ -23,6 +23,11 @@
     <ClCompile Include="src\Blowfish\Hooks.Blowfish.cpp" />
     <ClCompile Include="src\Ext\Cell\Body.cpp" />
     <ClCompile Include="src\Ext\House\Hooks.ForceEnemy.cpp" />
+    <ClCompile Include="src\Commands\ToggleSWSidebar.cpp" />
+    <ClCompile Include="src\Ext\Sidebar\SWSidebar\SWColumnClass.cpp" />
+    <ClCompile Include="src\Ext\Sidebar\SWSidebar\SWSidebarClass.cpp" />
+    <ClCompile Include="src\Ext\Sidebar\SWSidebar\SWButtonClass.cpp" />
+    <ClCompile Include="src\Ext\Sidebar\SWSidebar\ToggleSWButtonClass.cpp" />
     <ClCompile Include="src\Ext\TechnoType\Hooks.MatrixOp.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.Airstrike.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Harvester.cpp" />
@@ -200,6 +205,12 @@
     <ClInclude Include="src\New\Type\Affiliated\CreateUnitTypeClass.h" />
     <ClInclude Include="src\Blowfish\blowfish.h" />
     <ClInclude Include="src\Ext\Cell\Body.h" />
+    <ClInclude Include="src\Commands\FireTacticalSW.h" />
+    <ClInclude Include="src\Commands\ToggleSWSidebar.h" />
+    <ClInclude Include="src\Ext\Sidebar\SWSidebar\SWColumnClass.h" />
+    <ClInclude Include="src\Ext\Sidebar\SWSidebar\SWSidebarClass.h" />
+    <ClInclude Include="src\Ext\Sidebar\SWSidebar\SWButtonClass.h" />
+    <ClInclude Include="src\Ext\Sidebar\SWSidebar\ToggleSWButtonClass.h" />
     <ClInclude Include="src\New\Entity\AttachEffectClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\TiberiumEaterTypeClass.h" />
     <ClInclude Include="src\New\Type\AttachEffectTypeClass.h" />

docs/User-Interface.md

@@ -678,3 +678,58 @@ In `RA2MD.INI`:
 [Phobos]
 ToolTipBlur=false  ; boolean, whether the blur effect of tooltips will be enabled.
 ```
+
+### Exclusive SuperWeapon Sidebar
+
+![image](_static/images/sw_sidebar-01-on.png)
+![image](_static/images/sw_sidebar-02-on.png)
+
+- It is possible to put sw cameos on the left of screen like C&C3 when `SuperWeaponSidebar` is true. Cameos arranged in a pyramid shape. In theory, it should be compatible with Ares.
+  - `SuperWeaponSidebar.Interval` controls the distance between two column cameos (excluding the background). When you need to make a background, the width of the background should be (`SuperWeaponSidebar.Interval` + cameo fixed width 60).
+  - `SuperWeaponSidebar.LeftOffset` controls the distance between the left side of cameo and the left side of its column (background). This will not be greater than `SuperWeaponSidebar.Interval`.
+  - `SuperWeaponSidebar.CameoHeight` controls the distance from the top of the previous cameo to the top of the next cameo. That is, the space between the upper and lower cameos is (`SuperWeaponSidebar.CameoHeight` - cameo fixed height 48). This will not be less than 48. When you need to make a background, this is the height of the background.
+  - `SuperWeaponSidebar.Max` controls the maximum number of cameos on the leftmost column, which also depends on the current game resolution.
+  - `SuperWeaponSidebar.MaxColumns` controls that maximum count of columns.
+  - Only sw with `SuperWeaponSidebar.Significance` not lower than `SuperWeaponSidebar.RequiredSignificance` are allowed to be added to the sw sidebar.
+- `SuperWeaponSidebarKeysEnabled` should be true that you can use hotkeys about superweapon sidebar.
+- You can also launch first 10 SW by hotkey in INTERFACE category.
+  - For localization of hotkey, add `TXT_FIRE_TACTICAL_SW_XX`, `TXT_FIRE_TACTICAL_SW_XX_DESC`, `TXT_TOGGLE_SW_SIDEBAR` and `TXT_TOGGLE_SW_SIDEBAR_DESC` into your `.csf` file.
+
+In `uimd.ini`:
+```ini
+[Sidebar]
+SuperWeaponSidebar=false              ; boolean
+SuperWeaponSidebar.Interval=0         ; integer, pixels
+SuperWeaponSidebar.LeftOffset=0       ; integer, pixels
+SuperWeaponSidebar.CameoHeight=48     ; integer, pixels
+SuperWeaponSidebar.Max=0              ; integer
+SuperWeaponSidebar.MaxColumns=        ; integer
+```
+
+In `rulesmd.ini`
+```ini
+[GlobalControls]
+SuperWeaponSidebarKeysEnabled=false    ; boolean
+
+[AudioVisual]
+SuperWeaponSidebar.AllowByDefault=false   ; boolean
+
+[SOMESIDE]
+SuperWeaponSidebar.OnPCX=             ; filename - including the .pcx extension
+SuperWeaponSidebar.OffPCX=            ; filename - including the .pcx extension
+SuperWeaponSidebar.TopPCX=            ; filename - including the .pcx extension
+SuperWeaponSidebar.CenterPCX=         ; filename - including the .pcx extension
+SuperWeaponSidebar.BottomPCX=         ; filename - including the .pcx extension
+
+[SOMESW]
+SuperWeaponSidebar.Allow=             ; boolean
+SuperWeaponSidebar.PriorityHouses=    ; list of house types
+SuperWeaponSidebar.RequiredHouses=    ; list of house types
+SuperWeaponSidebar.Significance=0     ; integer
+```
+
+In `ra2md.ini`
+```ini
+[Phobos]
+SuperWeaponSidebar.RequiredSignificance=0   ; integer
+```

docs/Whats-New.md

@@ -381,6 +381,7 @@ New:
 - Dehardcoded 255 limit of `OverlayType` (by secsome)
 - [Customizable airstrike flare colors](Fixed-or-Improved-Logics.md#airstrike-flare-customizations) (by Starkku)
 - Allowed player's self-healing effects to be benefited by allied or `PlayerControl=true` houses (by Ollerus)
+- Exclusive SuperWeapon Sidebar (by NetsuNegi & CrimRecya)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

docs/_static/images/sw_sidebar-01-on.png

@@ -10,6 +10,9 @@
 #include "ToggleDigitalDisplay.h"
 #include "ToggleDesignatorRange.h"
 #include "SaveVariablesToFile.h"
+#include "ToggleSWSidebar.h"
+#include "FireTacticalSW.h"
+#include <Ext/Sidebar/SWSidebar/SWSidebarClass.h>
 
 DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 {
@@ -19,6 +22,21 @@ DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 	MakeCommand<QuickSaveCommandClass>();
 	MakeCommand<ToggleDigitalDisplayCommandClass>();
 	MakeCommand<ToggleDesignatorRangeCommandClass>();
+	MakeCommand<ToggleSWSidebar>();
+
+	if (Phobos::Config::SuperWeaponSidebarCommands)
+	{
+		SWSidebarClass::Commands[0] = MakeCommand<FireTacticalSWCommandClass<0>>();
+		SWSidebarClass::Commands[1] = MakeCommand<FireTacticalSWCommandClass<1>>();
+		SWSidebarClass::Commands[2] = MakeCommand<FireTacticalSWCommandClass<2>>();
+		SWSidebarClass::Commands[3] = MakeCommand<FireTacticalSWCommandClass<3>>();
+		SWSidebarClass::Commands[4] = MakeCommand<FireTacticalSWCommandClass<4>>();
+		SWSidebarClass::Commands[5] = MakeCommand<FireTacticalSWCommandClass<5>>();
+		SWSidebarClass::Commands[6] = MakeCommand<FireTacticalSWCommandClass<6>>();
+		SWSidebarClass::Commands[7] = MakeCommand<FireTacticalSWCommandClass<7>>();
+		SWSidebarClass::Commands[8] = MakeCommand<FireTacticalSWCommandClass<8>>();
+		SWSidebarClass::Commands[9] = MakeCommand<FireTacticalSWCommandClass<9>>();
+	}
 
 	if (Phobos::Config::DevelopmentCommands)
 	{

docs/_static/images/sw_sidebar-02-on.png

@@ -7,10 +7,11 @@
 #include <Utilities/Debug.h>
 
 template <typename T>
-void MakeCommand()
+T* MakeCommand()
 {
 	T* command = GameCreate<T>();
 	CommandClass::Array.AddItem(command);
+	return command;
 };
 
 #define CATEGORY_TEAM StringTable::LoadString(GameStrings::TXT_TEAM)

src/Commands/Commands.cpp

@@ -0,0 +1,61 @@
+#pragma once
+#include "Commands.h"
+
+#include <Ext/Sidebar/Body.h>
+#include <Ext/Sidebar/SWSidebar/SWSidebarClass.h>
+
+template<size_t Index>
+class FireTacticalSWCommandClass : public CommandClass
+{
+	virtual const char* GetName() const override;
+	virtual const wchar_t* GetUIName() const override;
+	virtual const wchar_t* GetUICategory() const override;
+	virtual const wchar_t* GetUIDescription() const override;
+	virtual void Execute(WWKey eInput) const override;
+};
+
+template<size_t Index>
+inline const char* FireTacticalSWCommandClass<Index>::GetName() const
+{
+	_snprintf_s(Phobos::readBuffer, Phobos::readLength, "FireTacticalSW%d", Index + 1);
+	return Phobos::readBuffer;
+}
+
+template<size_t Index>
+inline const wchar_t* FireTacticalSWCommandClass<Index>::GetUIName() const
+{
+	const wchar_t* csfString = StringTable::TryFetchString("TXT_FIRE_TACTICAL_SW_XX", L"Fire Super Weapon %d");
+	_snwprintf_s(Phobos::wideBuffer, std::size(Phobos::wideBuffer), csfString, Index + 1);
+	return Phobos::wideBuffer;
+}
+
+template<size_t Index>
+inline const wchar_t* FireTacticalSWCommandClass<Index>::GetUICategory() const
+{
+	return CATEGORY_INTERFACE;
+}
+
+template<size_t Index>
+inline const wchar_t* FireTacticalSWCommandClass<Index>::GetUIDescription() const
+{
+	const wchar_t* csfString = StringTable::TryFetchString("TXT_FIRE_TACTICAL_SW_XX_DESC", L"Fires the Super Weapon at position %d in the Super Weapon sidebar.");
+	_snwprintf_s(Phobos::wideBuffer, std::size(Phobos::wideBuffer), csfString, Index + 1);
+	return Phobos::wideBuffer;
+}
+
+template<size_t Index>
+inline void FireTacticalSWCommandClass<Index>::Execute(WWKey eInput) const
+{
+	if (!SWSidebarClass::IsEnabled())
+		return;
+
+	const auto& columns = SWSidebarClass::Instance.Columns;
+
+	if (columns.empty())
+		return;
+
+	const auto& buttons = columns.front()->Buttons;
+
+	if (Index < buttons.size())
+		buttons[Index]->LaunchSuper();
+}

src/Commands/Commands.h

@@ -0,0 +1,33 @@
+#include "ToggleSWSidebar.h"
+#include <HouseClass.h>
+
+#include <Utilities/GeneralUtils.h>
+#include <Ext/Sidebar/SWSidebar/SWSidebarClass.h>
+
+const char* ToggleSWSidebar::GetName() const
+{
+	return "Toggle Super Weapon Sidebar";
+}
+
+const wchar_t* ToggleSWSidebar::GetUIName() const
+{
+	return GeneralUtils::LoadStringUnlessMissing("TXT_TOGGLE_SW_SIDEBAR", L"Toggle Super Weapon Sidebar");
+}
+
+const wchar_t* ToggleSWSidebar::GetUICategory() const
+{
+	return CATEGORY_INTERFACE;
+}
+
+const wchar_t* ToggleSWSidebar::GetUIDescription() const
+{
+	return GeneralUtils::LoadStringUnlessMissing("TXT_TOGGLE_SW_SIDEBAR_DESC", L"Toggle the Super Weapon Sidebar.");
+}
+
+void ToggleSWSidebar::Execute(WWKey eInput) const
+{
+	ToggleSWButtonClass::SwitchSidebar();
+
+	if (SWSidebarClass::Instance.CurrentColumn)
+		MouseClass::Instance.UpdateCursor(MouseCursorType::Default, false);
+}