Power monitoring console overhaul (#20927)
* Prototyping whole station wire map * More prototyping * Added icons for the different power distributors and toggleable cable displays * Power cable layouts are now only sent to the client when the power monitor is open * UI prototyping * Power monitors can now see the sprites of distant entities, long entity names are truncated * Updated how network devices are added to the player's PVS * More feature prototypes * Added source / load symbols * Final prototype! Time to actually code it properly... * Start of code clean up * Continuing code clean up * Fixed UI appearance * Code clean up complete * Removed unnecessary changes * Updated how power values are calculated, added UI warnings for power sinks and power net checks * Updated how power values are calculated again, added support for portable generators * Removed unnecessary files * Map beacons start toggled off, console map now works outside the station, fixed substation icon * Made some of Sloth's requested changes. Power distributors don't blink anymore, unless selected * Moved a number of static variables in PowerMonitoringHelper to sensible places in the main files. Added a NavMapTrackableComponent so that you can specify how individual entities appear on the navmap * Updated the colors/positions of HV cables and SMESes to improve contrast * Fixed SMES color in map legend * Partially fixed auto-scrolling on device selection, made sublists alphabetical * Changed how auto-scroll is handled * Changed the font color of the console warning messages * Reduced the font size of beacon labels * Added the station name to the console * Organized references * Removed unwanted changes to RobustToolbox * Fix merge conflict * Fix merge conflict, maybe * Fix merge conflict * Updated outdated reference * Fixed portable_generator.yml * Implemented a number of requested changes, move bit masks to a shared component * Navigate listings via the navmap * First attempt at improving efficiency * Second attempt at optimization, entity grouping added for solar panels * Finished solar panel entity joining * Finished major revisions, code clean up needed * Finializing optimizations * Made requested changes * Bug fix, removed obsolete code * Bug fixes * Bug fixes * STarted revisions * Further revisions * More revision * Finalizing revisions. Need to make RT PR * Code tidying * More code tidying * Trying to avoid merge conflicts * Trying to avoid merge conflicts * Removed use of PVS * Improving efficiency * Addressed a bunch of outstanding issues * Clear old data on console refresh * UI adjustments * Made node comparison more robust. More devices can be combined into one entry * Added missing component 'dirty'
This commit is contained in:
chromiumboy
@@ -1,84 +1,317 @@
|
||||
using System.Linq;
|
||||
using System.Numerics;
|
||||
using Content.Client.Computer;
|
||||
using Content.Client.Pinpointer.UI;
|
||||
using Content.Client.UserInterface.Controls;
|
||||
using Content.Shared.Power;
|
||||
using JetBrains.Annotations;
|
||||
using Robust.Client.AutoGenerated;
|
||||
using Robust.Client.GameObjects;
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Client.UserInterface.Controls;
|
||||
using Robust.Client.UserInterface.CustomControls;
|
||||
using Robust.Client.UserInterface.XAML;
|
||||
using Robust.Shared.Graphics;
|
||||
using Robust.Shared.Graphics.RSI;
|
||||
using Robust.Shared.Prototypes;
|
||||
using Robust.Shared.Map;
|
||||
using Robust.Shared.Timing;
|
||||
using Robust.Shared.Utility;
|
||||
using System.Linq;
|
||||
|
||||
namespace Content.Client.Power;
|
||||
|
||||
[GenerateTypedNameReferences]
|
||||
public sealed partial class PowerMonitoringWindow : DefaultWindow, IComputerWindow<PowerMonitoringConsoleBoundInterfaceState>
|
||||
public sealed partial class PowerMonitoringWindow : FancyWindow
|
||||
{
|
||||
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
|
||||
private readonly SpriteSystem _spriteSystem = default!;
|
||||
private readonly IEntityManager _entManager;
|
||||
private readonly SpriteSystem _spriteSystem;
|
||||
private readonly IGameTiming _gameTiming;
|
||||
|
||||
public PowerMonitoringWindow()
|
||||
private const float BlinkFrequency = 1f;
|
||||
|
||||
private EntityUid? _owner;
|
||||
private NetEntity? _focusEntity;
|
||||
|
||||
public event Action<NetEntity?, PowerMonitoringConsoleGroup>? SendPowerMonitoringConsoleMessageAction;
|
||||
|
||||
private Dictionary<PowerMonitoringConsoleGroup, (SpriteSpecifier.Texture, Color)> _groupBlips = new()
|
||||
{
|
||||
{ PowerMonitoringConsoleGroup.Generator, (new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/NavMap/beveled_circle.png")), Color.Purple) },
|
||||
{ PowerMonitoringConsoleGroup.SMES, (new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/NavMap/beveled_hexagon.png")), Color.OrangeRed) },
|
||||
{ PowerMonitoringConsoleGroup.Substation, (new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/NavMap/beveled_square.png")), Color.Yellow) },
|
||||
{ PowerMonitoringConsoleGroup.APC, (new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/NavMap/beveled_triangle.png")), Color.LimeGreen) },
|
||||
};
|
||||
|
||||
public PowerMonitoringWindow(PowerMonitoringConsoleBoundUserInterface userInterface, EntityUid? owner)
|
||||
{
|
||||
RobustXamlLoader.Load(this);
|
||||
SetSize = MinSize = new Vector2(300, 450);
|
||||
IoCManager.InjectDependencies(this);
|
||||
_spriteSystem = IoCManager.Resolve<IEntityManager>().System<SpriteSystem>();
|
||||
MasterTabContainer.SetTabTitle(0, Loc.GetString("power-monitoring-window-tab-sources"));
|
||||
MasterTabContainer.SetTabTitle(1, Loc.GetString("power-monitoring-window-tab-loads"));
|
||||
_entManager = IoCManager.Resolve<IEntityManager>();
|
||||
_gameTiming = IoCManager.Resolve<IGameTiming>();
|
||||
|
||||
_spriteSystem = _entManager.System<SpriteSystem>();
|
||||
_owner = owner;
|
||||
|
||||
// Pass owner to nav map
|
||||
NavMap.Owner = _owner;
|
||||
|
||||
// Set nav map grid uid
|
||||
var stationName = Loc.GetString("power-monitoring-window-unknown-location");
|
||||
|
||||
if (_entManager.TryGetComponent<TransformComponent>(owner, out var xform))
|
||||
{
|
||||
NavMap.MapUid = xform.GridUid;
|
||||
|
||||
// Assign station name
|
||||
if (_entManager.TryGetComponent<MetaDataComponent>(xform.GridUid, out var stationMetaData))
|
||||
stationName = stationMetaData.EntityName;
|
||||
|
||||
var msg = new FormattedMessage();
|
||||
msg.AddMarkup(Loc.GetString("power-monitoring-window-station-name", ("stationName", stationName)));
|
||||
|
||||
StationName.SetMessage(msg);
|
||||
}
|
||||
|
||||
else
|
||||
{
|
||||
StationName.SetMessage(stationName);
|
||||
NavMap.Visible = false;
|
||||
}
|
||||
|
||||
// Set trackable entity selected action
|
||||
NavMap.TrackedEntitySelectedAction += SetTrackedEntityFromNavMap;
|
||||
|
||||
// Update nav map
|
||||
NavMap.ForceNavMapUpdate();
|
||||
|
||||
// Set UI tab titles
|
||||
MasterTabContainer.SetTabTitle(0, Loc.GetString("power-monitoring-window-label-sources"));
|
||||
MasterTabContainer.SetTabTitle(1, Loc.GetString("power-monitoring-window-label-smes"));
|
||||
MasterTabContainer.SetTabTitle(2, Loc.GetString("power-monitoring-window-label-substation"));
|
||||
MasterTabContainer.SetTabTitle(3, Loc.GetString("power-monitoring-window-label-apc"));
|
||||
|
||||
// Track when the MasterTabContainer changes its tab
|
||||
MasterTabContainer.OnTabChanged += OnTabChanged;
|
||||
|
||||
// Set UI toggles
|
||||
ShowHVCable.OnToggled += _ => OnShowCableToggled(PowerMonitoringConsoleLineGroup.HighVoltage);
|
||||
ShowMVCable.OnToggled += _ => OnShowCableToggled(PowerMonitoringConsoleLineGroup.MediumVoltage);
|
||||
ShowLVCable.OnToggled += _ => OnShowCableToggled(PowerMonitoringConsoleLineGroup.Apc);
|
||||
|
||||
// Set power monitoring message action
|
||||
SendPowerMonitoringConsoleMessageAction += userInterface.SendPowerMonitoringConsoleMessage;
|
||||
}
|
||||
|
||||
public void UpdateState(PowerMonitoringConsoleBoundInterfaceState scc)
|
||||
private void OnTabChanged(int tab)
|
||||
{
|
||||
UpdateList(TotalSourcesNum, scc.TotalSources, SourcesList, scc.Sources);
|
||||
var loads = scc.Loads;
|
||||
if (!ShowInactiveConsumersCheckBox.Pressed)
|
||||
{
|
||||
// Not showing inactive consumers, so hiding them.
|
||||
// This means filtering out loads that are not either:
|
||||
// + Batteries (always important)
|
||||
// + Meaningful (size above 0)
|
||||
loads = loads.Where(a => a.IsBattery || a.Size > 0.0f).ToArray();
|
||||
}
|
||||
UpdateList(TotalLoadsNum, scc.TotalLoads, LoadsList, loads);
|
||||
SendPowerMonitoringConsoleMessageAction?.Invoke(_focusEntity, (PowerMonitoringConsoleGroup) tab);
|
||||
}
|
||||
|
||||
public void UpdateList(Label number, double numberVal, ItemList list, PowerMonitoringConsoleEntry[] listVal)
|
||||
private void OnShowCableToggled(PowerMonitoringConsoleLineGroup lineGroup)
|
||||
{
|
||||
number.Text = Loc.GetString("power-monitoring-window-value", ("value", numberVal));
|
||||
// This magic is important to prevent scrolling issues.
|
||||
while (list.Count > listVal.Length)
|
||||
if (!NavMap.HiddenLineGroups.Remove(lineGroup))
|
||||
NavMap.HiddenLineGroups.Add(lineGroup);
|
||||
}
|
||||
|
||||
public void ShowEntites
|
||||
(double totalSources,
|
||||
double totalBatteryUsage,
|
||||
double totalLoads,
|
||||
PowerMonitoringConsoleEntry[] allEntries,
|
||||
PowerMonitoringConsoleEntry[] focusSources,
|
||||
PowerMonitoringConsoleEntry[] focusLoads,
|
||||
EntityCoordinates? monitorCoords)
|
||||
{
|
||||
if (_owner == null)
|
||||
return;
|
||||
|
||||
if (!_entManager.TryGetComponent<PowerMonitoringConsoleComponent>(_owner.Value, out var console))
|
||||
return;
|
||||
|
||||
// Update power status text
|
||||
TotalSources.Text = Loc.GetString("power-monitoring-window-value", ("value", totalSources));
|
||||
TotalBatteryUsage.Text = Loc.GetString("power-monitoring-window-value", ("value", totalBatteryUsage));
|
||||
TotalLoads.Text = Loc.GetString("power-monitoring-window-value", ("value", totalLoads));
|
||||
|
||||
// 10+% of station power is being drawn from batteries
|
||||
TotalBatteryUsage.FontColorOverride = (totalSources * 0.1111f) < totalBatteryUsage ? new Color(180, 0, 0) : Color.White;
|
||||
|
||||
// Station generator and battery output is less than the current demand
|
||||
TotalLoads.FontColorOverride = (totalSources + totalBatteryUsage) < totalLoads &&
|
||||
!MathHelper.CloseToPercent(totalSources + totalBatteryUsage, totalLoads, 0.1f) ? new Color(180, 0, 0) : Color.White;
|
||||
|
||||
// Update system warnings
|
||||
UpdateWarningLabel(console.Flags);
|
||||
|
||||
// Reset nav map values
|
||||
NavMap.TrackedCoordinates.Clear();
|
||||
NavMap.TrackedEntities.Clear();
|
||||
|
||||
// Draw entities on the nav map
|
||||
var entitiesOfInterest = new List<NetEntity>();
|
||||
|
||||
if (_focusEntity != null)
|
||||
{
|
||||
list.RemoveAt(list.Count - 1);
|
||||
entitiesOfInterest.Add(_focusEntity.Value);
|
||||
|
||||
foreach (var entry in focusSources)
|
||||
entitiesOfInterest.Add(entry.NetEntity);
|
||||
|
||||
foreach (var entry in focusLoads)
|
||||
entitiesOfInterest.Add(entry.NetEntity);
|
||||
}
|
||||
while (list.Count < listVal.Length)
|
||||
|
||||
focusSources.Concat(focusLoads);
|
||||
|
||||
foreach ((var netEntity, var metaData) in console.PowerMonitoringDeviceMetaData)
|
||||
{
|
||||
list.AddItem("YOU SHOULD NEVER SEE THIS (REALLY!)", null, false);
|
||||
if (NavMap.Visible)
|
||||
AddTrackedEntityToNavMap(netEntity, metaData, entitiesOfInterest);
|
||||
}
|
||||
// Now overwrite the items properly...
|
||||
for (var i = 0; i < listVal.Length; i++)
|
||||
|
||||
// Show monitor location
|
||||
var mon = _entManager.GetNetEntity(_owner);
|
||||
|
||||
if (monitorCoords != null && mon != null)
|
||||
{
|
||||
var ent = listVal[i];
|
||||
_prototypeManager.TryIndex(ent.IconEntityPrototypeId, out EntityPrototype? entityPrototype);
|
||||
IRsiStateLike? iconState = null;
|
||||
if (entityPrototype != null)
|
||||
iconState = _spriteSystem.GetPrototypeIcon(entityPrototype);
|
||||
var icon = iconState?.GetFrame(RsiDirection.South, 0);
|
||||
var item = list[i];
|
||||
item.Text = $"{ent.NameLocalized} {Loc.GetString("power-monitoring-window-value", ("value", ent.Size))}";
|
||||
item.Icon = icon;
|
||||
var texture = _spriteSystem.Frame0(new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/NavMap/beveled_circle.png")));
|
||||
var blip = new NavMapBlip(monitorCoords.Value, texture, Color.Cyan, true, false);
|
||||
NavMap.TrackedEntities[mon.Value] = blip;
|
||||
}
|
||||
|
||||
// Update nav map
|
||||
NavMap.ForceNavMapUpdate();
|
||||
|
||||
// If the entry group doesn't match the current tab, the data is out dated, do not use it
|
||||
if (allEntries.Length > 0 && allEntries[0].Group != GetCurrentPowerMonitoringConsoleGroup())
|
||||
return;
|
||||
|
||||
// Assign meta data to the console entries and sort them
|
||||
allEntries = GetUpdatedPowerMonitoringConsoleEntries(allEntries, console);
|
||||
focusSources = GetUpdatedPowerMonitoringConsoleEntries(focusSources, console);
|
||||
focusLoads = GetUpdatedPowerMonitoringConsoleEntries(focusLoads, console);
|
||||
|
||||
// Get current console entry container
|
||||
BoxContainer currentContainer = SourcesList;
|
||||
switch (GetCurrentPowerMonitoringConsoleGroup())
|
||||
{
|
||||
case PowerMonitoringConsoleGroup.SMES:
|
||||
currentContainer = SMESList; break;
|
||||
case PowerMonitoringConsoleGroup.Substation:
|
||||
currentContainer = SubstationList; break;
|
||||
case PowerMonitoringConsoleGroup.APC:
|
||||
currentContainer = ApcList; break;
|
||||
}
|
||||
|
||||
// Clear excess children from the container
|
||||
while (currentContainer.ChildCount > allEntries.Length)
|
||||
currentContainer.RemoveChild(currentContainer.GetChild(currentContainer.ChildCount - 1));
|
||||
|
||||
// Update the remaining children
|
||||
for (var index = 0; index < allEntries.Length; index++)
|
||||
{
|
||||
var entry = allEntries[index];
|
||||
|
||||
if (entry.NetEntity == _focusEntity)
|
||||
UpdateWindowConsoleEntry(currentContainer, index, entry, focusSources, focusLoads);
|
||||
|
||||
else
|
||||
UpdateWindowConsoleEntry(currentContainer, index, entry);
|
||||
}
|
||||
|
||||
// Auto-scroll renable
|
||||
if (_autoScrollAwaitsUpdate)
|
||||
{
|
||||
_autoScrollActive = true;
|
||||
_autoScrollAwaitsUpdate = false;
|
||||
}
|
||||
}
|
||||
|
||||
private void AddTrackedEntityToNavMap(NetEntity netEntity, PowerMonitoringDeviceMetaData metaData, List<NetEntity> entitiesOfInterest)
|
||||
{
|
||||
if (!_groupBlips.TryGetValue(metaData.Group, out var data))
|
||||
return;
|
||||
|
||||
var usedEntity = (metaData.CollectionMaster != null) ? metaData.CollectionMaster : netEntity;
|
||||
var coords = _entManager.GetCoordinates(metaData.Coordinates);
|
||||
var texture = data.Item1;
|
||||
var color = data.Item2;
|
||||
var blink = usedEntity == _focusEntity;
|
||||
var modulator = Color.White;
|
||||
|
||||
if (_focusEntity != null && usedEntity != _focusEntity && !entitiesOfInterest.Contains(usedEntity.Value))
|
||||
modulator = Color.DimGray;
|
||||
|
||||
var blip = new NavMapBlip(coords, _spriteSystem.Frame0(texture), color * modulator, blink);
|
||||
NavMap.TrackedEntities[netEntity] = blip;
|
||||
}
|
||||
|
||||
private void SetTrackedEntityFromNavMap(NetEntity? netEntity)
|
||||
{
|
||||
if (netEntity == null)
|
||||
return;
|
||||
|
||||
if (!_entManager.TryGetComponent<PowerMonitoringConsoleComponent>(_owner, out var console))
|
||||
return;
|
||||
|
||||
if (!console.PowerMonitoringDeviceMetaData.TryGetValue(netEntity.Value, out var metaData))
|
||||
return;
|
||||
|
||||
// Switch entity for master, if applicable
|
||||
// The master will always be in the same group as the entity
|
||||
if (metaData.CollectionMaster != null)
|
||||
netEntity = metaData.CollectionMaster;
|
||||
|
||||
_focusEntity = netEntity;
|
||||
|
||||
// Switch tabs
|
||||
SwitchTabsBasedOnPowerMonitoringConsoleGroup(metaData.Group);
|
||||
|
||||
// Get the scroll position of the selected entity on the selected button the UI
|
||||
ActivateAutoScrollToFocus();
|
||||
|
||||
// Send message to console that the focus has changed
|
||||
SendPowerMonitoringConsoleMessageAction?.Invoke(_focusEntity, metaData.Group);
|
||||
}
|
||||
|
||||
protected override void FrameUpdate(FrameEventArgs args)
|
||||
{
|
||||
AutoScrollToFocus();
|
||||
|
||||
// Warning sign pulse
|
||||
var lit = _gameTiming.RealTime.TotalSeconds % BlinkFrequency > BlinkFrequency / 2f;
|
||||
SystemWarningPanel.Modulate = lit ? Color.White : new Color(178, 178, 178);
|
||||
}
|
||||
|
||||
private PowerMonitoringConsoleEntry[] GetUpdatedPowerMonitoringConsoleEntries(PowerMonitoringConsoleEntry[] entries, PowerMonitoringConsoleComponent console)
|
||||
{
|
||||
for (int i = 0; i < entries.Length; i++)
|
||||
{
|
||||
var entry = entries[i];
|
||||
|
||||
if (!console.PowerMonitoringDeviceMetaData.TryGetValue(entry.NetEntity, out var metaData))
|
||||
continue;
|
||||
|
||||
entries[i].MetaData = metaData;
|
||||
}
|
||||
|
||||
// Sort all devices alphabetically by their entity name (not by power usage; otherwise their position on the UI will shift)
|
||||
Array.Sort(entries, AlphabeticalSort);
|
||||
|
||||
return entries;
|
||||
}
|
||||
|
||||
private int AlphabeticalSort(PowerMonitoringConsoleEntry x, PowerMonitoringConsoleEntry y)
|
||||
{
|
||||
if (x.MetaData?.EntityName == null)
|
||||
return -1;
|
||||
|
||||
if (y.MetaData?.EntityName == null)
|
||||
return 1;
|
||||
|
||||
return x.MetaData.Value.EntityName.CompareTo(y.MetaData.Value.EntityName);
|
||||
}
|
||||
}
|
||||
|
||||
[UsedImplicitly]
|
||||
public sealed class PowerMonitoringConsoleBoundUserInterface : ComputerBoundUserInterface<PowerMonitoringWindow, PowerMonitoringConsoleBoundInterfaceState>
|
||||
public struct PowerMonitoringConsoleTrackable
|
||||
{
|
||||
public PowerMonitoringConsoleBoundUserInterface(EntityUid owner, Enum uiKey) : base(owner, uiKey)
|
||||
public EntityUid EntityUid;
|
||||
public PowerMonitoringConsoleGroup Group;
|
||||
|
||||
public PowerMonitoringConsoleTrackable(EntityUid uid, PowerMonitoringConsoleGroup group)
|
||||
{
|
||||
EntityUid = uid;
|
||||
Group = group;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user