Files
OpenRA/OpenRA.Mods.Common/Traits/SupportPowers/ParatroopersPower.cs
2024-10-04 15:11:27 +03:00

278 lines
8.8 KiB
C#

#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.Mods.Common.Activities;
using OpenRA.Mods.Common.Effects;
using OpenRA.Primitives;
using OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits
{
[Desc("Support power that spawns and delivers units to the desired location via aircraft.")]
public class ParatroopersPowerInfo : DirectionalSupportPowerInfo
{
[ActorReference(typeof(AircraftInfo))]
[Desc("Aircraft used to deliver the drop.")]
public readonly string UnitType = "badr";
[Desc("Number of aircraft to use in the formation.")]
public readonly int SquadSize = 1;
[Desc("Distance between the aircraft in a formation.")]
public readonly WVec SquadOffset = new(-1536, 1536, 0);
[NotificationReference("Speech")]
[Desc("Speech notification to play when entering the drop zone.")]
public readonly string ReinforcementsArrivedSpeechNotification = null;
[FluentReference(optional: true)]
[Desc("Text notification to display when entering the drop zone.")]
public readonly string ReinforcementsArrivedTextNotification = null;
[Desc("Number of facings that the delivery aircraft may approach from.")]
public readonly int QuantizedFacings = 32;
[Desc("Spawn and remove the plane this far outside the map.")]
public readonly WDist Cordon = new(5120);
[ActorReference(typeof(PassengerInfo))]
[Desc("Troops to be delivered. They will be distributed between the planes if SquadSize > 1.")]
public readonly string[] DropItems = Array.Empty<string>();
[Desc("Risks stuck units when they don't have the Paratrooper trait.")]
public readonly bool AllowImpassableCells = false;
[ActorReference]
[Desc("Actor to spawn when the paradrop starts.")]
public readonly string CameraActor = null;
[Desc("Amount of time (in ticks) to keep the camera alive while the passengers drop.")]
public readonly int CameraRemoveDelay = 85;
[Desc("Weapon range offset to apply during the beacon clock calculation.")]
public readonly WDist BeaconDistanceOffset = WDist.FromCells(4);
public override object Create(ActorInitializer init) { return new ParatroopersPower(init.Self, this); }
}
public class ParatroopersPower : DirectionalSupportPower
{
readonly ParatroopersPowerInfo info;
public ParatroopersPower(Actor self, ParatroopersPowerInfo info)
: base(self, info)
{
this.info = info;
}
public override void Activate(Actor self, Order order, SupportPowerManager manager)
{
base.Activate(self, order, manager);
var facing = info.UseDirectionalTarget && order.ExtraData != uint.MaxValue ? (WAngle?)WAngle.FromFacing((int)order.ExtraData) : null;
SendParatroopers(self, order.Target.CenterPosition, facing);
}
public (Actor[] Aircraft, Actor[] Units) SendParatroopers(Actor self, WPos target, WAngle? facing = null)
{
var aircraft = new List<Actor>();
var units = new List<Actor>();
if (!facing.HasValue)
facing = new WAngle(1024 * self.World.SharedRandom.Next(info.QuantizedFacings) / info.QuantizedFacings);
var utLower = info.UnitType.ToLowerInvariant();
if (!self.World.Map.Rules.Actors.TryGetValue(utLower, out var unitType))
throw new YamlException($"Actors ruleset does not include the entry '{utLower}'");
var altitude = unitType.TraitInfo<AircraftInfo>().CruiseAltitude.Length;
var dropRotation = WRot.FromYaw(facing.Value);
var delta = new WVec(0, -1024, 0).Rotate(dropRotation);
target += new WVec(0, 0, altitude);
var startEdge = target - (self.World.Map.DistanceToEdge(target, -delta) + info.Cordon).Length * delta / 1024;
var finishEdge = target + (self.World.Map.DistanceToEdge(target, delta) + info.Cordon).Length * delta / 1024;
Actor camera = null;
Beacon beacon = null;
var aircraftInRange = new Dictionary<Actor, bool>();
void OnEnterRange(Actor a)
{
// Spawn a camera and remove the beacon when the first plane enters the target area
if (info.CameraActor != null && camera == null && !aircraftInRange.Any(kv => kv.Value))
{
self.World.AddFrameEndTask(w =>
{
camera = w.CreateActor(info.CameraActor, new TypeDictionary
{
new LocationInit(self.World.Map.CellContaining(target)),
new OwnerInit(self.Owner),
});
});
}
RemoveBeacon(beacon);
if (!aircraftInRange.Any(kv => kv.Value))
{
Game.Sound.PlayNotification(self.World.Map.Rules, self.Owner, "Speech",
info.ReinforcementsArrivedSpeechNotification, self.Owner.Faction.InternalName);
TextNotificationsManager.AddTransientLine(self.Owner, info.ReinforcementsArrivedTextNotification);
}
aircraftInRange[a] = true;
}
void OnExitRange(Actor a)
{
aircraftInRange[a] = false;
// Remove the camera when the final plane leaves the target area
if (!aircraftInRange.Any(kv => kv.Value))
RemoveCamera(camera);
}
void OnRemovedFromWorld(Actor a)
{
aircraftInRange[a] = false;
// Checking for attack range is not relevant here because
// aircraft may be shot down before entering the range.
// If at the map's edge, they may be removed from world before leaving.
if (aircraftInRange.All(kv => !kv.Key.IsInWorld))
{
RemoveCamera(camera);
RemoveBeacon(beacon);
}
}
// Create the actors immediately so they can be returned
for (var i = -info.SquadSize / 2; i <= info.SquadSize / 2; i++)
{
// Even-sized squads skip the lead plane
if (i == 0 && (info.SquadSize & 1) == 0)
continue;
// Includes the 90 degree rotation between body and world coordinates
var so = info.SquadOffset;
var spawnOffset = new WVec(i * so.Y, -Math.Abs(i) * so.X, 0).Rotate(dropRotation);
aircraft.Add(self.World.CreateActor(false, info.UnitType, new TypeDictionary
{
new CenterPositionInit(startEdge + spawnOffset),
new OwnerInit(self.Owner),
new FacingInit(facing.Value),
}));
}
foreach (var p in info.DropItems)
{
units.Add(self.World.CreateActor(false, p.ToLowerInvariant(), new TypeDictionary
{
new OwnerInit(self.Owner)
}));
}
self.World.AddFrameEndTask(w =>
{
PlayLaunchSounds();
Actor distanceTestActor = null;
var passengersPerPlane = (info.DropItems.Length + info.SquadSize - 1) / info.SquadSize;
var added = 0;
var j = 0;
for (var i = -info.SquadSize / 2; i <= info.SquadSize / 2; i++)
{
// Even-sized squads skip the lead plane
if (i == 0 && (info.SquadSize & 1) == 0)
continue;
// Includes the 90 degree rotation between body and world coordinates
var so = info.SquadOffset;
var spawnOffset = new WVec(i * so.Y, -Math.Abs(i) * so.X, 0).Rotate(dropRotation);
var targetOffset = new WVec(i * so.Y, 0, 0).Rotate(dropRotation);
var a = aircraft[j++];
w.Add(a);
var drop = a.Trait<ParaDrop>();
drop.SetLZ(w.Map.CellContaining(target + targetOffset), !info.AllowImpassableCells);
drop.OnEnteredDropRange += OnEnterRange;
drop.OnExitedDropRange += OnExitRange;
drop.OnRemovedFromWorld += OnRemovedFromWorld;
var cargo = a.Trait<Cargo>();
foreach (var unit in units.Skip(added).Take(passengersPerPlane))
{
cargo.Load(a, unit);
added++;
}
a.QueueActivity(new Fly(a, Target.FromPos(target + spawnOffset)));
a.QueueActivity(new Fly(a, Target.FromPos(finishEdge + spawnOffset)));
a.QueueActivity(new RemoveSelf());
aircraftInRange.Add(a, false);
distanceTestActor = a;
}
// Dispose any unused units
for (var i = added; i < units.Count; i++)
units[i].Dispose();
if (Info.DisplayBeacon)
{
var distance = (target - startEdge).HorizontalLength;
beacon = new Beacon(
self.Owner,
target - new WVec(0, 0, altitude),
Info.BeaconPaletteIsPlayerPalette,
Info.BeaconPalette,
Info.BeaconImage,
Info.BeaconPoster,
Info.BeaconPosterPalette,
Info.BeaconSequence,
Info.ArrowSequence,
Info.CircleSequence,
Info.ClockSequence,
() => 1 - ((distanceTestActor.CenterPosition - target).HorizontalLength - info.BeaconDistanceOffset.Length) * 1f / distance,
Info.BeaconDelay);
w.Add(beacon);
}
});
return (aircraft.ToArray(), units.ToArray());
}
void RemoveCamera(Actor camera)
{
if (camera == null)
return;
camera.QueueActivity(new Wait(info.CameraRemoveDelay));
camera.QueueActivity(new RemoveSelf());
}
void RemoveBeacon(Beacon beacon)
{
if (beacon == null)
return;
Self.World.AddFrameEndTask(w => w.Remove(beacon));
}
}
}