Irateredkite/solar ipc interface fixes (#425)

* fix: Change how solar formations are fetched and ensured that CreateUserDefinedSolarFormation() returns a uint so objects spawned by this function can be properly tracked by other plugins using the IPC interface

* chore: Update changelog.md

* chore: Remove TODO comments

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 4.0.32
+- Properly expose data for CreateUserDefinedSolarFormation() so objects spawned this way can be tracked by other plugins.
+
 ## 4.0.31
 - Fixed a case in Advanced Startup Solars where randomly placed solars could occupy the same position
 

plugins/solar_control/SolarControl.cpp

@@ -359,18 +359,36 @@ namespace Plugins::SolarControl
 	/** @ingroup SolarControl
 	 * @brief Creates a premade group of solars defined in the solar json file
 	 */
-	void CreateUserDefinedSolarFormation(const std::wstring& formation, const Vector& position, uint system)
+	std::vector<uint> CreateUserDefinedSolarFormation(const std::wstring& formation, const Vector& position, uint system)
 	{
-		for (auto component : global->config->solarArchFormations[formation].components)
+		std::vector<uint> formationSpaceIds;
+
+		auto group = global->config->solarArchFormations.find(formation);
+
+		if (group == global->config->solarArchFormations.end())
+		{
+			Console::ConErr(std::format("Unable to find {} while attempting to spawn user defined formation", wstos(formation)));
+			return {};
+		}
+
+		for (auto& component : group->second.components)
 		{
-			CreateUserDefinedSolar(stows(component.solarArchName),
+			if (component.relativePosition.size() != 3 || component.rotation.size() != 3)
+			{
+				Console::ConErr(std::format("Invalid rotation or coordinate values provided for '{}', failed to create", component.solarArchName));
+				return {};
+			}
+
+			auto solar = CreateUserDefinedSolar(stows(component.solarArchName),
 			    Vector {
 			        {position.x + component.relativePosition[0]}, {position.y + component.relativePosition[1]}, {position.z + component.relativePosition[2]}},
 			    EulerMatrix(Vector {component.rotation[0], component.rotation[1], component.rotation[2]}),
 			    system,
 			    false,
 			    false);
+			formationSpaceIds.emplace_back(solar);
 		}
+		return formationSpaceIds;
 	}
 
 	/** @ingroup SolarControl

plugins/solar_control/SolarControl.h

@@ -64,7 +64,7 @@ namespace Plugins::SolarControl
 		explicit SolarCommunicator(const std::string& plug);
 
 		uint PluginCall(CreateSolar, const std::wstring& name, Vector position, const Matrix& rotation, SystemId system, bool varyPosition, bool mission);
-		void PluginCall(CreateSolarFormation, const std::wstring& formation, const Vector& position, uint system);
+		std::vector<uint> PluginCall(CreateSolarFormation, const std::wstring& formation, const Vector& position, uint system);
 	};
 
 	//! Global data for this plugin