Update 11/25/2024

Content.Client/Administration/UI/Bwoink/BwoinkWindow.xaml.cs

@@ -16,18 +16,25 @@ public BwoinkWindow()
 
             Bwoink.ChannelSelector.OnSelectionChanged += sel =>
             {
-                if (sel is not null)
+                if (sel is null)
                 {
-                    Title = $"{sel.CharacterName} / {sel.Username}";
+                    Title = Loc.GetString("bwoink-none-selected");
+                    return;
+                }
+
+                Title = $"{sel.CharacterName} / {sel.Username}";
 
-                    if (sel.OverallPlaytime != null)
-                    {
-                        Title += $" | {Loc.GetString("generic-playtime-title")}: {sel.PlaytimeString}";
-                    }
+                if (sel.OverallPlaytime != null)
+                {
+                    Title += $" | {Loc.GetString("generic-playtime-title")}: {sel.PlaytimeString}";
                 }
             };
 
-            OnOpen += () => Bwoink.PopulateList();
+            OnOpen += () =>
+            {
+                Bwoink.ChannelSelector.StopFiltering();
+                Bwoink.PopulateList();
+            };
         }
     }
 }

Content.Client/Administration/UI/CustomControls/PlayerListControl.xaml.cs

@@ -4,147 +4,155 @@
 using Content.Client.Verbs.UI;
 using Content.Shared.Administration;
 using Robust.Client.AutoGenerated;
+using Robust.Client.GameObjects;
 using Robust.Client.Graphics;
 using Robust.Client.UserInterface;
 using Robust.Client.UserInterface.Controls;
 using Robust.Client.UserInterface.XAML;
 using Robust.Shared.Input;
+using Robust.Shared.Utility;
 
-namespace Content.Client.Administration.UI.CustomControls
+namespace Content.Client.Administration.UI.CustomControls;
+
+[GenerateTypedNameReferences]
+public sealed partial class PlayerListControl : BoxContainer
 {
-    [GenerateTypedNameReferences]
-    public sealed partial class PlayerListControl : BoxContainer
-    {
-        private readonly AdminSystem _adminSystem;
+    private readonly AdminSystem _adminSystem;
 
-        private List<PlayerInfo> _playerList = new();
-        private readonly List<PlayerInfo> _sortedPlayerList = new();
+    private readonly IEntityManager _entManager;
+    private readonly IUserInterfaceManager _uiManager;
+
+    private PlayerInfo? _selectedPlayer;
 
-        public event Action<PlayerInfo>? OnSelectionChanged;
-        public IReadOnlyList<PlayerInfo> PlayerInfo => _playerList;
+    private List<PlayerInfo> _playerList = new();
+    private readonly List<PlayerInfo> _sortedPlayerList = new();
 
-        public Func<PlayerInfo, string, string>? OverrideText;
-        public Comparison<PlayerInfo>? Comparison;
+    public Comparison<PlayerInfo>? Comparison;
+    public Func<PlayerInfo, string, string>? OverrideText;
 
-        private IEntityManager _entManager;
-        private IUserInterfaceManager _uiManager;
+    public PlayerListControl()
+    {
+        _entManager = IoCManager.Resolve<IEntityManager>();
+        _uiManager = IoCManager.Resolve<IUserInterfaceManager>();
+        _adminSystem = _entManager.System<AdminSystem>();
+        RobustXamlLoader.Load(this);
+        // Fill the Option data
+        PlayerListContainer.ItemPressed += PlayerListItemPressed;
+        PlayerListContainer.ItemKeyBindDown += PlayerListItemKeyBindDown;
+        PlayerListContainer.GenerateItem += GenerateButton;
+        PlayerListContainer.NoItemSelected += PlayerListNoItemSelected;
+        PopulateList(_adminSystem.PlayerList);
+        FilterLineEdit.OnTextChanged += _ => FilterList();
+        _adminSystem.PlayerListChanged += PopulateList;
+        BackgroundPanel.PanelOverride = new StyleBoxFlat { BackgroundColor = new Color(32, 32, 40) };
+    }
 
-        private PlayerInfo? _selectedPlayer;
+    public IReadOnlyList<PlayerInfo> PlayerInfo => _playerList;
 
-        public PlayerListControl()
-        {
-            _entManager = IoCManager.Resolve<IEntityManager>();
-            _uiManager = IoCManager.Resolve<IUserInterfaceManager>();
-            _adminSystem = _entManager.System<AdminSystem>();
-            RobustXamlLoader.Load(this);
-            // Fill the Option data
-            PlayerListContainer.ItemPressed += PlayerListItemPressed;
-            PlayerListContainer.ItemKeyBindDown += PlayerListItemKeyBindDown;
-            PlayerListContainer.GenerateItem += GenerateButton;
-            PopulateList(_adminSystem.PlayerList);
-            FilterLineEdit.OnTextChanged += _ => FilterList();
-            _adminSystem.PlayerListChanged += PopulateList;
-            BackgroundPanel.PanelOverride = new StyleBoxFlat {BackgroundColor = new Color(32, 32, 40)};
-        }
+    public event Action<PlayerInfo?>? OnSelectionChanged;
 
-        private void PlayerListItemPressed(BaseButton.ButtonEventArgs? args, ListData? data)
-        {
-            if (args == null || data is not PlayerListData {Info: var selectedPlayer})
-                return;
+    private void PlayerListNoItemSelected()
+    {
+        _selectedPlayer = null;
+        OnSelectionChanged?.Invoke(null);
+    }
 
-            if (selectedPlayer == _selectedPlayer)
-                return;
+    private void PlayerListItemPressed(BaseButton.ButtonEventArgs? args, ListData? data)
+    {
+        if (args == null || data is not PlayerListData { Info: var selectedPlayer })
+            return;
 
-            if (args.Event.Function != EngineKeyFunctions.UIClick)
-                return;
+        if (selectedPlayer == _selectedPlayer)
+            return;
 
-            OnSelectionChanged?.Invoke(selectedPlayer);
-            _selectedPlayer = selectedPlayer;
+        if (args.Event.Function != EngineKeyFunctions.UIClick)
+            return;
 
-            // update label text. Only required if there is some override (e.g. unread bwoink count).
-            if (OverrideText != null && args.Button.Children.FirstOrDefault()?.Children?.FirstOrDefault() is Label label)
-                label.Text = GetText(selectedPlayer);
-        }
+        OnSelectionChanged?.Invoke(selectedPlayer);
+        _selectedPlayer = selectedPlayer;
 
-        private void PlayerListItemKeyBindDown(GUIBoundKeyEventArgs? args, ListData? data)
-        {
-            if (args == null || data is not PlayerListData { Info: var selectedPlayer })
-                return;
+        // update label text. Only required if there is some override (e.g. unread bwoink count).
+        if (OverrideText != null && args.Button.Children.FirstOrDefault()?.Children?.FirstOrDefault() is Label label)
+            label.Text = GetText(selectedPlayer);
+    }
 
-            if (args.Function != EngineKeyFunctions.UIRightClick || selectedPlayer.NetEntity == null)
-                return;
+    private void PlayerListItemKeyBindDown(GUIBoundKeyEventArgs? args, ListData? data)
+    {
+        if (args == null || data is not PlayerListData { Info: var selectedPlayer })
+            return;
 
-            _uiManager.GetUIController<VerbMenuUIController>().OpenVerbMenu(selectedPlayer.NetEntity.Value, true);
-            args.Handle();
-        }
+        if (args.Function != EngineKeyFunctions.UIRightClick || selectedPlayer.NetEntity == null)
+            return;
 
-        public void StopFiltering()
-        {
-            FilterLineEdit.Text = string.Empty;
-        }
+        _uiManager.GetUIController<VerbMenuUIController>().OpenVerbMenu(selectedPlayer.NetEntity.Value, true);
+        args.Handle();
+    }
 
-        private void FilterList()
+    public void StopFiltering()
+    {
+        FilterLineEdit.Text = string.Empty;
+    }
+
+    private void FilterList()
+    {
+        _sortedPlayerList.Clear();
+        foreach (var info in _playerList)
         {
-            _sortedPlayerList.Clear();
-            foreach (var info in _playerList)
-            {
-                var displayName = $"{info.CharacterName} ({info.Username})";
-                if (info.IdentityName != info.CharacterName)
-                    displayName += $" [{info.IdentityName}]";
-                if (!string.IsNullOrEmpty(FilterLineEdit.Text)
-                    && !displayName.ToLowerInvariant().Contains(FilterLineEdit.Text.Trim().ToLowerInvariant()))
-                    continue;
-                _sortedPlayerList.Add(info);
-            }
-
-            if (Comparison != null)
-                _sortedPlayerList.Sort((a, b) => Comparison(a, b));
-
-            PlayerListContainer.PopulateList(_sortedPlayerList.Select(info => new PlayerListData(info)).ToList());
-            if (_selectedPlayer != null)
-                PlayerListContainer.Select(new PlayerListData(_selectedPlayer));
+            var displayName = $"{info.CharacterName} ({info.Username})";
+            if (info.IdentityName != info.CharacterName)
+                displayName += $" [{info.IdentityName}]";
+            if (!string.IsNullOrEmpty(FilterLineEdit.Text)
+                && !displayName.ToLowerInvariant().Contains(FilterLineEdit.Text.Trim().ToLowerInvariant()))
+                continue;
+            _sortedPlayerList.Add(info);
         }
 
-        public void PopulateList(IReadOnlyList<PlayerInfo>? players = null)
-        {
-            players ??= _adminSystem.PlayerList;
+        if (Comparison != null)
+            _sortedPlayerList.Sort((a, b) => Comparison(a, b));
 
-            _playerList = players.ToList();
-            if (_selectedPlayer != null && !_playerList.Contains(_selectedPlayer))
-                _selectedPlayer = null;
+        // Ensure pinned players are always at the top
+        _sortedPlayerList.Sort((a, b) => a.IsPinned != b.IsPinned && a.IsPinned ? -1 : 1);
 
-            FilterList();
-        }
+        PlayerListContainer.PopulateList(_sortedPlayerList.Select(info => new PlayerListData(info)).ToList());
+        if (_selectedPlayer != null)
+            PlayerListContainer.Select(new PlayerListData(_selectedPlayer));
+    }
 
-        private string GetText(PlayerInfo info)
-        {
-            var text = $"{info.CharacterName} ({info.Username})";
-            if (OverrideText != null)
-                text = OverrideText.Invoke(info, text);
-            return text;
-        }
+    public void PopulateList(IReadOnlyList<PlayerInfo>? players = null)
+    {
+        players ??= _adminSystem.PlayerList;
 
-        private void GenerateButton(ListData data, ListContainerButton button)
-        {
-            if (data is not PlayerListData { Info: var info })
-                return;
-
-            button.AddChild(new BoxContainer
-            {
-                Orientation = LayoutOrientation.Vertical,
-                Children =
-                {
-                    new Label
-                    {
-                        ClipText = true,
-                        Text = GetText(info)
-                    }
-                }
-            });
-
-            button.AddStyleClass(ListContainer.StyleClassListContainerButton);
-        }
+        _playerList = players.ToList();
+        if (_selectedPlayer != null && !_playerList.Contains(_selectedPlayer))
+            _selectedPlayer = null;
+
+        FilterList();
     }
 
-    public record PlayerListData(PlayerInfo Info) : ListData;
+
+    private string GetText(PlayerInfo info)
+    {
+        var text = $"{info.CharacterName} ({info.Username})";
+        if (OverrideText != null)
+            text = OverrideText.Invoke(info, text);
+        return text;
+    }
+
+    private void GenerateButton(ListData data, ListContainerButton button)
+    {
+        if (data is not PlayerListData { Info: var info })
+            return;
+
+        var entry = new PlayerListEntry();
+        entry.Setup(info, OverrideText);
+        entry.OnPinStatusChanged += _ =>
+        {
+            FilterList();
+        };
+
+        button.AddChild(entry);
+        button.AddStyleClass(ListContainer.StyleClassListContainerButton);
+    }
 }
+
+public record PlayerListData(PlayerInfo Info) : ListData;

Content.Client/Administration/UI/CustomControls/PlayerListEntry.xaml

@@ -0,0 +1,6 @@
+<BoxContainer xmlns="https://spacestation14.io"
+              Orientation="Horizontal" HorizontalExpand="true">
+    <Label Name="PlayerEntryLabel" Text="" ClipText="True" HorizontalExpand="True" />
+    <TextureButton Name="PlayerEntryPinButton"
+                   HorizontalAlignment="Right" />
+</BoxContainer>

Content.Client/Administration/UI/CustomControls/PlayerListEntry.xaml.cs

@@ -0,0 +1,58 @@
+using Content.Client.Stylesheets;
+using Content.Shared.Administration;
+using Robust.Client.AutoGenerated;
+using Robust.Client.GameObjects;
+using Robust.Client.UserInterface.Controls;
+using Robust.Client.UserInterface.XAML;
+using Robust.Shared.Utility;
+
+namespace Content.Client.Administration.UI.CustomControls;
+
+[GenerateTypedNameReferences]
+public sealed partial class PlayerListEntry : BoxContainer
+{
+    public PlayerListEntry()
+    {
+        RobustXamlLoader.Load(this);
+    }
+
+    public event Action<PlayerInfo>? OnPinStatusChanged;
+
+    public void Setup(PlayerInfo info, Func<PlayerInfo, string, string>? overrideText)
+    {
+        Update(info, overrideText);
+        PlayerEntryPinButton.OnPressed += HandlePinButtonPressed(info);
+    }
+
+    private Action<BaseButton.ButtonEventArgs> HandlePinButtonPressed(PlayerInfo info)
+    {
+        return args =>
+        {
+            info.IsPinned = !info.IsPinned;
+            UpdatePinButtonTexture(info.IsPinned);
+            OnPinStatusChanged?.Invoke(info);
+        };
+    }
+
+    private void Update(PlayerInfo info, Func<PlayerInfo, string, string>? overrideText)
+    {
+        PlayerEntryLabel.Text = overrideText?.Invoke(info, $"{info.CharacterName} ({info.Username})") ??
+                                $"{info.CharacterName} ({info.Username})";
+
+        UpdatePinButtonTexture(info.IsPinned);
+    }
+
+    private void UpdatePinButtonTexture(bool isPinned)
+    {
+        if (isPinned)
+        {
+            PlayerEntryPinButton?.RemoveStyleClass(StyleNano.StyleClassPinButtonUnpinned);
+            PlayerEntryPinButton?.AddStyleClass(StyleNano.StyleClassPinButtonPinned);
+        }
+        else
+        {
+            PlayerEntryPinButton?.RemoveStyleClass(StyleNano.StyleClassPinButtonPinned);
+            PlayerEntryPinButton?.AddStyleClass(StyleNano.StyleClassPinButtonUnpinned);
+        }
+    }
+}

Content.Client/Administration/UI/Tabs/PlayerTab/PlayerTab.xaml

@@ -1,21 +1,19 @@
 <Control xmlns="https://spacestation14.io"
          xmlns:pt="clr-namespace:Content.Client.Administration.UI.Tabs.PlayerTab"
-         xmlns:cc="clr-namespace:Content.Client.Administration.UI.CustomControls">
+         xmlns:cc="clr-namespace:Content.Client.Administration.UI.CustomControls"
+         xmlns:co="clr-namespace:Content.Client.UserInterface.Controls">
     <BoxContainer Orientation="Vertical">
         <BoxContainer Orientation="Horizontal">
-            <Label Name="PlayerCount" HorizontalExpand="True" SizeFlagsStretchRatio="0.50"
-                   Text="{Loc Player Count}" />
-            <Button Name="ShowDisconnectedButton" HorizontalExpand="True" SizeFlagsStretchRatio="0.25"
-                    Text="{Loc player-tab-show-disconnected}" ToggleMode="True"/>
-            <Button Name="OverlayButton" HorizontalExpand="True" SizeFlagsStretchRatio="0.25"
-                    Text="{Loc player-tab-overlay}" ToggleMode="True"/>
+            <Label Name="PlayerCount" HorizontalExpand="True" Text="{Loc Player Count}" />
+            <LineEdit Name="SearchLineEdit" HorizontalExpand="True"
+                      PlaceHolder="{Loc player-tab-filter-line-edit-placeholder}" />
+            <Button Name="ShowDisconnectedButton" HorizontalExpand="True"
+                    Text="{Loc player-tab-show-disconnected}" ToggleMode="True" />
+            <Button Name="OverlayButton" HorizontalExpand="True" Text="{Loc player-tab-overlay}" ToggleMode="True" />
         </BoxContainer>
-        <Control MinSize="0 5" />
-        <ScrollContainer HorizontalExpand="True" VerticalExpand="True">
-            <BoxContainer Orientation="Vertical" Name="PlayerList">
-                <pt:PlayerTabHeader Name="ListHeader" />
-                <cc:HSeparator />
-            </BoxContainer>
-        </ScrollContainer>
+        <Control MinSize="0 5"/>
+        <pt:PlayerTabHeader Name="ListHeader"/>
+        <cc:HSeparator/>
+        <co:SearchListContainer Name="SearchList" Access="Public" VerticalExpand="True"/>
     </BoxContainer>
 </Control>