Add health overlay and a command to toggle it (#3278)
* Add health overlay bar and a command to toggle it * Remove empty line
This commit is contained in:
21
Content.Client/Commands/ToggleHealthOverlayCommand.cs
Normal file
21
Content.Client/Commands/ToggleHealthOverlayCommand.cs
Normal file
@@ -0,0 +1,21 @@
|
||||
using Content.Client.GameObjects.EntitySystems.HealthOverlay;
|
||||
using Robust.Shared.Console;
|
||||
using Robust.Shared.GameObjects;
|
||||
|
||||
namespace Content.Client.Commands
|
||||
{
|
||||
public class ToggleHealthOverlayCommand : IConsoleCommand
|
||||
{
|
||||
public string Command => "togglehealthoverlay";
|
||||
public string Description => "Toggles a health bar above mobs.";
|
||||
public string Help => $"Usage: {Command}";
|
||||
|
||||
public void Execute(IConsoleShell shell, string argStr, string[] args)
|
||||
{
|
||||
var system = EntitySystem.Get<HealthOverlaySystem>();
|
||||
system.Enabled = !system.Enabled;
|
||||
|
||||
shell.WriteLine($"Health overlay system {(system.Enabled ? "enabled" : "disabled")}.");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Client.UserInterface;
|
||||
using Robust.Shared.IoC;
|
||||
using Robust.Shared.Maths;
|
||||
using Robust.Shared.Prototypes;
|
||||
|
||||
namespace Content.Client.GameObjects.EntitySystems.HealthOverlay
|
||||
{
|
||||
public class HealthOverlayBar : Control
|
||||
{
|
||||
public const byte HealthBarScale = 2;
|
||||
|
||||
private const int XPixelDiff = 20 * HealthBarScale;
|
||||
|
||||
public HealthOverlayBar()
|
||||
{
|
||||
IoCManager.InjectDependencies(this);
|
||||
Shader = IoCManager.Resolve<IPrototypeManager>().Index<ShaderPrototype>("unshaded").Instance();
|
||||
}
|
||||
|
||||
private ShaderInstance Shader { get; }
|
||||
|
||||
/// <summary>
|
||||
/// From -1 (dead) to 0 (crit) and 1 (alive)
|
||||
/// </summary>
|
||||
public float Ratio { get; set; }
|
||||
|
||||
public Color Color { get; set; }
|
||||
|
||||
protected override void Draw(DrawingHandleScreen handle)
|
||||
{
|
||||
base.Draw(handle);
|
||||
|
||||
handle.UseShader(Shader);
|
||||
|
||||
var leftOffset = 2 * HealthBarScale;
|
||||
var box = new UIBox2i(
|
||||
leftOffset,
|
||||
-2 + 2 * HealthBarScale,
|
||||
leftOffset + (int) (XPixelDiff * Ratio * UIScale),
|
||||
-2);
|
||||
|
||||
handle.DrawRect(box, Color);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
#nullable enable
|
||||
using Content.Client.Utility;
|
||||
using Content.Shared.GameObjects.Components.Damage;
|
||||
using Content.Shared.GameObjects.Components.Mobs.State;
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Client.UserInterface;
|
||||
using Robust.Client.UserInterface.Controls;
|
||||
using Robust.Shared.GameObjects;
|
||||
using Robust.Shared.IoC;
|
||||
using Robust.Shared.Map;
|
||||
using Robust.Shared.Maths;
|
||||
using Robust.Shared.Timing;
|
||||
|
||||
namespace Content.Client.GameObjects.EntitySystems.HealthOverlay
|
||||
{
|
||||
public class HealthOverlayGui : VBoxContainer
|
||||
{
|
||||
[Dependency] private readonly IEyeManager _eyeManager = default!;
|
||||
|
||||
public HealthOverlayGui(IEntity entity)
|
||||
{
|
||||
IoCManager.InjectDependencies(this);
|
||||
IoCManager.Resolve<IUserInterfaceManager>().StateRoot.AddChild(this);
|
||||
SeparationOverride = 0;
|
||||
|
||||
CritBar = new HealthOverlayBar
|
||||
{
|
||||
Visible = false,
|
||||
SizeFlagsVertical = SizeFlags.ShrinkCenter,
|
||||
Color = Color.Red
|
||||
};
|
||||
|
||||
HealthBar = new HealthOverlayBar
|
||||
{
|
||||
Visible = false,
|
||||
SizeFlagsVertical = SizeFlags.ShrinkCenter,
|
||||
Color = Color.Green
|
||||
};
|
||||
|
||||
AddChild(Panel = new PanelContainer
|
||||
{
|
||||
Children =
|
||||
{
|
||||
new TextureRect
|
||||
{
|
||||
Texture = StaticIoC.ResC.GetTexture("/Textures/Interface/Misc/health_bar.rsi/icon.png"),
|
||||
TextureScale = Vector2.One * HealthOverlayBar.HealthBarScale,
|
||||
SizeFlagsVertical = SizeFlags.ShrinkCenter
|
||||
},
|
||||
CritBar,
|
||||
HealthBar
|
||||
}
|
||||
});
|
||||
|
||||
Entity = entity;
|
||||
}
|
||||
|
||||
public PanelContainer Panel { get; }
|
||||
|
||||
public HealthOverlayBar HealthBar { get; }
|
||||
|
||||
public HealthOverlayBar CritBar { get; }
|
||||
|
||||
public IEntity Entity { get; }
|
||||
|
||||
public void SetVisibility(bool val)
|
||||
{
|
||||
Visible = val;
|
||||
Panel.Visible = val;
|
||||
}
|
||||
|
||||
protected override void Update(FrameEventArgs args)
|
||||
{
|
||||
base.Update(args);
|
||||
|
||||
if (Entity.Deleted)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (!Entity.TryGetComponent(out IMobStateComponent? mobState) ||
|
||||
!Entity.TryGetComponent(out IDamageableComponent? damageable))
|
||||
{
|
||||
CritBar.Visible = false;
|
||||
HealthBar.Visible = false;
|
||||
return;
|
||||
}
|
||||
|
||||
int threshold;
|
||||
|
||||
if (mobState.IsAlive())
|
||||
{
|
||||
if (!mobState.TryGetEarliestCriticalState(damageable.TotalDamage, out _, out threshold))
|
||||
{
|
||||
CritBar.Visible = false;
|
||||
HealthBar.Visible = false;
|
||||
return;
|
||||
}
|
||||
|
||||
CritBar.Ratio = 1;
|
||||
CritBar.Visible = true;
|
||||
HealthBar.Ratio = 1 - (float) damageable.TotalDamage / threshold;
|
||||
HealthBar.Visible = true;
|
||||
}
|
||||
else if (mobState.IsCritical())
|
||||
{
|
||||
HealthBar.Ratio = 0;
|
||||
HealthBar.Visible = false;
|
||||
|
||||
if (!mobState.TryGetPreviousCriticalState(damageable.TotalDamage, out _, out var critThreshold) ||
|
||||
!mobState.TryGetEarliestDeadState(damageable.TotalDamage, out _, out var deadThreshold))
|
||||
{
|
||||
CritBar.Visible = false;
|
||||
return;
|
||||
}
|
||||
|
||||
CritBar.Visible = true;
|
||||
CritBar.Ratio = 1 - (float)
|
||||
(damageable.TotalDamage - critThreshold) /
|
||||
(deadThreshold - critThreshold);
|
||||
}
|
||||
else if (mobState.IsDead())
|
||||
{
|
||||
CritBar.Ratio = 0;
|
||||
CritBar.Visible = false;
|
||||
HealthBar.Ratio = 0;
|
||||
HealthBar.Visible = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
CritBar.Visible = false;
|
||||
HealthBar.Visible = false;
|
||||
}
|
||||
}
|
||||
|
||||
protected override void FrameUpdate(FrameEventArgs args)
|
||||
{
|
||||
base.FrameUpdate(args);
|
||||
|
||||
if (Entity.Deleted ||
|
||||
_eyeManager.CurrentMap != Entity.Transform.MapID)
|
||||
{
|
||||
Visible = false;
|
||||
return;
|
||||
}
|
||||
|
||||
Visible = true;
|
||||
|
||||
var screenCoordinates = _eyeManager.CoordinatesToScreen(Entity.Transform.Coordinates);
|
||||
var playerPosition = new ScreenCoordinates(screenCoordinates.X / UIScale, screenCoordinates.Y / UIScale);
|
||||
LayoutContainer.SetPosition(this, new Vector2(playerPosition.X - Width / 2, playerPosition.Y - Height - 30.0f));
|
||||
}
|
||||
|
||||
protected override void Dispose(bool disposing)
|
||||
{
|
||||
base.Dispose(disposing);
|
||||
|
||||
if (!disposing) return;
|
||||
|
||||
HealthBar.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
#nullable enable
|
||||
using System.Collections.Generic;
|
||||
using Content.Shared.GameObjects.Components.Damage;
|
||||
using Content.Shared.GameObjects.Components.Mobs.State;
|
||||
using Content.Shared.GameTicking;
|
||||
using JetBrains.Annotations;
|
||||
using Robust.Client.GameObjects;
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Shared.GameObjects;
|
||||
using Robust.Shared.IoC;
|
||||
|
||||
namespace Content.Client.GameObjects.EntitySystems.HealthOverlay
|
||||
{
|
||||
[UsedImplicitly]
|
||||
public class HealthOverlaySystem : EntitySystem, IResettingEntitySystem
|
||||
{
|
||||
[Dependency] private readonly IEyeManager _eyeManager = default!;
|
||||
|
||||
private readonly Dictionary<EntityUid, HealthOverlayGui> _guis = new();
|
||||
private IEntity? _attachedEntity;
|
||||
private bool _enabled;
|
||||
|
||||
public bool Enabled
|
||||
{
|
||||
get => _enabled;
|
||||
set
|
||||
{
|
||||
if (_enabled == value)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_enabled = value;
|
||||
|
||||
foreach (var gui in _guis.Values)
|
||||
{
|
||||
gui.SetVisibility(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public override void Initialize()
|
||||
{
|
||||
base.Initialize();
|
||||
|
||||
SubscribeLocalEvent<PlayerAttachSysMessage>(HandlePlayerAttached);
|
||||
}
|
||||
|
||||
public void Reset()
|
||||
{
|
||||
foreach (var gui in _guis.Values)
|
||||
{
|
||||
gui.Dispose();
|
||||
}
|
||||
|
||||
_guis.Clear();
|
||||
_attachedEntity = null;
|
||||
}
|
||||
|
||||
private void HandlePlayerAttached(PlayerAttachSysMessage message)
|
||||
{
|
||||
_attachedEntity = message.AttachedEntity;
|
||||
}
|
||||
|
||||
public override void FrameUpdate(float frameTime)
|
||||
{
|
||||
base.Update(frameTime);
|
||||
|
||||
if (!_enabled)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (_attachedEntity == null || _attachedEntity.Deleted)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var viewBox = _eyeManager.GetWorldViewport().Enlarged(2.0f);
|
||||
|
||||
foreach (var (mobState, _) in ComponentManager.EntityQuery<IMobStateComponent, IDamageableComponent>())
|
||||
{
|
||||
var entity = mobState.Owner;
|
||||
|
||||
if (_attachedEntity.Transform.MapID != entity.Transform.MapID ||
|
||||
!viewBox.Contains(entity.Transform.WorldPosition))
|
||||
{
|
||||
if (_guis.TryGetValue(entity.Uid, out var oldGui))
|
||||
{
|
||||
oldGui.Dispose();
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if (_guis.ContainsKey(entity.Uid))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
var gui = new HealthOverlayGui(entity);
|
||||
_guis.Add(entity.Uid, gui);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -18,11 +18,32 @@ namespace Content.Shared.GameObjects.Components.Mobs.State
|
||||
|
||||
(IMobState state, int threshold)? GetEarliestIncapacitatedState(int minimumDamage);
|
||||
|
||||
(IMobState state, int threshold)? GetEarliestCriticalState(int minimumDamage);
|
||||
|
||||
(IMobState state, int threshold)? GetEarliestDeadState(int minimumDamage);
|
||||
|
||||
(IMobState state, int threshold)? GetPreviousCriticalState(int maximumDamage);
|
||||
|
||||
bool TryGetEarliestIncapacitatedState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold);
|
||||
|
||||
bool TryGetEarliestCriticalState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold);
|
||||
|
||||
bool TryGetEarliestDeadState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold);
|
||||
|
||||
bool TryGetPreviousCriticalState(
|
||||
int maximumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold);
|
||||
|
||||
void UpdateState(int damage, bool syncing = false);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -43,6 +43,8 @@ namespace Content.Shared.GameObjects.Components.Mobs.State
|
||||
[ViewVariables]
|
||||
public int? CurrentThreshold { get; private set; }
|
||||
|
||||
public IEnumerable<KeyValuePair<int, IMobState>> _highestToLowestStates => _lowestToHighestStates.Reverse();
|
||||
|
||||
public override void ExposeData(ObjectSerializer serializer)
|
||||
{
|
||||
base.ExposeData(serializer);
|
||||
@@ -175,16 +177,12 @@ namespace Content.Shared.GameObjects.Components.Mobs.State
|
||||
return true;
|
||||
}
|
||||
|
||||
public (IMobState state, int threshold)? GetEarliestIncapacitatedState(int minimumDamage)
|
||||
private (IMobState state, int threshold)? GetEarliestState(int minimumDamage, Predicate<IMobState> predicate)
|
||||
{
|
||||
foreach (var (threshold, state) in _lowestToHighestStates)
|
||||
{
|
||||
if (!state.IsIncapacitated())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (threshold < minimumDamage)
|
||||
if (threshold < minimumDamage ||
|
||||
!predicate(state))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
@@ -195,6 +193,68 @@ namespace Content.Shared.GameObjects.Components.Mobs.State
|
||||
return null;
|
||||
}
|
||||
|
||||
private (IMobState state, int threshold)? GetPreviousState(int maximumDamage, Predicate<IMobState> predicate)
|
||||
{
|
||||
foreach (var (threshold, state) in _highestToLowestStates)
|
||||
{
|
||||
if (threshold > maximumDamage ||
|
||||
!predicate(state))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
return (state, threshold);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
public (IMobState state, int threshold)? GetEarliestCriticalState(int minimumDamage)
|
||||
{
|
||||
return GetEarliestState(minimumDamage, s => s.IsCritical());
|
||||
}
|
||||
|
||||
public (IMobState state, int threshold)? GetEarliestIncapacitatedState(int minimumDamage)
|
||||
{
|
||||
return GetEarliestState(minimumDamage, s => s.IsIncapacitated());
|
||||
}
|
||||
|
||||
public (IMobState state, int threshold)? GetEarliestDeadState(int minimumDamage)
|
||||
{
|
||||
return GetEarliestState(minimumDamage, s => s.IsDead());
|
||||
}
|
||||
|
||||
public (IMobState state, int threshold)? GetPreviousCriticalState(int minimumDamage)
|
||||
{
|
||||
return GetPreviousState(minimumDamage, s => s.IsCritical());
|
||||
}
|
||||
|
||||
private bool TryGetState(
|
||||
(IMobState state, int threshold)? tuple,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold)
|
||||
{
|
||||
if (tuple == null)
|
||||
{
|
||||
state = default;
|
||||
threshold = default;
|
||||
return false;
|
||||
}
|
||||
|
||||
(state, threshold) = tuple.Value;
|
||||
return true;
|
||||
}
|
||||
|
||||
public bool TryGetEarliestCriticalState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold)
|
||||
{
|
||||
var earliestState = GetEarliestCriticalState(minimumDamage);
|
||||
|
||||
return TryGetState(earliestState, out state, out threshold);
|
||||
}
|
||||
|
||||
public bool TryGetEarliestIncapacitatedState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
@@ -202,15 +262,27 @@ namespace Content.Shared.GameObjects.Components.Mobs.State
|
||||
{
|
||||
var earliestState = GetEarliestIncapacitatedState(minimumDamage);
|
||||
|
||||
if (earliestState == null)
|
||||
{
|
||||
state = default;
|
||||
threshold = default;
|
||||
return false;
|
||||
}
|
||||
return TryGetState(earliestState, out state, out threshold);
|
||||
}
|
||||
|
||||
(state, threshold) = earliestState.Value;
|
||||
return true;
|
||||
public bool TryGetEarliestDeadState(
|
||||
int minimumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold)
|
||||
{
|
||||
var earliestState = GetEarliestDeadState(minimumDamage);
|
||||
|
||||
return TryGetState(earliestState, out state, out threshold);
|
||||
}
|
||||
|
||||
public bool TryGetPreviousCriticalState(
|
||||
int maximumDamage,
|
||||
[NotNullWhen(true)] out IMobState? state,
|
||||
out int threshold)
|
||||
{
|
||||
var earliestState = GetPreviousCriticalState(maximumDamage);
|
||||
|
||||
return TryGetState(earliestState, out state, out threshold);
|
||||
}
|
||||
|
||||
private void RemoveState(bool syncing = false)
|
||||
|
||||
BIN
Resources/Textures/Interface/Misc/health_bar.rsi/icon.png
Normal file
BIN
Resources/Textures/Interface/Misc/health_bar.rsi/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
14
Resources/Textures/Interface/Misc/health_bar.rsi/meta.json
Normal file
14
Resources/Textures/Interface/Misc/health_bar.rsi/meta.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"version": 1,
|
||||
"size": {
|
||||
"x": 7,
|
||||
"y": 24
|
||||
},
|
||||
"license": "CC-BY-SA-3.0",
|
||||
"copyright": "https://github.com/tgstation/tgstation/blob/886ca0f8dddf83ecaf10c92ff106172722352192/icons/effects/progessbar.dmi",
|
||||
"states": [
|
||||
{
|
||||
"name": "icon"
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user