[Highly Customized] Distribution click action mode

CREDITS.md

@@ -555,6 +555,7 @@ This page lists all the individual contributions to the project by their author.
   - Fix an issue that units' `LaserTrails` will always lags behind by one frame
   - Fix an issue that the currently hovered planning node not update up-to-date, such as using hotkeys to select technos
   - Allow the aircraft to enter area guard mission and not crash immediately without any airport
+  - Distribution click action mode
 - **Ollerus**:
   - Build limit group enhancement
   - Customizable rocker amplitude

Phobos.vcxproj

@@ -58,6 +58,7 @@
     <ClCompile Include="src\Commands\ToggleDesignatorRange.cpp" />
     <ClCompile Include="src\Commands\ToggleDigitalDisplay.cpp" />
     <ClCompile Include="src\Commands\SaveVariablesToFile.cpp" />
+    <ClCompile Include="src\Commands\DistributionMode.cpp" />
     <ClCompile Include="src\Ext\Anim\Body.cpp" />
     <ClCompile Include="src\Ext\Anim\Hooks.cpp" />
     <ClCompile Include="src\Ext\Anim\Hooks.AnimCreateUnit.cpp" />
@@ -242,6 +243,7 @@
     <ClInclude Include="src\Commands\ToggleDesignatorRange.h" />
     <ClInclude Include="src\Commands\ToggleDigitalDisplay.h" />
     <ClInclude Include="src\Commands\SaveVariablesToFile.h" />
+    <ClInclude Include="src\Commands\DistributionMode.h" />
     <ClInclude Include="src\Ext\Bullet\Trajectories\BombardTrajectory.h" />
     <ClInclude Include="src\Ext\Bullet\Trajectories\PhobosTrajectory.h" />
     <ClInclude Include="src\Ext\Bullet\Trajectories\StraightTrajectory.h" />

docs/User-Interface.md

@@ -502,6 +502,57 @@ For this command to work in multiplayer - you need to use a version of [YRpp spa
   - These vanilla CSF entries will be used: `TXT_SAVING_GAME`, `TXT_GAME_WAS_SAVED` and `TXT_ERROR_SAVING_GAME`.
   - The save should be looks like `Allied Mission 25: Esther's Money - QuickSaved`.
 
+### `[ ]` Distribution Mode Spread / Filter / Enable
+
+- Now you can change the click action by using `AllowSwitchNoMoveCommand` hotkey. If the behavior to be executed by the current techno is different from the behavior displayed by the mouse, and the behavior to be executed will make the techno move near the target, the behavior will be replaced with area guard. Regardless of whether or not switch hotkey is used, default behavior can be changed through `DefaultApplyNoMoveCommand`.
+- Now you can also change the click action when hold down the specific hotkey if enabled `AllowDistributionCommand`. The new behavior is like using the selected objects one by one to click on each target within the range.
+- `AllowDistributionCommand.SpreadMode` & `AllowDistributionCommand.FilterMode` allow you to set spread range and target filter by hotkeys, which default to `DefaultDistributionSpreadMode` and `DefaultDistributionFilterMode`.
+  - When the range is 0, it is the original default behavior of the game. The range can be adjusted to 4, 8 or 16 cells by another shortcut key. You can also adjust this by using the mouse wheel while holding down the specific hotkey if `AllowDistributionCommand.SpreadModeScroll` set to true;
+    - The targets within the range will be allocated equally to the selected technos. Only when the behavior to be performed by the current techno is the same as that displayed by the mouse will it be allocated. Otherwise, it will return to the original default behavior of the game (it will not be effective for technos in the air). This will display a range ring.
+  - When the filter is `None`, it is the default behavior of the game. If the range is not zero at this time, a green ring will be displayed. You can adjust the filter mode to:
+    - `Like` - only targets with the same armor type (Completely identical `Armor`) will be selected among the targets allocated in the range. At this time, a blue ring will be displayed.
+    - `Type` - only targets of the same type (like infantries, vehicles or buildings) will be selected among the targets allocated in the range. At this time, a yellow ring will be displayed.
+    - `Name` - only targets of the same name (or with the same `GroupAs`) will be selected among the targets allocated in the range. At this time, a red ring will be displayed.
+- `AllowDistributionCommand.AffectsAllies` & `AllowDistributionCommand.AffectsEnemies` allow the distribution command to work on allies (including owner) or enemies target. If picking a target that's not eligible, it'll fallback to vanilla command.
+- It's possible to add a button for distribution mode in the bottom bar by adding `DistributionMode` in the `ButtonList` of `AdvancedCommandBar` and `MultiplayerAdvancedCommandBar`.
+  - The positions of each button are hardcoded, so it'll only decide whether enable this button or not. Distribute Mode button is now always listed after all the vanilla ones.
+  - The asset of these buttons should be added in `sidec0x.mix` files which correspond to different sides, with the name `button12.shp`.
+- For localization add `TXT_SWITCH_NOMOVE`, `TXT_DISTR_SPREAD`, `TXT_DISTR_FILTER`, `TXT_DISTR_HOLDDOWN`, `TXT_SWITCH_NOMOVE_DESC`, `TXT_DISTR_SPREAD_DESC`, `TXT_DISTR_FILTER_DESC`, `TXT_DISTR_HOLDDOWN_DESC`, `MSG:DistributionModeOn`, `MSG:DistributionModeOff`, `TIP:DistributionMode` into your `.csf` file.
+
+In `rulesmd.ini`:
+```ini
+[GlobalControls]
+AllowSwitchNoMoveCommand=false                      ; boolean
+AllowDistributionCommand=false                      ; boolean
+AllowDistributionCommand.SpreadMode=true            ; boolean
+AllowDistributionCommand.SpreadModeScroll=true      ; boolean
+AllowDistributionCommand.FilterMode=true            ; boolean
+AllowDistributionCommand.AffectsAllies=true         ; boolean
+AllowDistributionCommand.AffectsEnemies=true        ; boolean
+
+[AudioVisual]
+StartDistributionModeSound=                         ; sound entry
+EndDistributionModeSound=                           ; sound entry
+AddDistributionModeCommandSound=                    ; sound entry
+```
+
+In `ra2md.ini`:
+```ini
+[Phobos]
+DefaultApplyNoMoveCommand=true                      ; boolean
+DefaultDistributionSpreadMode=2                     ; integer, 0 - r=0 , 1 - r=4 , 2 - r=8 , 3 - r=16
+DefaultDistributionFilterMode=2                     ; integer, 0 - None , 1 - Like , 2 - Type , 3 - Name
+```
+
+In `uimd.ini`:
+```ini
+[AdvancedCommandBar]
+ButtonList=[Button1],DistributionMode,[ButtonX]     ; List of button entry
+
+[MultiplayerAdvancedCommandBar]
+ButtonList=[Button1],DistributionMode,[ButtonX]     ; List of button entry
+```
+
 ### `[ ]` Toggle Message Label
 
 - Switches on/off [Task subtitles' label in the middle of the screen](#task-subtitles-display-in-the-middle-of-the-screen).

docs/Whats-New.md

@@ -457,6 +457,7 @@ New:
 - Fast access structure (by FlyStar)
 - Toggle off laser trail and shake effects (by Ollerus)
 - [Dehardcode the `ZAdjust` of warhead anim](Fixed-or-Improved-Logics.md#dehardcode-the-zadjust-of-warhead-anim) (by TaranDahl)
+- Distribution click action mode (by CrimRecya)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

src/Commands/Commands.cpp

@@ -9,16 +9,20 @@
 #include "ToggleDigitalDisplay.h"
 #include "ToggleDesignatorRange.h"
 #include "SaveVariablesToFile.h"
+#include "DistributionMode.h"
 #include "ToggleSWSidebar.h"
 #include "FireTacticalSW.h"
 #include "ToggleMessageList.h"
 
 #include <CCINIClass.h>
+#include <ShapeButtonClass.h>
 
 #include <Utilities/Macro.h>
 #include <Ext/Sidebar/SWSidebar/SWSidebarClass.h>
 #include <Misc/MessageColumn.h>
 
+#pragma region HotkeyCommand
+
 DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 {
 	// Load it after Ares'
@@ -44,6 +48,20 @@ DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 		SWSidebarClass::Commands[9] = MakeCommand<FireTacticalSWCommandClass<9>>();
 	}
 
+	if (Phobos::Config::AllowSwitchNoMoveCommand)
+		MakeCommand<SwitchNoMoveCommandClass>();
+
+	if (Phobos::Config::AllowDistributionCommand)
+	{
+		if (Phobos::Config::AllowDistributionCommand_SpreadMode)
+			MakeCommand<DistributionModeSpreadCommandClass>();
+
+		if (Phobos::Config::AllowDistributionCommand_FilterMode)
+			MakeCommand<DistributionModeFilterCommandClass>();
+
+		MakeCommand<DistributionModeHoldDownCommandClass>();
+	}
+
 	if (Phobos::Config::DevelopmentCommands)
 	{
 		MakeCommand<DamageDisplayCommandClass>();
@@ -61,14 +79,24 @@ DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 	return 0;
 }
 
+#pragma endregion
+
+#pragma region MouseScroll
+
 static void MouseWheelDownCommand()
 {
+	if (DistributionModeHoldDownCommandClass::Enabled && Phobos::Config::AllowDistributionCommand_SpreadModeScroll)
+		DistributionModeHoldDownCommandClass::DistributionSpreadModeReduce();
+
 	if (MessageColumnClass::Instance.IsHovering())
 		MessageColumnClass::Instance.ScrollDown();
 }
 
 static void MouseWheelUpCommand()
 {
+	if (DistributionModeHoldDownCommandClass::Enabled && Phobos::Config::AllowDistributionCommand_SpreadModeScroll)
+		DistributionModeHoldDownCommandClass::DistributionSpreadModeExpand();
+
 	if (MessageColumnClass::Instance.IsHovering())
 		MessageColumnClass::Instance.ScrollUp();
 }
@@ -87,11 +115,92 @@ DEFINE_HOOK(0x777998, Game_WndProc_ScrollMouseWheel, 0x6)
 
 static inline bool CheckSkipScrollSidebar()
 {
-	return MessageColumnClass::Instance.IsHovering();
+	return DistributionModeHoldDownCommandClass::Enabled
+		|| MessageColumnClass::Instance.IsHovering();
 }
 
 DEFINE_HOOK(0x533F50, Game_ScrollSidebar_Skip, 0x5)
 {
 	enum { SkipScrollSidebar = 0x533FC3 };
 	return CheckSkipScrollSidebar() ? SkipScrollSidebar : 0;
 }
+
+#pragma endregion
+
+#pragma region ShapeButton
+
+int ShapeButtonHelper::NewButtonIndexes[ShapeButtonHelper::NewButtonCount] =
+{
+	-1 // DistributionMode
+	// New button initialize here
+};
+
+DEFINE_HOOK(0x6CFD08, ShapeButtonClass_FindIndex_FindNewButton, 0x5)
+{
+	enum { SetButtonIndex = 0x6CFD0D };
+
+	GET(const char*, name, ECX);
+
+	for (int i = 0; i < ShapeButtonHelper::NewButtonCount; ++i)
+	{
+		if (_strcmpi(name, ShapeButtonHelper::NewButtonNames[i]) == 0)
+		{
+			R->EAX(i + ShapeButtonHelper::OldButtonCount);
+			return SetButtonIndex;
+		}
+	}
+
+	return 0;
+}
+
+DEFINE_HOOK(0x6D0233, TabClass_Init_InitNewButtonIndex, 0x6)
+{
+	for (int i = 0; i < ShapeButtonHelper::NewButtonCount; ++i)
+		ShapeButtonHelper::NewButtonIndexes[i] = ShapeButtonClass::FindIndex(ShapeButtonHelper::NewButtonNames[i]);
+
+	return 0;
+}
+
+DEFINE_HOOK(0x6D0827, TabClass_Update_UpdateNewButton, 0x6)
+{
+	GET(const int, index, EAX);
+
+	if (ShapeButtonHelper::NewButtonIndexes[0] == index)
+	{
+		if (ShapeButtonClass::GetButton(index)->IsOn)
+			DistributionModeHoldDownCommandClass::DistributionModeOn();
+		else
+			DistributionModeHoldDownCommandClass::DistributionModeOff();
+	}
+
+	// New button trigger here
+
+	return 0;
+}
+
+DEFINE_HOOK(0x6D10DF, TabClass_InitButtonIO_InitNewHoldDownButton, 0x6)
+{
+	const int distributionModeButtonIndex = ShapeButtonHelper::NewButtonIndexes[0];
+
+	if (distributionModeButtonIndex != -1)
+	{
+		if (const auto pButton = ShapeButtonClass::GetButton(distributionModeButtonIndex))
+		{
+			// Clicking the button is different from holding down the hotkey
+			pButton->ToggleType = 1;
+			pButton->UseFlash = true;
+		}
+	}
+
+	return 0;
+}
+
+DEFINE_HOOK(0x6D14DD, TabClass_InitToolTip_InitNewButtonToolTip, 0x5)
+{
+	for (int i = 0; i < ShapeButtonHelper::NewButtonCount; ++i)
+		ShapeButtonClass::SetToolTip(ShapeButtonClass::GetButton(ShapeButtonHelper::NewButtonIndexes[i]), ShapeButtonHelper::NewButtonTipNames[i]);
+
+	return 0;
+}
+
+#pragma endregion

src/Commands/Commands.h

@@ -14,6 +14,39 @@ T* MakeCommand()
 	return command;
 };
 
+class ShapeButtonHelper
+{
+public:
+	static constexpr int MaxButtonCount = 25;
+	static constexpr int InUseButtonCount = 11;
+	static constexpr int UnusedButtonCount = 1;
+	static constexpr int OldButtonCount = InUseButtonCount + UnusedButtonCount;
+	static constexpr int NewButtonCount = std::min(1, (MaxButtonCount - OldButtonCount));
+	//  1. Team01
+	//  2. Team02
+	//  3. Team03
+	//  4. TypeSelect
+	//  5. Deploy
+	//  6. AttackMove
+	//  7. Guard
+	//  8. Beacon
+	//  9. Stop
+	// 10. PlanningMode
+	// 11. Cheer
+	// 12. MoveToDeploy
+	static constexpr const char* NewButtonNames[NewButtonCount] =
+	{
+	/* 13. */ "DistributionMode"
+	/* New button name here */
+	};
+	static constexpr const char* NewButtonTipNames[NewButtonCount] =
+	{
+		"Tip:DistributionMode"
+		// New button tip here
+	};
+	static int NewButtonIndexes[NewButtonCount];
+};
+
 #define CATEGORY_TEAM StringTable::LoadString(GameStrings::TXT_TEAM)
 #define CATEGORY_INTERFACE StringTable::LoadString(GameStrings::TXT_INTERFACE)
 #define CATEGORY_TAUNT StringTable::LoadString(GameStrings::TXT_TAUNT)