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/Render/Hovers.cs

@@ -0,0 +1,121 @@
+#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;
+using System.Collections.Generic;
+using System.Linq;
+using OpenRA.Graphics;
+using OpenRA.Primitives;
+using OpenRA.Traits;
+
+namespace OpenRA.Mods.Common.Traits.Render
+{
+	[Desc("Changes the visual Z position periodically.")]
+	public class HoversInfo : ConditionalTraitInfo
+	{
+		[Desc("Maximum visual Z axis distance relative to actual position + InitialHeight.")]
+		public readonly WDist BobDistance = new(-43);
+
+		[Desc("Actual altitude of actor needs to be this or higher to enable hover effect.")]
+		public readonly WDist MinHoveringAltitude = WDist.Zero;
+
+		[Desc("Amount of ticks it takes to reach BobDistance.")]
+		public readonly int Ticks = 6;
+
+		[Desc("Amount of ticks it takes to fall to the ground from the highest point when disabled.")]
+		public readonly int FallTicks = 10;
+
+		[Desc("Amount of ticks it takes to rise from the ground to InitialHeight.")]
+		public readonly int RiseTicks = 20;
+
+		[Desc("Initial Z axis modifier relative to actual position.")]
+		public readonly WDist InitialHeight = new(43);
+
+		public override object Create(ActorInitializer init) { return new Hovers(this); }
+
+		public override void RulesetLoaded(Ruleset rules, ActorInfo ai)
+		{
+			if (BobDistance.Length > -1)
+				throw new YamlException("Hovers.BobDistance must be a negative value.");
+
+			if (Ticks < 1)
+				throw new YamlException("Hovers.Ticks must be higher than zero.");
+
+			if (FallTicks < 1)
+				throw new YamlException("Hovers.FallTicks must be higher than zero.");
+
+			if (RiseTicks < 1)
+				throw new YamlException("Hovers.RiseTicks must be higher than zero.");
+
+			if (InitialHeight.Length < RiseTicks)
+				throw new YamlException("Hovers.InitialHeight must be at least as high as RiseTicks.");
+
+			base.RulesetLoaded(rules, ai);
+		}
+	}
+
+	public class Hovers : ConditionalTrait<HoversInfo>, IRenderModifier, ITick, ISync
+	{
+		readonly HoversInfo info;
+		readonly int stepPercentage;
+		readonly int fallTickHeight;
+
+		int ticks;
+
+		[VerifySync]
+		public WVec WorldVisualOffset { get; private set; }
+
+		public Hovers(HoversInfo info)
+			: base(info)
+		{
+			this.info = info;
+			stepPercentage = 256 / info.Ticks;
+
+			// fallTickHeight must be at least 1 to avoid a DivideByZeroException and other potential problems when trait is disabled.
+			fallTickHeight = (info.InitialHeight.Length + info.BobDistance.Length).Clamp(info.FallTicks, int.MaxValue) / info.FallTicks;
+		}
+
+		void ITick.Tick(Actor self)
+		{
+			if (IsTraitDisabled)
+			{
+				if (WorldVisualOffset.Z < 0)
+					return;
+
+				var fallTicks = WorldVisualOffset.Z / fallTickHeight - 1;
+				WorldVisualOffset = new WVec(0, 0, fallTickHeight * fallTicks);
+			}
+			else
+			{
+				var visualOffset = self.World.Map.DistanceAboveTerrain(self.CenterPosition) >= info.MinHoveringAltitude
+					? new WAngle(ticks % (info.Ticks * 4) * stepPercentage).Sin() : 0;
+				var currentHeight = info.BobDistance.Length * visualOffset / 1024 + info.InitialHeight.Length;
+
+				// This part rises the actor up from disabled state
+				if (WorldVisualOffset.Z < currentHeight)
+					currentHeight = Math.Min(WorldVisualOffset.Z + info.InitialHeight.Length / info.RiseTicks, currentHeight);
+
+				WorldVisualOffset = new WVec(0, 0, currentHeight);
+				ticks++;
+			}
+		}
+
+		IEnumerable<IRenderable> IRenderModifier.ModifyRender(Actor self, WorldRenderer wr, IEnumerable<IRenderable> r)
+		{
+			return r.Select(a => a.OffsetBy(WorldVisualOffset));
+		}
+
+		IEnumerable<Rectangle> IRenderModifier.ModifyScreenBounds(Actor self, WorldRenderer wr, IEnumerable<Rectangle> bounds)
+		{
+			return bounds;
+		}
+	}
+}