tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update UIControllers to use Log (#37792)

Browse Source 
Update UIControllers to use Log
This commit is contained in:
Tayrtahn
2025-05-28 12:50:31 -04:00
committed by GitHub
parent 721d224fd7
commit a9f7cfbcb6
10 changed files with 16 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Content.Client/ContextMenu/UI/ContextMenuUIController.cs
View File

@@ -131,7 +131,7 @@ namespace Content.Client.ContextMenu.UI
{ {
if (!Menus.TryPeek(out var topMenu)) if (!Menus.TryPeek(out var topMenu))
{ {
Logger.Error("Context Menu: Mouse entered menu without any open menus?"); Log.Error("Context Menu: Mouse entered menu without any open menus?");
return; return;
} }
@@ -181,7 +181,7 @@ namespace Content.Client.ContextMenu.UI
{ {
if (!Menus.TryPeek(out var topMenu)) if (!Menus.TryPeek(out var topMenu))
{ {
Logger.Error("Context Menu: Attempting to open sub menu without any open menus?"); Log.Error("Context Menu: Attempting to open sub menu without any open menus?");
return; return;
} }

2
Content.Client/ContextMenu/UI/EntityMenuUIController.cs
View File

@@ -306,7 +306,7 @@ namespace Content.Client.ContextMenu.UI
// find the element associated with this entity // find the element associated with this entity
if (!Elements.TryGetValue(entity, out var element)) if (!Elements.TryGetValue(entity, out var element))
{ {
Logger.Error($"Attempted to remove unknown entity from the entity menu: {_entityManager.GetComponent<MetaDataComponent>(entity).EntityName} ({entity})"); Log.Error($"Attempted to remove unknown entity from the entity menu: {_entityManager.GetComponent<MetaDataComponent>(entity).EntityName} ({entity})");
return; return;
} }

3
Content.Client/Lobby/LobbyUIController.cs
View File

@@ -32,7 +32,6 @@ public sealed class LobbyUIController : UIController, IOnStateEntered<LobbyState
[Dependency] private readonly IClientPreferencesManager _preferencesManager = default!; [Dependency] private readonly IClientPreferencesManager _preferencesManager = default!;
[Dependency] private readonly IConfigurationManager _configurationManager = default!; [Dependency] private readonly IConfigurationManager _configurationManager = default!;
[Dependency] private readonly IFileDialogManager _dialogManager = default!; [Dependency] private readonly IFileDialogManager _dialogManager = default!;
[Dependency] private readonly ILogManager _logManager = default!;
[Dependency] private readonly IPlayerManager _playerManager = default!; [Dependency] private readonly IPlayerManager _playerManager = default!;
[Dependency] private readonly IPrototypeManager _prototypeManager = default!; [Dependency] private readonly IPrototypeManager _prototypeManager = default!;
[Dependency] private readonly IResourceCache _resourceCache = default!; [Dependency] private readonly IResourceCache _resourceCache = default!;
@@ -269,7 +268,7 @@ public sealed class LobbyUIController : UIController, IOnStateEntered<LobbyState
_configurationManager, _configurationManager,
EntityManager, EntityManager,
_dialogManager, _dialogManager,
_logManager, LogManager,
_playerManager, _playerManager,
_prototypeManager, _prototypeManager,
_resourceCache, _resourceCache,

2
Content.Client/UserInterface/Systems/Actions/ActionUIController.cs
View File

@@ -192,7 +192,7 @@ public sealed class ActionUIController : UIController, IOnStateChanged<GameplayS
return TryTargetEntityWorld(args, actionId, entMapTarget, user, comp) || !entMapTarget.InteractOnMiss; return TryTargetEntityWorld(args, actionId, entMapTarget, user, comp) || !entMapTarget.InteractOnMiss;
default: default:
Logger.Error($"Unknown targeting action: {actionId.GetType()}"); Log.Error($"Unknown targeting action: {actionId.GetType()}");
return false; return false;
} }
} }

4
Content.Client/UserInterface/Systems/Bwoink/AHelpUIController.cs
View File

@@ -48,6 +48,8 @@ public sealed class AHelpUIController: UIController, IOnSystemChanged<BwoinkSyst
private bool _bwoinkSoundEnabled; private bool _bwoinkSoundEnabled;
private string? _aHelpSound; private string? _aHelpSound;
protected override string SawmillName => "c.s.go.es.bwoink";
public override void Initialize() public override void Initialize()
{ {
base.Initialize(); base.Initialize();
@@ -129,7 +131,7 @@ public sealed class AHelpUIController: UIController, IOnSystemChanged<BwoinkSyst
private void ReceivedBwoink(object? sender, SharedBwoinkSystem.BwoinkTextMessage message) private void ReceivedBwoink(object? sender, SharedBwoinkSystem.BwoinkTextMessage message)
{ {
Logger.InfoS("c.s.go.es.bwoink", $"@{message.UserId}: {message.Text}"); Log.Info($"@{message.UserId}: {message.Text}");
var localPlayer = _playerManager.LocalSession; var localPlayer = _playerManager.LocalSession;
if (localPlayer == null) if (localPlayer == null)
{ {

7
Content.Client/UserInterface/Systems/Character/CharacterUIController.cs
View File

@@ -28,21 +28,16 @@ namespace Content.Client.UserInterface.Systems.Character;
public sealed class CharacterUIController : UIController, IOnStateEntered<GameplayState>, IOnStateExited<GameplayState>, IOnSystemChanged<CharacterInfoSystem> public sealed class CharacterUIController : UIController, IOnStateEntered<GameplayState>, IOnStateExited<GameplayState>, IOnSystemChanged<CharacterInfoSystem>
{ {
[Dependency] private readonly IEntityManager _ent = default!; [Dependency] private readonly IEntityManager _ent = default!;
[Dependency] private readonly ILogManager _logMan = default!;
[Dependency] private readonly IPlayerManager _player = default!; [Dependency] private readonly IPlayerManager _player = default!;
[Dependency] private readonly IPrototypeManager _prototypeManager = default!; [Dependency] private readonly IPrototypeManager _prototypeManager = default!;
[UISystemDependency] private readonly CharacterInfoSystem _characterInfo = default!; [UISystemDependency] private readonly CharacterInfoSystem _characterInfo = default!;
[UISystemDependency] private readonly SpriteSystem _sprite = default!; [UISystemDependency] private readonly SpriteSystem _sprite = default!;
private ISawmill _sawmill = default!;
public override void Initialize() public override void Initialize()
{ {
base.Initialize(); base.Initialize();
_sawmill = _logMan.GetSawmill("character");
SubscribeNetworkEvent<MindRoleTypeChangedEvent>(OnRoleTypeChanged); SubscribeNetworkEvent<MindRoleTypeChangedEvent>(OnRoleTypeChanged);
} }
@@ -222,7 +217,7 @@ public sealed class CharacterUIController : UIController, IOnStateEntered<Gamepl
return; return;
if (!_prototypeManager.TryIndex(mind.RoleType, out var proto)) if (!_prototypeManager.TryIndex(mind.RoleType, out var proto))
_sawmill.Error($"Player '{_player.LocalSession}' has invalid Role Type '{mind.RoleType}'. Displaying default instead"); Log.Error($"Player '{_player.LocalSession}' has invalid Role Type '{mind.RoleType}'. Displaying default instead");
_window.RoleType.Text = Loc.GetString(proto?.Name ?? "role-type-crew-aligned-name"); _window.RoleType.Text = Loc.GetString(proto?.Name ?? "role-type-crew-aligned-name");
_window.RoleType.FontColorOverride = proto?.Color ?? Color.White; _window.RoleType.FontColorOverride = proto?.Color ?? Color.White;

4
Content.Client/UserInterface/Systems/Guidebook/GuidebookUIController.cs
View File

@@ -227,7 +227,7 @@ public sealed class GuidebookUIController : UIController, IOnStateEntered<LobbyS
{ {
if (!_prototypeManager.TryIndex(guideId, out var guide)) if (!_prototypeManager.TryIndex(guideId, out var guide))
{ {
Logger.Error($"Encountered unknown guide prototype: {guideId}"); Log.Error($"Encountered unknown guide prototype: {guideId}");
continue; continue;
} }
guides.Add(guideId, guide); guides.Add(guideId, guide);
@@ -257,7 +257,7 @@ public sealed class GuidebookUIController : UIController, IOnStateEntered<LobbyS
if (!_prototypeManager.TryIndex(childId, out var child)) if (!_prototypeManager.TryIndex(childId, out var child))
{ {
Logger.Error($"Encountered unknown guide prototype: {childId} as a child of {guide.Id}. If the child is not a prototype, it must be directly provided."); Log.Error($"Encountered unknown guide prototype: {childId} as a child of {guide.Id}. If the child is not a prototype, it must be directly provided.");
continue; continue;
} }

7
Content.Client/UserInterface/Systems/Info/InfoUIController.cs
View File

@@ -15,22 +15,21 @@ public sealed class InfoUIController : UIController, IOnStateExited<GameplayStat
[Dependency] private readonly IClientConsoleHost _consoleHost = default!; [Dependency] private readonly IClientConsoleHost _consoleHost = default!;
[Dependency] private readonly INetManager _netManager = default!; [Dependency] private readonly INetManager _netManager = default!;
[Dependency] private readonly IPrototypeManager _prototype = default!; [Dependency] private readonly IPrototypeManager _prototype = default!;
[Dependency] private readonly ILogManager _logMan = default!;
private RulesPopup? _rulesPopup; private RulesPopup? _rulesPopup;
private RulesAndInfoWindow? _infoWindow; private RulesAndInfoWindow? _infoWindow;
private ISawmill _sawmill = default!;
[ValidatePrototypeId<GuideEntryPrototype>] [ValidatePrototypeId<GuideEntryPrototype>]
private const string DefaultRuleset = "DefaultRuleset"; private const string DefaultRuleset = "DefaultRuleset";
public ProtoId<GuideEntryPrototype> RulesEntryId = DefaultRuleset; public ProtoId<GuideEntryPrototype> RulesEntryId = DefaultRuleset;
protected override string SawmillName => "rules";
public override void Initialize() public override void Initialize()
{ {
base.Initialize(); base.Initialize();
_sawmill = _logMan.GetSawmill("rules");
_netManager.RegisterNetMessage<RulesAcceptedMessage>(); _netManager.RegisterNetMessage<RulesAcceptedMessage>();
_netManager.RegisterNetMessage<SendRulesInformationMessage>(OnRulesInformationMessage); _netManager.RegisterNetMessage<SendRulesInformationMessage>(OnRulesInformationMessage);
@@ -94,7 +93,7 @@ public sealed class InfoUIController : UIController, IOnStateExited<GameplayStat
if (!_prototype.TryIndex(RulesEntryId, out var guideEntryPrototype)) if (!_prototype.TryIndex(RulesEntryId, out var guideEntryPrototype))
{ {
guideEntryPrototype = _prototype.Index<GuideEntryPrototype>(DefaultRuleset); guideEntryPrototype = _prototype.Index<GuideEntryPrototype>(DefaultRuleset);
_sawmill.Error($"Couldn't find the following prototype: {RulesEntryId}. Falling back to {DefaultRuleset}, please check that the server has the rules set up correctly"); Log.Error($"Couldn't find the following prototype: {RulesEntryId}. Falling back to {DefaultRuleset}, please check that the server has the rules set up correctly");
return guideEntryPrototype; return guideEntryPrototype;
} }

2
Content.Client/UserInterface/Systems/Inventory/InventoryUIController.cs
View File

@@ -243,7 +243,7 @@ public sealed class InventoryUIController : UIController, IOnStateEntered<Gamepl
{ {
if (_inventoryHotbar == null) if (_inventoryHotbar == null)
{ {
Logger.Warning("Tried to toggle inventory bar when none are assigned"); Log.Warning("Tried to toggle inventory bar when none are assigned");
return; return;
} }

2
Content.Client/UserInterface/Systems/Viewport/ViewportUIController.cs
View File

@@ -102,6 +102,6 @@ public sealed class ViewportUIController : UIController
// Currently, this shouldn't happen. This likely happened because the main eye was set to null. When this // Currently, this shouldn't happen. This likely happened because the main eye was set to null. When this
// does happen it can create hard to troubleshoot bugs, so lets print some helpful warnings: // does happen it can create hard to troubleshoot bugs, so lets print some helpful warnings:
Logger.Warning($"Main viewport's eye is in nullspace (main eye is null?). Attached entity: {_entMan.ToPrettyString(ent.Value)}. Entity has eye comp: {eye != null}"); Log.Warning($"Main viewport's eye is in nullspace (main eye is null?). Attached entity: {_entMan.ToPrettyString(ent.Value)}. Entity has eye comp: {eye != null}");
} }
} }