Add LOOC and change OOC color (#5841)

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

@@ -8,5 +8,6 @@
         <cc:CommandButton Command="restart" Text="{Loc server-reboot}" />
         <cc:CommandButton Command="shutdown" Text="{Loc server-shutdown}" />
         <cc:CommandButton Command="setooc" Text="{Loc server-ooc-toggle}" />
+        <cc:CommandButton Command="setlooc" Text="{Loc server-looc-toggle}" />
     </GridContainer>
 </Control>

Content.Client/Chat/ChatHelper.cs

@@ -10,7 +10,8 @@ namespace Content.Client.Chat
             {
                 ChatChannel.Server => Color.Orange,
                 ChatChannel.Radio => Color.LimeGreen,
-                ChatChannel.OOC => Color.LightSkyBlue,
+                ChatChannel.LOOC => Color.LightSkyBlue,
+                ChatChannel.OOC => Color.RoyalBlue,
                 ChatChannel.Dead => Color.MediumPurple,
                 ChatChannel.Admin => Color.Red,
                 _ => Color.DarkGray

Content.Client/Chat/Managers/ChatManager.cs

@@ -188,6 +188,8 @@ namespace Content.Client.Chat.Managers
             // can always send/recieve OOC
             SelectableChannels |= ChatSelectChannel.OOC;
             FilterableChannels |= ChatChannel.OOC;
+            SelectableChannels |= ChatSelectChannel.LOOC;
+            FilterableChannels |= ChatChannel.LOOC;
 
             // can always hear server (nobody can actually send server messages).
             FilterableChannels |= ChatChannel.Server;
@@ -318,6 +320,10 @@ namespace Content.Client.Chat.Managers
                     _consoleHost.ExecuteCommand(text.ToString());
                     break;
 
+                case ChatSelectChannel.LOOC:
+                    _consoleHost.ExecuteCommand($"looc \"{CommandParsing.Escape(str)}\"");
+                    break;
+
                 case ChatSelectChannel.OOC:
                     _consoleHost.ExecuteCommand($"ooc \"{CommandParsing.Escape(str)}\"");
                     break;

Content.Client/Chat/UI/ChatBox.xaml.cs

@@ -44,6 +44,7 @@ namespace Content.Client.Chat.UI
             ChatSelectChannel.Local,
             ChatSelectChannel.Emotes,
             ChatSelectChannel.Radio,
+            ChatSelectChannel.LOOC,
             ChatSelectChannel.OOC,
             ChatSelectChannel.Dead,
             ChatSelectChannel.Admin
@@ -491,7 +492,8 @@ namespace Content.Client.Chat.UI
             return channel switch
             {
                 ChatSelectChannel.Radio => Color.LimeGreen,
-                ChatSelectChannel.OOC => Color.LightSkyBlue,
+                ChatSelectChannel.LOOC => Color.LightSkyBlue,
+                ChatSelectChannel.OOC => Color.RoyalBlue,
                 ChatSelectChannel.Dead => Color.MediumPurple,
                 ChatSelectChannel.Admin => Color.Red,
                 _ => Color.DarkGray

Content.Server/Chat/Commands/LOOCCommand.cs

@@ -0,0 +1,56 @@
+using Content.Server.Administration;
+using Content.Server.Chat.Managers;
+using Content.Server.Players;
+using Content.Shared.Administration;
+using Robust.Server.Player;
+using Robust.Shared.Console;
+using Robust.Shared.Enums;
+using Robust.Shared.IoC;
+
+namespace Content.Server.Chat.Commands
+{
+    [AnyCommand]
+    internal class LOOCCommand : IConsoleCommand
+    {
+        public string Command => "looc";
+        public string Description => "Send Local Out Of Character chat messages.";
+        public string Help => "looc <text>";
+
+        public void Execute(IConsoleShell shell, string argStr, string[] args)
+        {
+            var player = shell.Player as IPlayerSession;
+            if (player == null)
+            {
+                shell.WriteLine("This command cannot be run from the server.");
+                return;
+            }
+
+            if (player.Status != SessionStatus.InGame || player.AttachedEntity == null)
+                return;
+
+            if (args.Length < 1)
+                return;
+
+            var message = string.Join(" ", args).Trim();
+            if (string.IsNullOrEmpty(message))
+                return;
+
+            var chat = IoCManager.Resolve<IChatManager>();
+            var mindComponent = player.ContentData()?.Mind;
+
+            if (mindComponent == null)
+            {
+                shell.WriteError("You don't have a mind!");
+                return;
+            }
+
+            if (mindComponent.OwnedEntity == null)
+            {
+                shell.WriteError("You don't have an entity!");
+                return;
+            }
+
+            chat.EntityLOOC(mindComponent.OwnedEntity.Value, message);
+        }
+    }
+}

Content.Server/Chat/Commands/SetLOOCCommand.cs

@@ -0,0 +1,44 @@
+using Content.Server.Administration;
+using Content.Shared.Administration;
+using Content.Shared.CCVar;
+using Robust.Shared.Configuration;
+using Robust.Shared.Console;
+using Robust.Shared.IoC;
+using Robust.Shared.Localization;
+
+namespace Content.Server.Chat.Commands;
+
+[AdminCommand(AdminFlags.Server)]
+public class SetLOOCCommand : IConsoleCommand
+{
+    public string Command => "setlooc";
+    public string Description => Loc.GetString("set-looc-command-description");
+    public string Help => Loc.GetString("set-looc-command-help");
+    public void Execute(IConsoleShell shell, string argStr, string[] args)
+    {
+        var cfg = IoCManager.Resolve<IConfigurationManager>();
+
+        if (args.Length > 1)
+        {
+            shell.WriteError(Loc.GetString("set-looc-command-too-many-arguments-error"));
+            return;
+        }
+
+        var looc = cfg.GetCVar(CCVars.LoocEnabled);
+
+        if (args.Length == 0)
+        {
+            looc = !looc;
+        }
+
+        if (args.Length == 1 && !bool.TryParse(args[0], out looc))
+        {
+            shell.WriteError(Loc.GetString("set-looc-command-invalid-argument-error"));
+            return;
+        }
+
+        cfg.SetCVar(CCVars.LoocEnabled, looc);
+
+        shell.WriteLine(Loc.GetString(looc ? "set-looc-command-looc-enabled" : "set-looc-command-looc-disabled"));
+    }
+}

Content.Server/Chat/Managers/ChatManager.cs

@@ -59,12 +59,15 @@ namespace Content.Server.Chat.Managers
         private readonly List<TransformChat> _chatTransformHandlers = new();
         private bool _oocEnabled = true;
         private bool _adminOocEnabled = true;
+        private bool _loocEnabled = true;
+        private bool _adminLoocEnabled = true;
 
         public void Initialize()
         {
             _netManager.RegisterNetMessage<MsgChatMessage>();
 
             _configurationManager.OnValueChanged(CCVars.OocEnabled, OnOocEnabledChanged, true);
+            _configurationManager.OnValueChanged(CCVars.LoocEnabled, OnLoocEnabledChanged, true);
             _configurationManager.OnValueChanged(CCVars.AdminOocEnabled, OnAdminOocEnabledChanged, true);
         }
 
@@ -74,6 +77,12 @@ namespace Content.Server.Chat.Managers
             DispatchServerAnnouncement(Loc.GetString(val ? "chat-manager-ooc-chat-enabled-message" : "chat-manager-ooc-chat-disabled-message"));
         }
 
+        private void OnLoocEnabledChanged(bool val)
+        {
+            _loocEnabled = val;
+            DispatchServerAnnouncement(Loc.GetString(val ? "chat-manager-looc-chat-enabled-message" : "chat-manager-looc-chat-disabled-message"));
+        }
+
         private void OnAdminOocEnabledChanged(bool val)
         {
             _adminOocEnabled = val;
@@ -238,6 +247,47 @@ namespace Content.Server.Chat.Managers
             _netManager.ServerSendToMany(msg, clients);
         }
 
+        public void EntityLOOC(EntityUid source, string message)
+        {
+            // Check if entity is a player
+            if (!_entManager.TryGetComponent(source, out ActorComponent? actor))
+            {
+                return;
+            }
+
+            if (_adminManager.IsAdmin(actor.PlayerSession))
+            {
+                if (!_adminLoocEnabled)
+                {
+                    return;
+                }
+            }
+            else if (!_loocEnabled)
+            {
+                return;
+            }
+
+            // Check if message exceeds the character limit
+            if (message.Length > MaxMessageLength)
+            {
+                DispatchServerMessage(actor.PlayerSession, Loc.GetString("chat-manager-max-message-length-exceeded-message", ("limit", MaxMessageLength)));
+                return;
+            }
+
+            message = FormattedMessage.EscapeText(message);
+
+            var clients = Filter.Empty()
+                .AddInRange(_entManager.GetComponent<TransformComponent>(source).MapPosition, VoiceRange)
+                .Recipients
+                .Select(p => p.ConnectedClient)
+                .ToList();
+
+            var msg = _netManager.CreateNetMessage<MsgChatMessage>();
+            msg.Channel = ChatChannel.LOOC;
+            msg.Message = message;
+            msg.MessageWrap = Loc.GetString("chat-manager-entity-looc-wrap-message", ("entityName", Name: _entManager.GetComponent<MetaDataComponent>(source).EntityName));
+            _netManager.ServerSendToMany(msg, clients);
+        }
         public void SendOOC(IPlayerSession player, string message)
         {
             if (_adminManager.IsAdmin(player))

Content.Server/Chat/Managers/IChatManager.cs

@@ -25,6 +25,7 @@ namespace Content.Server.Chat.Managers
         /// <param name="hideChat">If true, message will not be logged to chat boxes but will still produce a speech bubble.</param>
         void EntitySay(EntityUid source, string message, bool hideChat=false);
         void EntityMe(EntityUid source, string action);
+        void EntityLOOC(EntityUid source, string message);
 
         void SendOOC(IPlayerSession player, string message);
         void SendAdminChat(IPlayerSession player, string message);

Content.Shared/CCVar/CCVars.cs

@@ -485,6 +485,15 @@ namespace Content.Shared.CCVar
         public static readonly CVarDef<bool> AdminOocEnabled =
             CVarDef.Create("ooc.enabled_admin", true, CVar.NOTIFY);
 
+        /*
+         * LOOC
+         */
+
+        public static readonly CVarDef<bool> LoocEnabled = CVarDef.Create("looc.enabled", true, CVar.NOTIFY);
+
+        public static readonly CVarDef<bool> AdminLoocEnabled =
+            CVarDef.Create("looc.enabled_admin", true, CVar.NOTIFY);
+
         /*
          * Entity Menu Grouping Types
          */

Content.Shared/Chat/ChatChannel.cs

@@ -30,36 +30,41 @@ namespace Content.Shared.Chat
         /// </summary>
         Radio = 1 << 3,
 
+        /// <summary>
+        ///     Local out-of-character channel
+        /// </summary>
+        LOOC = 1 << 4,
+
         /// <summary>
         ///     Out-of-character channel
         /// </summary>
-        OOC = 1 << 4,
+        OOC = 1 << 5,
 
         /// <summary>
         ///     Visual events the player can see.
         ///     Basically like visual_message in SS13.
         /// </summary>
-        Visual = 1 << 5,
+        Visual = 1 << 6,
 
         /// <summary>
         ///     Emotes
         /// </summary>
-        Emotes = 1 << 6,
+        Emotes = 1 << 7,
 
         /// <summary>
         ///     Deadchat
         /// </summary>
-        Dead = 1 << 7,
+        Dead = 1 << 8,
 
         /// <summary>
         ///     Admin chat
         /// </summary>
-        Admin = 1 << 8,
+        Admin = 1 << 9,
 
         /// <summary>
         ///     Unspecified.
         /// </summary>
-        Unspecified = 1 << 9,
+        Unspecified = 1 << 10,
 
         /// <summary>
         ///     Channels considered to be IC.

Content.Shared/Chat/ChatSelectChannel.cs

@@ -23,6 +23,11 @@ namespace Content.Shared.Chat
         /// </summary>
         Radio = ChatChannel.Radio,
 
+        /// <summary>
+        ///     Local out-of-character channel
+        /// </summary>
+        LOOC = ChatChannel.LOOC,
+
         /// <summary>
         ///     Out-of-character channel
         /// </summary>

Resources/Locale/en-US/administration/commands/set-looc-command.ftl

@@ -0,0 +1,6 @@
+set-looc-command-description = Allows you to enable or disable LOOC.
+set-looc-command-help = Usage: setlooc OR setlooc [value]
+set-looc-command-too-many-arguments-error = Too many arguments.
+set-looc-command-invalid-argument-error = Invalid argument.
+set-looc-command-looc-enabled = LOOC chat has been enabled.
+set-looc-command-looc-disabled = LOOC chat has been disabled.

Resources/Locale/en-US/administration/ui/tabs/server-tab.ftl

@@ -1,3 +1,4 @@
 server-reboot = Reboot
 server-shutdown = Shutdown
 server-ooc-toggle = Toggle OOC
+server-looc-toggle = Toggle LOOC

Resources/Locale/en-US/chat/managers/chat-manager.ftl

@@ -3,6 +3,8 @@
 chat-manager-max-message-length = Your message exceeds {$maxMessageLength} character limit
 chat-manager-ooc-chat-enabled-message = OOC chat has been enabled.
 chat-manager-ooc-chat-disabled-message = OOC chat has been disabled.
+chat-manager-looc-chat-enabled-message = LOOC chat has been enabled.
+chat-manager-looc-chat-disabled-message = LOOC chat has been disabled.
 chat-manager-admin-ooc-chat-enabled-message = Admin OOC chat has been enabled.
 chat-manager-admin-ooc-chat-disabled-message = Admin OOC chat has been disabled.
 chat-manager-max-message-length-exceeded-message = Your message exceeded {$limit} character limit
@@ -12,6 +14,7 @@ chat-manager-sender-announcement-wrap-message = {$sender} Announcement:
                                                 {"{0}"}
 chat-manager-entity-say-wrap-message = {$entityName} says: "{"{0}"}"
 chat-manager-entity-me-wrap-message = {$entityName} {"{0}"}
+chat-manager-entity-looc-wrap-message = LOOC: {$entityName}: {"{0}"}
 chat-manager-send-ooc-wrap-message = OOC: {$playerName}: {"{0}"}
 chat-manager-send-ooc-patron-wrap-message = OOC: [color={$patronColor}]{$playerName}[/color]: {"{0}"}
 chat-manager-send-dead-chat-wrap-message = {$deadChannelName}: {$playerName}: {"{0}"}

Resources/Locale/en-US/chat/ui/chat-box.ftl

@@ -6,6 +6,7 @@ hud-chatbox-select-channel-Console = Console
 hud-chatbox-select-channel-Dead = Dead
 hud-chatbox-select-channel-Emotes = Emotes
 hud-chatbox-select-channel-Local = Local
+hud-chatbox-select-channel-LOOC = LOOC
 hud-chatbox-select-channel-OOC = OOC
 hud-chatbox-select-channel-Radio = Radio
 
@@ -13,6 +14,7 @@ hud-chatbox-channel-Admin = Admin
 hud-chatbox-channel-Dead = Dead
 hud-chatbox-channel-Emotes = Emotes
 hud-chatbox-channel-Local = Local
+hud-chatbox-channel-LOOC = LOOC
 hud-chatbox-channel-OOC = OOC
 hud-chatbox-channel-Radio = Radio
 hud-chatbox-channel-Server = Server