#region Copyright & License Information /* * Copyright 2007-2019 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; using OpenRA.Graphics; using OpenRA.Mods.Common.Graphics; using OpenRA.Primitives; using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits.Render { [Desc("Displays a text overlay relative to the selection box.")] public class WithTextDecorationInfo : ConditionalTraitInfo, Requires { [Translate] [FieldLoader.Require] public readonly string Text = null; public readonly string Font = "TinyBold"; [Desc("Display in this color when not using the player color.")] public readonly Color Color = Color.White; [Desc("Use the player color of the current owner.")] public readonly bool UsePlayerColor = false; [Desc("Point in the actor's selection box used as reference for offsetting the decoration image. " + "Possible values are combinations of Center, Top, Bottom, Left, Right.")] public readonly ReferencePoints ReferencePoint = ReferencePoints.Top | ReferencePoints.Left; [Desc("The Z offset to apply when rendering this decoration.")] public readonly int ZOffset = 1; [Desc("Player stances who can view the decoration.")] public readonly Stance ValidStances = Stance.Ally; [Desc("Should this be visible only when selected?")] public readonly bool RequiresSelection = false; public override object Create(ActorInitializer init) { return new WithTextDecoration(init.Self, this); } public override void RulesetLoaded(Ruleset rules, ActorInfo ai) { if (!Game.ModData.Manifest.Get().FontList.ContainsKey(Font)) throw new YamlException("Font '{0}' is not listed in the mod.yaml's Fonts section".F(Font)); base.RulesetLoaded(rules, ai); } } public class WithTextDecoration : ConditionalTrait, IRender, IRenderAnnotationsWhenSelected, INotifyOwnerChanged { readonly SpriteFont font; readonly IDecorationBounds[] decorationBounds; Color color; public WithTextDecoration(Actor self, WithTextDecorationInfo info) : base(info) { font = Game.Renderer.Fonts[info.Font]; decorationBounds = self.TraitsImplementing().ToArray(); color = Info.UsePlayerColor ? self.Owner.Color : Info.Color; } public virtual bool ShouldRender(Actor self) { return true; } IEnumerable IRender.Render(Actor self, WorldRenderer wr) { return !Info.RequiresSelection ? RenderInner(self, wr) : SpriteRenderable.None; } IEnumerable IRender.ScreenBounds(Actor self, WorldRenderer wr) { // Text decorations don't contribute to actor bounds yield break; } IEnumerable IRenderAnnotationsWhenSelected.RenderAnnotations(Actor self, WorldRenderer wr) { return Info.RequiresSelection ? RenderInner(self, wr) : SpriteRenderable.None; } bool IRenderAnnotationsWhenSelected.SpatiallyPartitionable { get { return true; } } IEnumerable RenderInner(Actor self, WorldRenderer wr) { if (IsTraitDisabled || self.IsDead || !self.IsInWorld) return Enumerable.Empty(); if (self.World.RenderPlayer != null) { var stance = self.Owner.Stances[self.World.RenderPlayer]; if (!Info.ValidStances.HasStance(stance)) return Enumerable.Empty(); } if (!ShouldRender(self) || self.World.FogObscures(self)) return Enumerable.Empty(); var bounds = decorationBounds.FirstNonEmptyBounds(self, wr); var halfSize = font.Measure(Info.Text) / 2; var boundsOffset = new int2(bounds.Left + bounds.Right, bounds.Top + bounds.Bottom) / 2; var sizeOffset = int2.Zero; if (Info.ReferencePoint.HasFlag(ReferencePoints.Top)) { boundsOffset -= new int2(0, bounds.Height / 2); sizeOffset += new int2(0, halfSize.Y); } else if (Info.ReferencePoint.HasFlag(ReferencePoints.Bottom)) { boundsOffset += new int2(0, bounds.Height / 2); sizeOffset -= new int2(0, halfSize.Y); } if (Info.ReferencePoint.HasFlag(ReferencePoints.Left)) { boundsOffset -= new int2(bounds.Width / 2, 0); sizeOffset += new int2(halfSize.X, 0); } else if (Info.ReferencePoint.HasFlag(ReferencePoints.Right)) { boundsOffset += new int2(bounds.Width / 2, 0); sizeOffset -= new int2(halfSize.X, 0); } return new IRenderable[] { new TextAnnotationRenderable(font, wr.ProjectedPosition(boundsOffset + sizeOffset), Info.ZOffset, color, Info.Text) }; } void INotifyOwnerChanged.OnOwnerChanged(Actor self, Player oldOwner, Player newOwner) { if (Info.UsePlayerColor) color = newOwner.Color; } } }