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

58 lines
1.7 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 OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits
{
[Desc("Additional info shown in the battlefield tooltip.")]
public class TooltipDescriptionInfo : ConditionalTraitInfo
{
[FieldLoader.Require]
[FluentReference]
[Desc("Text shown in tooltip.")]
public readonly string Description;
[Desc("Player relationships who can view the description.")]
public readonly PlayerRelationship ValidRelationships = PlayerRelationship.Ally | PlayerRelationship.Neutral | PlayerRelationship.Enemy;
public override object Create(ActorInitializer init) { return new TooltipDescription(init.Self, this); }
}
public class TooltipDescription : ConditionalTrait<TooltipDescriptionInfo>, IProvideTooltipInfo
{
readonly Actor self;
public Player Owner => self.EffectiveOwner != null ? self.EffectiveOwner.Owner : self.Owner;
public TooltipDescription(Actor self, TooltipDescriptionInfo info)
: base(info)
{
this.self = self;
TooltipText = FluentProvider.GetString(info.Description);
}
public bool IsTooltipVisible(Player forPlayer)
{
if (IsTraitDisabled)
return false;
// Visibility can't be determined for null owners or viewers
if (Owner == null || forPlayer == null)
return false;
return Info.ValidRelationships.HasRelationship(Owner.RelationshipWith(forPlayer));
}
public string TooltipText { get; }
}
}