Remove SmokeTrailWhenDamaged

One of the most outdated and limited traits remaining,
which can do nothing LeavesTrails doesn't cover by now.
This commit is contained in:
reaperrr
2021-02-12 22:48:29 +01:00
committed by Paul Chote
parent d15e7f76fc
commit b8e64df4b1
6 changed files with 241 additions and 121 deletions

View File

@@ -1,68 +0,0 @@
#region Copyright & License Information
/*
* Copyright 2007-2020 The OpenRA Developers (see AUTHORS)
* 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 OpenRA.Mods.Common.Effects;
using OpenRA.Mods.Common.Traits.Render;
using OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits
{
class SmokeTrailWhenDamagedInfo : TraitInfo, Requires<BodyOrientationInfo>
{
[Desc("Position relative to body")]
public readonly WVec Offset = WVec.Zero;
public readonly int Interval = 3;
public readonly string Sprite = "smokey";
[SequenceReference(nameof(Sprite))]
public readonly string Sequence = "idle";
public readonly string Palette = "effect";
public readonly DamageState MinDamage = DamageState.Heavy;
public override object Create(ActorInitializer init) { return new SmokeTrailWhenDamaged(init.Self, this); }
}
class SmokeTrailWhenDamaged : ITick
{
readonly SmokeTrailWhenDamagedInfo info;
readonly BodyOrientation body;
readonly Func<WAngle> getFacing;
int ticks;
public SmokeTrailWhenDamaged(Actor self, SmokeTrailWhenDamagedInfo info)
{
this.info = info;
body = self.Trait<BodyOrientation>();
getFacing = RenderSprites.MakeFacingFunc(self);
}
void ITick.Tick(Actor self)
{
if (--ticks <= 0)
{
var position = self.CenterPosition;
if (position.Z > 0 && self.GetDamageState() >= info.MinDamage && !self.World.FogObscures(self))
{
var offset = info.Offset.Rotate(body.QuantizeOrientation(self, self.Orientation));
var pos = position + body.LocalToWorld(offset);
self.World.AddFrameEndTask(w => w.Add(new SpriteEffect(pos, getFacing(), w, info.Sprite, info.Sequence, info.Palette)));
}
ticks = info.Interval;
}
}
}
}

View File

@@ -0,0 +1,105 @@
#region Copyright & License Information
/*
* Copyright 2007-2021 The OpenRA Developers (see AUTHORS)
* 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;
using System.Linq;
namespace OpenRA.Mods.Common.UpdateRules.Rules
{
public class RemoveSmokeTrailWhenDamaged : UpdateRule
{
public override string Name { get { return "'SmokeTrailWhenDamaged' has been removed in favor of using 'LeavesTrails'."; } }
public override string Description
{
get
{
return "'SmokeTrailWhenDamaged' was removed.";
}
}
readonly Dictionary<string, List<string>> locations = new Dictionary<string, List<string>>();
public override IEnumerable<string> AfterUpdate(ModData modData)
{
if (locations.Any())
yield return "Some actor(s) defined a MinDamage of neither 'Heavy' nor 'Undamaged' on SmokeTrailWhenDamaged before update.\n" +
"Review the following definitions and add custom GrandConditionOnDamageState configs as required:\n" +
UpdateUtils.FormatMessageList(locations.Select(
kv => kv.Key + ":\n" + UpdateUtils.FormatMessageList(kv.Value)));
locations.Clear();
}
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode)
{
var locationKey = "{0} ({1})".F(actorNode.Key, actorNode.Location.Filename);
var anyConditionalSmokeTrail = false;
foreach (var smokeTrail in actorNode.ChildrenMatching("SmokeTrailWhenDamaged"))
{
var spriteNode = smokeTrail.LastChildMatching("Sprite");
if (spriteNode != null)
smokeTrail.RenameChildrenMatching("Sprite", "Image");
else
smokeTrail.AddNode("Image", FieldSaver.FormatValue("smokey"));
var intervalNode = smokeTrail.LastChildMatching("Interval");
if (intervalNode != null)
{
var interval = intervalNode.NodeValue<int>();
smokeTrail.RenameChildrenMatching("Interval", "MovingInterval");
smokeTrail.AddNode("StationaryInterval", FieldSaver.FormatValue(interval));
}
else
{
smokeTrail.AddNode("MovingInterval", FieldSaver.FormatValue(3));
smokeTrail.AddNode("StationaryInterval", FieldSaver.FormatValue(3));
}
var minDamageNode = smokeTrail.LastChildMatching("MinDamage");
var isConditional = true;
if (minDamageNode != null)
{
var minDamage = minDamageNode.NodeValue<string>();
if (minDamage == "Undamaged")
isConditional = false;
else if (minDamage != "Heavy")
locations.GetOrAdd(locationKey).Add(smokeTrail.Key);
smokeTrail.RemoveNode(minDamageNode);
}
smokeTrail.AddNode("SpawnAtLastPosition", FieldSaver.FormatValue(false));
smokeTrail.AddNode("TrailWhileStationary", FieldSaver.FormatValue(true));
smokeTrail.AddNode("Type", FieldSaver.FormatValue("CenterPosition"));
if (isConditional)
{
smokeTrail.AddNode("RequiresCondition", FieldSaver.FormatValue("enable-smoke"));
anyConditionalSmokeTrail = true;
}
smokeTrail.RenameChildrenMatching("Sequence", "Sequences");
smokeTrail.RenameChildrenMatching("Offset", "Offsets");
smokeTrail.RenameKey("LeavesTrails");
}
if (anyConditionalSmokeTrail)
{
var grantCondition = new MiniYamlNode("GrantConditionOnDamageState@SmokeTrail", "");
grantCondition.AddNode("Condition", FieldSaver.FormatValue("enable-smoke"));
actorNode.AddNode(grantCondition);
}
yield break;
}
}
}

View File

@@ -93,6 +93,7 @@ namespace OpenRA.Mods.Common.UpdateRules
new ReplaceResourceValueModifiers(),
new RemoveResourceType(),
new ConvertBoundsToWDist(),
new RemoveSmokeTrailWhenDamaged(),
})
};