#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 System.Collections.Generic; using System.Linq; using OpenRA.Graphics; using OpenRA.Mods.Common.Graphics; using OpenRA.Primitives; using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits.Render { [Desc("Renders a parachute on units.")] public class WithParachuteInfo : ConditionalTraitInfo, IRenderActorPreviewSpritesInfo, Requires, Requires { [Desc("The image that contains the parachute sequences.")] public readonly string Image = null; [SequenceReference(nameof(Image), allowNullImage: true)] [Desc("Parachute opening sequence.")] public readonly string OpeningSequence = null; [SequenceReference(nameof(Image), allowNullImage: true)] [Desc("Parachute idle sequence.")] public readonly string Sequence = null; [SequenceReference(nameof(Image), allowNullImage: true)] [Desc("Parachute closing sequence. Defaults to opening sequence played backwards.")] public readonly string ClosingSequence = null; [PaletteReference(nameof(IsPlayerPalette))] [Desc("Palette used to render the parachute.")] public readonly string Palette = "player"; public readonly bool IsPlayerPalette = true; [Desc("Parachute position relative to the paradropped unit.")] public readonly WVec Offset = new WVec(0, 0, 384); [Desc("The image that contains the shadow sequence for the paradropped unit.")] public readonly string ShadowImage = null; [SequenceReference(nameof(ShadowImage), allowNullImage: true)] [Desc("Paradropped unit's shadow sequence.")] public readonly string ShadowSequence = null; [PaletteReference(false)] [Desc("Palette used to render the paradropped unit's shadow.")] public readonly string ShadowPalette = "shadow"; [Desc("Shadow position relative to the paradropped unit's intended landing position.")] public readonly WVec ShadowOffset = new WVec(0, 128, 0); [Desc("Z-offset to apply on the shadow sequence.")] public readonly int ShadowZOffset = 0; public override object Create(ActorInitializer init) { return new WithParachute(init.Self, this); } public IEnumerable RenderPreviewSprites(ActorPreviewInitializer init, RenderSpritesInfo rs, string image, int facings, PaletteReference p) { if (!EnabledByDefault) yield break; if (image == null) yield break; // For this, image must not be null if (Palette != null) p = init.WorldRenderer.Palette(Palette); Func facing; var dynamicfacingInit = init.GetOrDefault(); if (dynamicfacingInit != null) facing = dynamicfacingInit.Value; else { var f = init.GetValue(WAngle.Zero); facing = () => f; } var anim = new Animation(init.World, image); anim.PlayThen(OpeningSequence, () => anim.PlayRepeating(Sequence)); var body = init.Actor.TraitInfo(); Func orientation = () => body.QuantizeOrientation(WRot.FromYaw(facing()), facings); Func offset = () => body.LocalToWorld(Offset.Rotate(orientation())); Func zOffset = () => { var tmpOffset = offset(); return tmpOffset.Y + tmpOffset.Z + 1; }; yield return new SpriteActorPreview(anim, offset, zOffset, p, rs.Scale); } } public class WithParachute : ConditionalTrait, ITick, IRender { readonly Animation shadow; readonly AnimationWithOffset anim; readonly WithParachuteInfo info; bool renderProlonged = false; public WithParachute(Actor self, WithParachuteInfo info) : base(info) { this.info = info; if (info.ShadowImage != null) { shadow = new Animation(self.World, info.ShadowImage); shadow.PlayRepeating(info.ShadowSequence); } if (info.Image == null) return; // For this, info.Image must not be null var overlay = new Animation(self.World, info.Image); var body = self.Trait(); anim = new AnimationWithOffset(overlay, () => body.LocalToWorld(info.Offset.Rotate(body.QuantizeOrientation(self, self.Orientation))), () => IsTraitDisabled && !renderProlonged, p => RenderUtils.ZOffsetFromCenter(self, p, 1)); var rs = self.Trait(); rs.Add(anim, info.Palette, info.IsPlayerPalette); } protected override void TraitEnabled(Actor self) { if (info.Image == null) return; anim.Animation.PlayThen(info.OpeningSequence, () => anim.Animation.PlayRepeating(info.Sequence)); } protected override void TraitDisabled(Actor self) { if (info.Image == null) return; renderProlonged = true; if (!string.IsNullOrEmpty(info.ClosingSequence)) anim.Animation.PlayThen(info.ClosingSequence, () => renderProlonged = false); else anim.Animation.PlayBackwardsThen(info.OpeningSequence, () => renderProlonged = false); } void ITick.Tick(Actor self) { shadow?.Tick(); } IEnumerable IRender.Render(Actor self, WorldRenderer wr) { if (info.ShadowImage == null) return Enumerable.Empty(); if (IsTraitDisabled || self.IsDead || !self.IsInWorld) return Enumerable.Empty(); if (self.World.FogObscures(self)) return Enumerable.Empty(); var dat = self.World.Map.DistanceAboveTerrain(self.CenterPosition); var pos = self.CenterPosition - new WVec(0, 0, dat.Length); var palette = wr.Palette(info.ShadowPalette); return new IRenderable[] { new SpriteRenderable(shadow.Image, pos, info.ShadowOffset, info.ShadowZOffset, palette, 1, true, shadow.CurrentSequence.IgnoreWorldTint) }; } IEnumerable IRender.ScreenBounds(Actor self, WorldRenderer wr) { if (info.ShadowImage == null) return Enumerable.Empty(); if (IsTraitDisabled || self.IsDead || !self.IsInWorld) return Enumerable.Empty(); if (self.World.FogObscures(self)) return Enumerable.Empty(); var dat = self.World.Map.DistanceAboveTerrain(self.CenterPosition); var pos = self.CenterPosition - new WVec(0, 0, dat.Length); return new Rectangle[] { shadow.ScreenBounds(wr, pos, info.ShadowOffset, 1) }; } } }