Initial commit: OpenRA game engine

Fork from OpenRA/OpenRA with one-click launch script (start-ra.cmd)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

OpenRA.Mods.Common/Traits/BotModules/McvManagerBotModule.cs

@@ -0,0 +1,238 @@
+#region Copyright & License Information
+/*
+ * Copyright (c) The OpenRA Developers and Contributors
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System.Collections.Frozen;
+using System.Collections.Generic;
+using System.Linq;
+using OpenRA.Traits;
+
+namespace OpenRA.Mods.Common.Traits
+{
+	[TraitLocation(SystemActors.Player)]
+	[Desc("Manages AI MCVs.")]
+	public class McvManagerBotModuleInfo : ConditionalTraitInfo
+	{
+		[Desc("Actor types that are considered MCVs (deploy into base builders).")]
+		public readonly FrozenSet<string> McvTypes = FrozenSet<string>.Empty;
+
+		[Desc("Actor types that are considered construction yards (base builders).")]
+		public readonly FrozenSet<string> ConstructionYardTypes = FrozenSet<string>.Empty;
+
+		[Desc("Actor types that are able to produce MCVs.")]
+		public readonly FrozenSet<string> McvFactoryTypes = FrozenSet<string>.Empty;
+
+		[Desc("Try to maintain at least this many ConstructionYardTypes, build an MCV if number is below this.")]
+		public readonly int MinimumConstructionYardCount = 1;
+
+		[Desc("Delay (in ticks) between looking for and giving out orders to new MCVs.")]
+		public readonly int ScanForNewMcvInterval = 20;
+
+		[Desc("Minimum distance in cells from center of the base when checking for MCV deployment location.")]
+		public readonly int MinBaseRadius = 2;
+
+		[Desc("Maximum distance in cells from center of the base when checking for MCV deployment location.",
+			"Only applies if RestrictMCVDeploymentFallbackToBase is enabled and there's at least one construction yard.")]
+		public readonly int MaxBaseRadius = 20;
+
+		[Desc("Should deployment of additional MCVs be restricted to MaxBaseRadius if explicit deploy locations are missing or occupied?")]
+		public readonly bool RestrictMCVDeploymentFallbackToBase = true;
+
+		public override object Create(ActorInitializer init) { return new McvManagerBotModule(init.Self, this); }
+	}
+
+	public class McvManagerBotModule : ConditionalTrait<McvManagerBotModuleInfo>,
+		IBotTick, IBotPositionsUpdated, IGameSaveTraitData, INotifyActorDisposing
+	{
+		public CPos GetRandomBaseCenter()
+		{
+			var randomConstructionYard = constructionYards.Actors
+				.RandomOrDefault(world.LocalRandom);
+
+			return randomConstructionYard?.Location ?? initialBaseCenter;
+		}
+
+		readonly World world;
+		readonly Player player;
+		readonly ActorIndex.OwnerAndNamesAndTrait<TransformsInfo> mcvs;
+		readonly ActorIndex.OwnerAndNamesAndTrait<BuildingInfo> constructionYards;
+		readonly ActorIndex.OwnerAndNamesAndTrait<BuildingInfo> mcvFactories;
+
+		IBotPositionsUpdated[] notifyPositionsUpdated;
+		IBotRequestUnitProduction[] requestUnitProduction;
+
+		CPos initialBaseCenter;
+		int scanInterval;
+		bool firstTick = true;
+
+		public McvManagerBotModule(Actor self, McvManagerBotModuleInfo info)
+			: base(info)
+		{
+			world = self.World;
+			player = self.Owner;
+			mcvs = new ActorIndex.OwnerAndNamesAndTrait<TransformsInfo>(world, info.McvTypes, player);
+			constructionYards = new ActorIndex.OwnerAndNamesAndTrait<BuildingInfo>(world, info.ConstructionYardTypes, player);
+			mcvFactories = new ActorIndex.OwnerAndNamesAndTrait<BuildingInfo>(world, info.McvFactoryTypes, player);
+		}
+
+		protected override void Created(Actor self)
+		{
+			notifyPositionsUpdated = self.Owner.PlayerActor.TraitsImplementing<IBotPositionsUpdated>().ToArray();
+			requestUnitProduction = self.Owner.PlayerActor.TraitsImplementing<IBotRequestUnitProduction>().ToArray();
+		}
+
+		protected override void TraitEnabled(Actor self)
+		{
+			// Avoid all AIs reevaluating assignments on the same tick, randomize their initial evaluation delay.
+			scanInterval = world.LocalRandom.Next(Info.ScanForNewMcvInterval, Info.ScanForNewMcvInterval * 2);
+		}
+
+		void IBotPositionsUpdated.UpdatedBaseCenter(CPos newLocation)
+		{
+			initialBaseCenter = newLocation;
+		}
+
+		void IBotPositionsUpdated.UpdatedDefenseCenter(CPos newLocation) { }
+
+		void IBotTick.BotTick(IBot bot)
+		{
+			if (firstTick)
+			{
+				DeployMcvs(bot, false);
+				firstTick = false;
+			}
+
+			if (--scanInterval <= 0)
+			{
+				scanInterval = Info.ScanForNewMcvInterval;
+				DeployMcvs(bot, true);
+
+				// No construction yards - Build a new MCV
+				var unitBuilder = requestUnitProduction.FirstEnabledTraitOrDefault();
+				if (unitBuilder != null && Info.McvTypes.Count > 0 && ShouldBuildMCV())
+				{
+					var mcvType = Info.McvTypes.Random(world.LocalRandom);
+					if (unitBuilder.RequestedProductionCount(bot, mcvType) == 0)
+						unitBuilder.RequestUnitProduction(bot, mcvType);
+				}
+			}
+		}
+
+		bool ShouldBuildMCV()
+		{
+			// Only build MCV if we don't already have one in the field.
+			var allowedToBuildMCV = AIUtils.CountActorByCommonName(mcvs) == 0;
+			if (!allowedToBuildMCV)
+				return false;
+
+			// Build MCV if we don't have the desired number of construction yards, unless we have no factory (can't build it).
+			return AIUtils.CountActorByCommonName(constructionYards) < Info.MinimumConstructionYardCount &&
+				AIUtils.CountActorByCommonName(mcvFactories) > 0;
+		}
+
+		void DeployMcvs(IBot bot, bool chooseLocation)
+		{
+			var newMCVs = mcvs.Actors
+				.Where(a => a.IsIdle);
+
+			foreach (var mcv in newMCVs)
+				DeployMcv(bot, mcv, chooseLocation);
+		}
+
+		// Find any MCV and deploy them at a sensible location.
+		void DeployMcv(IBot bot, Actor mcv, bool move)
+		{
+			if (move)
+			{
+				// If we lack a base, we need to make sure we don't restrict deployment of the MCV to the base!
+				var restrictToBase =
+					Info.RestrictMCVDeploymentFallbackToBase &&
+					AIUtils.CountActorByCommonName(constructionYards) > 0;
+
+				var transformsInfo = mcv.Info.TraitInfo<TransformsInfo>();
+				var desiredLocation = ChooseMcvDeployLocation(transformsInfo.IntoActor, transformsInfo.Offset, restrictToBase);
+				if (desiredLocation == null)
+					return;
+
+				bot.QueueOrder(new Order("Move", mcv, Target.FromCell(world, desiredLocation.Value), true));
+			}
+
+			// If the MCV has to move first, we can't be sure it reaches the destination alive, so we only
+			// update base and defense center if the MCV is deployed immediately (i.e. at game start).
+			// TODO: This could be addressed via INotifyTransform.
+			foreach (var n in notifyPositionsUpdated)
+			{
+				n.UpdatedBaseCenter(mcv.Location);
+				n.UpdatedDefenseCenter(mcv.Location);
+			}
+
+			bot.QueueOrder(new Order("DeployTransform", mcv, true));
+		}
+
+		CPos? ChooseMcvDeployLocation(string actorType, CVec offset, bool distanceToBaseIsImportant)
+		{
+			var actorInfo = world.Map.Rules.Actors[actorType];
+			var bi = actorInfo.TraitInfoOrDefault<BuildingInfo>();
+			if (bi == null)
+				return null;
+
+			// Find the buildable cell that is closest to pos and centered around center
+			CPos? FindPos(CPos center, CPos target, int minRange, int maxRange)
+			{
+				var cells = world.Map.FindTilesInAnnulus(center, minRange, maxRange);
+
+				// Sort by distance to target if we have one
+				if (center != target)
+					cells = cells.OrderBy(c => (c - target).LengthSquared);
+				else
+					cells = cells.Shuffle(world.LocalRandom);
+
+				foreach (var cell in cells)
+					if (world.CanPlaceBuilding(cell + offset, actorInfo, bi, null))
+						return cell;
+
+				return null;
+			}
+
+			var baseCenter = GetRandomBaseCenter();
+
+			return FindPos(baseCenter, baseCenter, Info.MinBaseRadius,
+				distanceToBaseIsImportant ? Info.MaxBaseRadius : world.Map.Grid.MaximumTileSearchRange);
+		}
+
+		List<MiniYamlNode> IGameSaveTraitData.IssueTraitData(Actor self)
+		{
+			if (IsTraitDisabled)
+				return null;
+
+			return
+			[
+				new("InitialBaseCenter", FieldSaver.FormatValue(initialBaseCenter))
+			];
+		}
+
+		void IGameSaveTraitData.ResolveTraitData(Actor self, MiniYaml data)
+		{
+			if (self.World.IsReplay)
+				return;
+
+			var initialBaseCenterNode = data.NodeWithKeyOrDefault("InitialBaseCenter");
+			if (initialBaseCenterNode != null)
+				initialBaseCenter = FieldLoader.GetValue<CPos>("InitialBaseCenter", initialBaseCenterNode.Value.Value);
+		}
+
+		void INotifyActorDisposing.Disposing(Actor self)
+		{
+			mcvs.Dispose();
+			constructionYards.Dispose();
+			mcvFactories.Dispose();
+		}
+	}
+}