Redesign player chat and NitroxUnity structure (#1024)

* Moving NitroxUnity from submodule to simple folder

* Updated chat design and code

* Added "special" functions

* > Fixed dragging offset
> Added fade to chat show/hide

* Added chat key hint

* Cleaned up the mess after failed rebase

* Reimplemented #982
Reimplemented autofac registry entry

* Added back meta files from unity

* Changed method to removed chat pop in

* > Optimized layout groups and content fitting
> Added new line option with Shift + Enter
> Dragging now works with offset
> Optimized fonts

* > Replaced `while return null` `with `WaitUntil`
> Replaced `CoroutineWithData` `with `IEnumerator callback`

* Optimizing sprites

Author: Jannify

.gitattributes

@@ -0,0 +1,7 @@
+* text=auto
+
+# Unity files
+*.meta -merge=unityamlmerge -text
+*.unity -merge=unityamlmerge -text
+*.asset -merge=unityamlmerge -text
+*.prefab -merge=unityamlmerge -text

.gitignore

@@ -27,8 +27,9 @@ bld/
 [Oo]bj/
 [Ll]og/
 
-# Visual Studio 2015 cache/options directory
+# Visual Studio cache/options directory
 .vs/
+
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
@@ -278,3 +279,10 @@ paket-files/
 /.sonarqube
 sonar.config.bat
 *.bak
+
+# Unity3D: Generated meta files
+*.pidb.meta
+*.pdb.meta
+
+# Unity3D: Generated File On Crash Reports
+sysinfo.txt

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "NitroxUnity"]
-	path = NitroxUnity
-	url = https://github.com/SubnauticaNitrox/NitroxUnity

AssetBundles/chatkeyhint

@@ -228,6 +228,7 @@
   </TypePattern>
 &lt;/Patterns&gt;</s:String>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAlwaysTreatStructAsNotReorderableMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Coroutine/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Mathf/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Nitrox/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Startable/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

AssetBundles/chatlog

@@ -75,11 +75,11 @@ private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
             containerBuilder.RegisterType<PlayerManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PlayerModelManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PlayerVitalsManager>().InstancePerLifetimeScope();
-            containerBuilder.RegisterType<PlayerChat>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<VisibleCells>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PacketReceiver>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<AI>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<Building>().InstancePerLifetimeScope();
+            containerBuilder.RegisterType<PlayerChatManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<Entities>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<MedkitFabricator>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<Item>().InstancePerLifetimeScope();

Nitrox.sln.DotSettings

@@ -3,20 +3,25 @@
 using NitroxClient.Communication.Packets.Processors.Abstract;
 using NitroxClient.GameLogic;
 using NitroxClient.GameLogic.ChatUI;
+using NitroxModel.Core;
 using NitroxModel.DataStructures.Util;
+using NitroxModel.Logger;
 using NitroxModel.Packets;
+using UnityEngine;
 
 namespace NitroxClient.Communication.Packets.Processors
 {
     class ChatMessageProcessor : ClientPacketProcessor<ChatMessage>
     {
         private readonly PlayerManager remotePlayerManager;
-        private readonly PlayerChat playerChat;
+        private readonly PlayerChatManager playerChatManager;
 
-        public ChatMessageProcessor(PlayerManager remotePlayerManager, PlayerChat playerChat)
+        private readonly Color32 serverMessageColor = new Color32(0x8c, 0x00, 0xFF, 0xFF);
+
+        public ChatMessageProcessor(PlayerManager remotePlayerManager, PlayerChatManager playerChatManager)
         {
             this.remotePlayerManager = remotePlayerManager;
-            this.playerChat = playerChat;
+            this.playerChatManager = playerChatManager;
         }
 
         public override void Process(ChatMessage message)
@@ -37,18 +42,19 @@ private void LogClientMessage(ChatMessage message)
             if (!remotePlayer.HasValue)
             {
                 string playerTableFormatted = string.Join("\n", remotePlayerManager.GetAll().Select(ply => $"Name: '{ply.PlayerName}', Id: {ply.PlayerId}"));
+                Log.Error($"Tried to add chat message for remote player that could not be found with id '${message.PlayerId}' and message: '{message.Text}'.\nAll remote players right now:\n{playerTableFormatted}");
                 throw new Exception($"Tried to add chat message for remote player that could not be found with id '${message.PlayerId}' and message: '{message.Text}'.\nAll remote players right now:\n{playerTableFormatted}");
             }
-            
+
             RemotePlayer remotePlayerInstance = remotePlayer.Value;
-            playerChat.AddMessage(remotePlayerInstance.PlayerName, message.Text, remotePlayerInstance.PlayerSettings.PlayerColor);
-            playerChat.ShowLog();
+            playerChatManager.AddMessage(remotePlayerInstance.PlayerName, message.Text, remotePlayerInstance.PlayerSettings.PlayerColor);
+            playerChatManager.ShowChat();
         }
 
         private void LogServerMessage(ChatMessage message)
         {
-            playerChat.AddMessage("Server", message.Text, new UnityEngine.Color32(0x8c, 0x00, 0xFF, 0xFF));
-            playerChat.ShowLog();
+            playerChatManager.AddMessage("Server", message.Text, serverMessageColor);
+            playerChatManager.ShowChat();
         }
     }
 }

NitroxClient/ClientAutoFacRegistrar.cs

@@ -1,4 +1,5 @@
-using UnityEngine;
+using System;
+using UnityEngine;
 
 namespace NitroxClient.GameLogic.ChatUI
 {
@@ -7,12 +8,17 @@ public class ChatLogEntry
         public string PlayerName { get; }
         public string MessageText { get; set; }
         public Color32 PlayerColor { get; }
+        public string Time { get; set; }
+        public GameObject EntryObject { get; set; }
 
         public ChatLogEntry(string playerName, string messageText, Color32 playerColor)
         {
             PlayerName = playerName;
             MessageText = messageText;
             PlayerColor = playerColor;
+            UpdateTime();
         }
+
+        public void UpdateTime() => Time = DateTime.Now.ToString("HH:mm");
     }
 }

NitroxClient/Communication/Packets/Processors/ChatMessageProcessor.cs

@@ -0,0 +1,75 @@
+using System.Collections;
+using NitroxClient.Communication.Abstract;
+using NitroxClient.MonoBehaviours.Gui.Chat;
+using NitroxClient.Unity.Helper;
+using NitroxModel.Packets;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.ChatUI
+{
+    public class PlayerChatManager
+    {
+        public PlayerChatManager(IMultiplayerSession multiplayerSession)
+        {
+            this.multiplayerSession = multiplayerSession;
+            Player.main.StartCoroutine(LoadChatLogAsset());
+        }
+
+        private PlayerChat playerChat;
+        public Transform PlayerChaTransform => playerChat.transform;
+        private readonly IMultiplayerSession multiplayerSession;
+
+        public void ShowChat() => Player.main.StartCoroutine(ShowChatAsync());
+        private IEnumerator ShowChatAsync()
+        {
+            yield return new WaitUntil(() => PlayerChat.IsReady);
+            playerChat.Show();
+        }
+
+        public void HideChat() => Player.main.StartCoroutine(HideChatAsync());
+        private IEnumerator HideChatAsync()
+        {
+            yield return new WaitUntil(() => PlayerChat.IsReady);
+            playerChat.Deselect();
+            playerChat.Hide();
+        }
+
+        public void SelectChat() => Player.main.StartCoroutine(SelectChatAsync());
+        private IEnumerator SelectChatAsync()
+        {
+            yield return new WaitUntil(() => PlayerChat.IsReady);
+            playerChat.Show();
+            playerChat.Select();
+        }
+
+        public void AddMessage(string playerName, string message, Color color) => Player.main.StartCoroutine(AddMessageAsync(playerName, message, color));
+        private IEnumerator AddMessageAsync(string playerName, string message, Color color)
+        {
+            yield return new WaitUntil(() => PlayerChat.IsReady);
+            playerChat.WriteLogEntry(playerName, message, color);
+        }
+
+        public void SendMessage()
+        {
+            if (playerChat.inputText.Trim() != "")
+            {
+                multiplayerSession.Send(new ChatMessage(multiplayerSession.Reservation.PlayerId, playerChat.inputText));
+                playerChat.WriteLogEntry(multiplayerSession.AuthenticationContext.Username, playerChat.inputText, multiplayerSession.PlayerSettings.PlayerColor);
+                playerChat.inputText = "";
+            }
+            playerChat.Select();
+        }
+
+        private IEnumerator LoadChatLogAsset()
+        {
+            yield return AssetBundleLoader.LoadUIAsset("chatlog", "PlayerChatCanvas", true, playerChatGameObject =>
+            {
+                playerChat = playerChatGameObject.AddComponent<PlayerChat>();
+            });
+
+            yield return playerChat.SetupChatComponents();
+        }
+
+        public static void LoadChatKeyHint() => Player.main.StartCoroutine(AssetBundleLoader.LoadUIAsset("chatkeyhint", "ChatKeyCanvas"));
+    }
+}