epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove TiberianSunRefinery

Browse Source 
Also add IDockClientBody interface,
move WithDockingOverlay cnc -> common,
remove HarvesterDockSequence implementing classes
This commit is contained in:
Gustas
2023-01-20 13:53:31 +02:00
committed by Matthias Mailänder
parent 3f0c3a8b9c
commit 049d0283f9
13 changed files with 159 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
OpenRA.Mods.Common/Activities/HarvesterDockSequence.cs
View File

@@ -14,18 +14,21 @@ using System.Collections.Generic;
using System.Linq;
using OpenRA.Activities;
using OpenRA.Mods.Common.Traits;
using OpenRA.Mods.Common.Traits.Render;
using OpenRA.Primitives;
using OpenRA.Traits;
namespace OpenRA.Mods.Common.Activities
{
public abstract class HarvesterDockSequence : Activity
public class HarvesterDockSequence : Activity
{
protected enum DockingState { Wait, Turn, Drag, Dock, Loop, Undock, Complete }
protected readonly Actor RefineryActor;
protected readonly Refinery Refinery;
protected readonly WithDockingOverlay DockHostSpriteOverlay;
protected readonly Harvester Harv;
protected readonly IDockClientBody DockClientBody;
protected readonly WAngle DockAngle;
protected readonly bool IsDragRequired;
protected readonly WVec DragOffset;
@@ -38,16 +41,20 @@ namespace OpenRA.Mods.Common.Activities
readonly INotifyDockClient[] notifyDockClients;
readonly INotifyDockHost[] notifyDockHosts;
bool dockInitiated = false;
public HarvesterDockSequence(Actor self, Actor refineryActor, Refinery refinery)
{
dockingState = DockingState.Turn;
Refinery = refinery;
RefineryActor = refineryActor;
DockHostSpriteOverlay = refineryActor.TraitOrDefault<WithDockingOverlay>();
DockAngle = refinery.DeliveryAngle;
IsDragRequired = refinery.IsDragRequired;
DragOffset = refinery.DragOffset;
DragLength = refinery.DragLength;
Harv = self.Trait<Harvester>();
DockClientBody = self.TraitOrDefault<IDockClientBody>();
StartDrag = self.CenterPosition;
EndDrag = refineryActor.CenterPosition + DragOffset;
notifyDockClients = self.TraitsImplementing<INotifyDockClient>().ToArray();
@@ -79,7 +86,8 @@ namespace OpenRA.Mods.Common.Activities
case DockingState.Dock:
if (!IsCanceling && RefineryActor.IsInWorld && !RefineryActor.IsDead && !Harv.IsTraitDisabled)
{
OnStateDock(self);
dockInitiated = true;
PlayDockAnimations(self);
NotifyDocked(self);
}
else
@@ -94,7 +102,11 @@ namespace OpenRA.Mods.Common.Activities
return false;
case DockingState.Undock:
OnStateUndock(self);
if (dockInitiated)
PlayUndockAnimations(self);
else
dockingState = DockingState.Complete;
return false;
case DockingState.Complete:
@@ -110,19 +122,65 @@ namespace OpenRA.Mods.Common.Activities
throw new InvalidOperationException("Invalid harvester dock state");
}
public override IEnumerable<Target> GetTargets(Actor self)
public virtual void PlayDockAnimations(Actor self)
{
yield return Target.FromActor(RefineryActor);
PlayDockCientAnimation(self, () =>
{
if (DockHostSpriteOverlay != null && !DockHostSpriteOverlay.Visible)
{
dockingState = DockingState.Wait;
DockHostSpriteOverlay.Visible = true;
DockHostSpriteOverlay.WithOffset.Animation.PlayThen(DockHostSpriteOverlay.Info.Sequence, () =>
{
dockingState = DockingState.Loop;
DockHostSpriteOverlay.Visible = false;
});
}
else
dockingState = DockingState.Loop;
});
}
public override IEnumerable<TargetLineNode> TargetLineNodes(Actor self)
public virtual void PlayDockCientAnimation(Actor self, Action after)
{
yield return new TargetLineNode(Target.FromActor(RefineryActor), Color.Green);
if (DockClientBody != null)
{
dockingState = DockingState.Wait;
DockClientBody.PlayDockAnimation(self, () => after());
}
else
after();
}
public abstract void OnStateDock(Actor self);
public virtual void PlayUndockAnimations(Actor self)
{
if (RefineryActor.IsInWorld && !RefineryActor.IsDead && DockHostSpriteOverlay != null && !DockHostSpriteOverlay.Visible)
{
dockingState = DockingState.Wait;
DockHostSpriteOverlay.Visible = true;
DockHostSpriteOverlay.WithOffset.Animation.PlayBackwardsThen(DockHostSpriteOverlay.Info.Sequence, () =>
{
PlayUndockClientAnimation(self, () =>
{
dockingState = DockingState.Complete;
DockHostSpriteOverlay.Visible = false;
});
});
}
else
PlayUndockClientAnimation(self, () => dockingState = DockingState.Complete);
}
public abstract void OnStateUndock(Actor self);
public virtual void PlayUndockClientAnimation(Actor self, Action after)
{
if (DockClientBody != null)
{
dockingState = DockingState.Wait;
DockClientBody.PlayReverseDockAnimation(self, () => after());
}
else
after();
}
void NotifyDocked(Actor self)
{
@@ -142,5 +200,15 @@ namespace OpenRA.Mods.Common.Activities
foreach (var nd in notifyDockHosts)
nd.Undocked(RefineryActor, self);
}
public override IEnumerable<Target> GetTargets(Actor self)
{
yield return Target.FromActor(RefineryActor);
}
public override IEnumerable<TargetLineNode> TargetLineNodes(Actor self)
{
yield return new TargetLineNode(Target.FromActor(RefineryActor), Color.Green);
}
}
}

56
OpenRA.Mods.Common/Activities/SpriteHarvesterDockSequence.cs
View File

@@ -1,56 +0,0 @@
#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 OpenRA.Mods.Common.Traits;
using OpenRA.Mods.Common.Traits.Render;
namespace OpenRA.Mods.Common.Activities
{
public class SpriteHarvesterDockSequence : HarvesterDockSequence
{
readonly WithSpriteBody wsb;
readonly WithDockingAnimationInfo wda;
protected bool dockAnimPlayed;
public SpriteHarvesterDockSequence(Actor self, Actor refineryActor, Refinery refinery)
: base(self, refineryActor, refinery)
{
wsb = self.Trait<WithSpriteBody>();
wda = self.Info.TraitInfoOrDefault<WithDockingAnimationInfo>();
}
public override void OnStateDock(Actor self)
{
if (wda != null)
wsb.PlayCustomAnimation(self, wda.DockSequence, () => wsb.PlayCustomAnimationRepeating(self, wda.DockLoopSequence));
dockAnimPlayed = true;
dockingState = DockingState.Loop;
}
public override void OnStateUndock(Actor self)
{
// If dock animation hasn't played, we didn't actually dock and have to skip the undock anim and notification
if (!dockAnimPlayed)
{
dockingState = DockingState.Complete;
return;
}
dockingState = DockingState.Wait;
if (wda == null)
dockingState = DockingState.Complete;
else
wsb.PlayCustomAnimationBackwards(self, wda.DockSequence, () => dockingState = DockingState.Complete);
}
}
}

7
OpenRA.Mods.Common/Traits/Buildings/Refinery.cs
View File

@@ -89,11 +89,6 @@ namespace OpenRA.Mods.Common.Traits
resourceValueModifiers = self.TraitsImplementing<IResourceValueModifier>().ToArray().Select(m => m.GetResourceValueModifier());
}
public virtual Activity DockSequence(Actor harv, Actor self)
{
return new SpriteHarvesterDockSequence(harv, self, this);
}
public IEnumerable<TraitPair<Harvester>> GetLinkedHarvesters()
{
return self.World.ActorsWithTrait<Harvester>()
@@ -171,7 +166,7 @@ namespace OpenRA.Mods.Common.Traits
if (!preventDock)
{
dockOrder.QueueChild(new CallFunc(() => dockedHarv = harv, false));
dockOrder.QueueChild(DockSequence(harv, self));
dockOrder.QueueChild(new HarvesterDockSequence(harv, self, this));
dockOrder.QueueChild(new CallFunc(() => dockedHarv = null, false));
}
}

27
OpenRA.Mods.Common/Traits/Render/WithDockingAnimation.cs
View File

@@ -9,11 +9,12 @@
*/
#endregion
using System;
using OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits.Render
{
public class WithDockingAnimationInfo : TraitInfo<WithDockingAnimation>, Requires<WithSpriteBodyInfo>, Requires<HarvesterInfo>
public class WithDockingAnimationInfo : TraitInfo, Requires<WithSpriteBodyInfo>, Requires<HarvesterInfo>
{
[SequenceReference]
[Desc("Displayed when docking to refinery.")]
@@ -22,7 +23,29 @@ namespace OpenRA.Mods.Common.Traits.Render
[SequenceReference]
[Desc("Looped while unloading at refinery.")]
public readonly string DockLoopSequence = "dock-loop";
public override object Create(ActorInitializer init) { return new WithDockingAnimation(init.Self, this); }
}
public class WithDockingAnimation { }
public class WithDockingAnimation : IDockClientBody
{
readonly WithDockingAnimationInfo info;
readonly WithSpriteBody wsb;
public WithDockingAnimation(Actor self, WithDockingAnimationInfo info)
{
this.info = info;
wsb = self.Trait<WithSpriteBody>();
}
void IDockClientBody.PlayDockAnimation(Actor self, Action after)
{
wsb.PlayCustomAnimation(self, info.DockSequence, () => { wsb.PlayCustomAnimationRepeating(self, info.DockLoopSequence); after(); });
}
void IDockClientBody.PlayReverseDockAnimation(Actor self, Action after)
{
wsb.PlayCustomAnimationBackwards(self, info.DockSequence, () => after());
}
}
}

59
OpenRA.Mods.Common/Traits/Render/WithDockingOverlay.cs Normal file
View File

@@ -0,0 +1,59 @@
#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 OpenRA.Graphics;
using OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits.Render
{
[Desc("Rendered on the refinery when a voxel harvester is docking and undocking.")]
public class WithDockingOverlayInfo : PausableConditionalTraitInfo, Requires<RenderSpritesInfo>, Requires<BodyOrientationInfo>
{
[SequenceReference]
[Desc("Sequence name to use")]
public readonly string Sequence = "unload-overlay";
[Desc("Position relative to body")]
public readonly WVec Offset = WVec.Zero;
[PaletteReference(nameof(IsPlayerPalette))]
[Desc("Custom palette name")]
public readonly string Palette = null;
[Desc("Custom palette is a player palette BaseName")]
public readonly bool IsPlayerPalette = false;
public override object Create(ActorInitializer init) { return new WithDockingOverlay(init.Self, this); }
}
public class WithDockingOverlay : PausableConditionalTrait<WithDockingOverlayInfo>
{
public readonly AnimationWithOffset WithOffset;
public bool Visible;
public WithDockingOverlay(Actor self, WithDockingOverlayInfo info)
: base(info)
{
var rs = self.Trait<RenderSprites>();
var body = self.Trait<BodyOrientation>();
var overlay = new Animation(self.World, rs.GetImage(self), () => IsTraitPaused);
overlay.Play(info.Sequence);
WithOffset = new AnimationWithOffset(overlay,
() => body.LocalToWorld(info.Offset.Rotate(body.QuantizeOrientation(self.Orientation))),
() => !Visible || IsTraitDisabled);
rs.Add(WithOffset, info.Palette, info.IsPlayerPalette);
}
}
}

6
OpenRA.Mods.Common/TraitsInterfaces.cs
View File

@@ -273,6 +273,12 @@ namespace OpenRA.Mods.Common.Traits
bool AllowDocking { get; }
}
public interface IDockClientBody
{
void PlayDockAnimation(Actor self, Action after);
void PlayReverseDockAnimation(Actor self, Action after);
}
public interface IProvidesAssetBrowserPalettes
{
IEnumerable<string> PaletteNames { get; }

29
OpenRA.Mods.Common/UpdateRules/Rules/20221203/RemoveTSRefinery.cs Normal file
View File

@@ -0,0 +1,29 @@
#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.Generic;
namespace OpenRA.Mods.Common.UpdateRules.Rules
{
public class RemoveTSRefinery : UpdateRule
{
public override string Name => "TiberianSunRefinery removed.";
public override string Description => "TiberianSunRefinery was removed, use Refinery instead.";
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode)
{
actorNode.RenameChildrenMatching("TiberianSunRefinery", "Refinery");
yield break;
}
}
}

3
OpenRA.Mods.Common/UpdateRules/UpdatePath.cs
View File

@@ -105,7 +105,8 @@ namespace OpenRA.Mods.Common.UpdateRules
new TextNotificationsDisplayWidgetRemoveTime(),
new ExplicitSequenceFilenames(),
new RenameEngineerRepair(),
new ProductionTabsWidgetAddTabButtonCollection()
new ProductionTabsWidgetAddTabButtonCollection(),
new RemoveTSRefinery(),
})
};