Clean up chat input.

- Team chat by default; use tab key or button to change.
- Removed "Use RETURN key..." prompt.
- Remove jarring transition between display and entry modes.
- Scroll to bottom on opening entry mode.
- Disable any/team toggle for spectators.
- Minor spacing/padding tweaks.
- Code cleanup.

OpenRA.Game/Widgets/ChatDisplayWidget.cs

@@ -8,6 +8,7 @@
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
 using System.Drawing;
 using System.Linq;
@@ -18,10 +19,9 @@ namespace OpenRA.Widgets
 	{
 		public readonly int RemoveTime = 0;
 		public readonly bool UseContrast = false;
+		public string Notification = "";
 
 		const int logLength = 9;
-		public string Notification = "";
-		public bool DrawBackground = true;
 		int ticksUntilRemove = 0;
 
 		internal List<ChatLine> recentLines = new List<ChatLine>();
@@ -35,13 +35,9 @@ namespace OpenRA.Widgets
 		{
 			var pos = RenderOrigin;
 			var chatLogArea = new Rectangle(pos.X, pos.Y, Bounds.Width, Bounds.Height);
-			var chatpos = new int2(chatLogArea.X + 10, chatLogArea.Bottom - 6);
+			var chatpos = new int2(chatLogArea.X + 5, chatLogArea.Bottom - 5);
-
-			if (DrawBackground)
-				WidgetUtils.DrawPanel("dialog3", chatLogArea);
 
 			var font = Game.Renderer.Fonts["Regular"];
-
 			Game.Renderer.EnableScissor(chatLogArea.Left, chatLogArea.Top, chatLogArea.Width, chatLogArea.Height);
 
 			foreach (var line in recentLines.AsEnumerable().Reverse())
@@ -52,12 +48,14 @@ namespace OpenRA.Widgets
 				if (!string.IsNullOrEmpty(line.Owner))
 				{
 					owner = line.Owner + ":";
-					inset = font.Measure(owner).X + 10;
+					inset = font.Measure(owner).X + 5;
 				}
 
-				var text = WidgetUtils.WrapText(line.Text, chatLogArea.Width - inset, font);
+				var text = WidgetUtils.WrapText(line.Text, chatLogArea.Width - inset - 6, font);
-				var textLines = text.Split(new[] { '\n' }).Count();
+				chatpos.Y -= Math.Max(15, font.Measure(text).Y) + 5;
-				chatpos.Y -= 20 * textLines;
+
+				if (chatpos.Y < pos.Y)
+					break;
 
 				if (owner != null)
 				{
@@ -80,12 +78,14 @@ namespace OpenRA.Widgets
 			if (Notification != null)
 				Sound.Play(Notification);
 
-			while (recentLines.Count > logLength) recentLines.RemoveAt(0);
+			while (recentLines.Count > logLength)
+				recentLines.RemoveAt(0);
 		}
 
 		public void RemoveLine()
 		{
-			if (recentLines.Count > 0) recentLines.RemoveAt(0);
+			if (recentLines.Count > 0)
+				recentLines.RemoveAt(0);
 		}
 
 		public void ClearChat()
@@ -95,8 +95,12 @@ namespace OpenRA.Widgets
 
 		public override void Tick()
 		{
-			if (RemoveTime == 0) return;
+			if (RemoveTime == 0)
-			if (--ticksUntilRemove > 0) return;
+				return;
+
+			if (--ticksUntilRemove > 0)
+				return;
+
 			ticksUntilRemove = RemoveTime;
 			RemoveLine();
 		}

OpenRA.Mods.RA/Widgets/Logic/IngameChatLogic.cs

@@ -10,71 +10,65 @@
 
 using System;
 using System.Drawing;
-using OpenRA.Widgets;
 using OpenRA.Network;
+using OpenRA.Widgets;
 
 namespace OpenRA.Mods.RA.Widgets.Logic
 {
 	public class IngameChatLogic
 	{
-		internal World World;
+		readonly ContainerWidget chatOverlay;
-		internal readonly ContainerWidget ChatOverlay;
+		readonly ChatDisplayWidget chatOverlayDisplay;
-		internal readonly ChatDisplayWidget ChatOverlayDisplay;
 
+		readonly ContainerWidget chatChrome;
+		readonly ScrollPanelWidget chatScrollPanel;
+		readonly ContainerWidget chatTemplate;
+		readonly TextFieldWidget chatText;
 
-		internal readonly ContainerWidget ChatChrome;
+		bool teamChat;
-		internal readonly ScrollPanelWidget ChatScrollPanel;
-		internal readonly ContainerWidget ChatTemplate;
-		internal readonly TextFieldWidget ChatText;
-
-		private bool teamChat = false;
-		internal bool TeamChat
-		{
-			get { return World.LocalPlayer == null ? false : teamChat; }
-			set { teamChat = value; }
-		}
 
 		[ObjectCreator.UseCtor]
 		public IngameChatLogic(Widget widget, OrderManager orderManager, World world)
 		{
-			World = world;
+			teamChat = world.LocalPlayer != null;
-			var chatPanel = (ContainerWidget) widget;
 
+			var chatPanel = (ContainerWidget)widget;
+			chatOverlay = chatPanel.Get<ContainerWidget>("CHAT_OVERLAY");
+			chatOverlayDisplay = chatOverlay.Get<ChatDisplayWidget>("CHAT_DISPLAY");
+			chatOverlay.Visible = false;
 
-			ChatOverlay = chatPanel.Get<ContainerWidget>("CHAT_OVERLAY");
+			chatChrome = chatPanel.Get<ContainerWidget>("CHAT_CHROME");
-			ChatOverlayDisplay = ChatOverlay.Get<ChatDisplayWidget>("CHAT_DISPLAY");
+			chatChrome.Visible = true;
-			ChatOverlay.Visible = false;
 
-			ChatChrome = chatPanel.Get<ContainerWidget>("CHAT_CHROME");
+			var chatMode = chatChrome.Get<ButtonWidget>("CHAT_MODE");
-			ChatChrome.Visible = true;
+			chatMode.GetText = () => teamChat ? "Team" : "All";
+			chatMode.OnClick = () => teamChat ^= true;
+			chatMode.IsDisabled = () => world.LocalPlayer == null;
 
-			var chatMode = ChatChrome.Get<ButtonWidget>("CHAT_MODE");
+			chatText = chatChrome.Get<TextFieldWidget>("CHAT_TEXTFIELD");
-			chatMode.GetText = () => TeamChat ? "Team" : "All";
+			chatText.OnTabKey = () => { teamChat ^= true; return true; };
-			chatMode.OnClick = () => TeamChat = !TeamChat;
+			chatText.OnEnterKey = () =>
-
-			ChatText = ChatChrome.Get<TextFieldWidget>("CHAT_TEXTFIELD");
-			ChatText.OnTabKey = () => { TeamChat = !TeamChat; return true; };
-			ChatText.OnEnterKey = () =>
 			{
-				ChatText.Text = ChatText.Text.Trim();
+				var team = teamChat && world.LocalPlayer != null;
-				if (ChatText.Text != "")
+				if (chatText.Text != "")
-					orderManager.IssueOrder(Order.Chat(TeamChat, ChatText.Text));
+					orderManager.IssueOrder(Order.Chat(team, chatText.Text.Trim()));
+
 				CloseChat();
 				return true;
 			};
-			ChatText.OnEscKey = () => {CloseChat(); return true; };
 
-			var chatClose = ChatChrome.Get<ButtonWidget>("CHAT_CLOSE");
+			chatText.OnEscKey = () => { CloseChat(); return true; };
+
+			var chatClose = chatChrome.Get<ButtonWidget>("CHAT_CLOSE");
 			chatClose.OnClick += () => CloseChat();
 
 			chatPanel.OnKeyPress = (e) =>
 			{
-				if (e.Event == KeyInputEvent.Up) return false;
+				if (e.Event == KeyInputEvent.Up)
-				if (!IsOpen && (e.Key == Keycode.RETURN || e.Key == Keycode.KP_ENTER))
+					return false;
+
+				if (!chatChrome.IsVisible() && (e.Key == Keycode.RETURN || e.Key == Keycode.KP_ENTER))
 				{
-					var shift = e.Modifiers.HasModifier(Modifiers.Shift);
-					var toggle = Game.Settings.Game.TeamChatToggle ;
-					TeamChat = (!toggle && shift) || ( toggle &&  (TeamChat ^ shift) );
 					OpenChat();
 					return true;
 				}
@@ -82,14 +76,14 @@ namespace OpenRA.Mods.RA.Widgets.Logic
 				return false;
 			};
 
-			ChatScrollPanel = ChatChrome.Get<ScrollPanelWidget>("CHAT_SCROLLPANEL");
+			chatScrollPanel = chatChrome.Get<ScrollPanelWidget>("CHAT_SCROLLPANEL");
-			ChatTemplate = ChatScrollPanel.Get<ContainerWidget>("CHAT_TEMPLATE");
+			chatTemplate = chatScrollPanel.Get<ContainerWidget>("CHAT_TEMPLATE");
+			chatScrollPanel.RemoveChildren();
 
 			Game.AddChatLine += AddChatLine;
 			Game.BeforeGameStart += UnregisterEvents;
 
 			CloseChat();
-			ChatOverlayDisplay.AddLine(Color.White, null, "Use RETURN key to open chat window...");
 		}
 
 		void UnregisterEvents()
@@ -100,33 +94,32 @@ namespace OpenRA.Mods.RA.Widgets.Logic
 
 		public void OpenChat()
 		{
-			ChatText.Text = "";
+			chatText.Text = "";
-			ChatOverlay.Visible = false;
+			chatOverlay.Visible = false;
-			ChatChrome.Visible = true;
+			chatChrome.Visible = true;
-			ChatText.TakeKeyboardFocus();
+			chatScrollPanel.ScrollToBottom();
+			chatText.TakeKeyboardFocus();
 		}
 
 		public void CloseChat()
 		{
-			ChatOverlay.Visible = true;
+			chatOverlay.Visible = true;
-			ChatChrome.Visible = false;
+			chatChrome.Visible = false;
-			ChatText.YieldKeyboardFocus();
+			chatText.YieldKeyboardFocus();
 		}
 
-		public bool IsOpen { get { return ChatChrome.IsVisible(); } }
-
 		public void AddChatLine(Color c, string from, string text)
 		{
+			chatOverlayDisplay.AddLine(c, from, text);
 
-			ChatOverlayDisplay.AddLine(c, from, text);
+			var template = chatTemplate.Clone();
-
-			var template = ChatTemplate.Clone();
 			var nameLabel = template.Get<LabelWidget>("NAME");
 			var textLabel = template.Get<LabelWidget>("TEXT");
 
 			var name = "";
 			if (!string.IsNullOrEmpty(from))
 				name = from + ":";
+
 			var font = Game.Renderer.Fonts[nameLabel.Font];
 			var nameSize = font.Measure(from);
 
@@ -146,10 +139,9 @@ namespace OpenRA.Mods.RA.Widgets.Logic
 				template.Bounds.Height += dh;
 			}
 
-			ChatScrollPanel.AddChild(template);
+			chatScrollPanel.AddChild(template);
-			ChatScrollPanel.ScrollToBottom();
+			chatScrollPanel.ScrollToBottom();
 			Sound.PlayNotification(null, "Sounds", "ChatLine", null);
 		}
 	}
 }
-

OpenRA.Mods.RA/Widgets/Logic/SettingsMenuLogic.cs

@@ -65,10 +65,6 @@ namespace OpenRA.Mods.RA.Widgets.Logic
 			inversescroll.IsChecked = () => Game.Settings.Game.MouseScroll == MouseScrollType.Inverted;
 			inversescroll.OnClick = () => Game.Settings.Game.MouseScroll = (Game.Settings.Game.MouseScroll == MouseScrollType.Inverted) ? MouseScrollType.Standard : MouseScrollType.Inverted;
 
-			var teamchatCheckbox = general.Get<CheckboxWidget>("TEAMCHAT_TOGGLE");
-			teamchatCheckbox.IsChecked = () => Game.Settings.Game.TeamChatToggle;
-			teamchatCheckbox.OnClick = () => Game.Settings.Game.TeamChatToggle ^= true;
-
 			var showShellmapCheckbox = general.Get<CheckboxWidget>("SHOW_SHELLMAP");
 			showShellmapCheckbox.IsChecked = () => Game.Settings.Game.ShowShellmap;
 			showShellmapCheckbox.OnClick = () => Game.Settings.Game.ShowShellmap ^= true;

mods/ra/chrome/ingame-chat.yaml

@@ -2,59 +2,50 @@ Container@CHAT_PANEL:
 	X:(WINDOW_RIGHT - WIDTH) / 2
 	Y:WINDOW_BOTTOM - HEIGHT - 15
 	Width:550
-	Height:180
+	Height:194
 	Logic:IngameChatLogic
 	Children:
 		Container@CHAT_OVERLAY:
-			X:0
+			Width:PARENT_RIGHT-24
-			Y:0
+			Height:PARENT_BOTTOM-25
-			Width:PARENT_RIGHT
+			Visible:false
-			Height:PARENT_BOTTOM-30
-			Visible: false
 			Children:
 				ChatDisplay@CHAT_DISPLAY:
-					X:0
+					Width:PARENT_RIGHT
-					Y:0
+					Height:PARENT_BOTTOM
-					Width: PARENT_RIGHT
-					Height: PARENT_BOTTOM
-					DrawBackground: False
 					RemoveTime:250
 					UseContrast: yes
 		Container@CHAT_CHROME:
-			X:0
-			Y:0
 			Width:PARENT_RIGHT
 			Height:PARENT_BOTTOM
 			Children:
 				Button@CHAT_MODE:
-					X:0
 					Y:PARENT_BOTTOM - HEIGHT
-					Width: 50
+					Width:50
-					Height: 25
+					Height:25
-					Text: Team
+					Text:Team
-					Font: Bold
+					Font:Bold
 				TextField@CHAT_TEXTFIELD:
 					X:55
 					Y:PARENT_BOTTOM - HEIGHT
-					Width:465
+					Width:466
 					Height:25
 				Button@CHAT_CLOSE:
-					X:525
+					X:526
 					Y:PARENT_BOTTOM - HEIGHT
-					Width: 25
+					Width:24
-					Height: 25
+					Height:25
-					Text: X
+					Text:X
-					Font: Bold
+					Font:Bold
 				ScrollPanel@CHAT_SCROLLPANEL:
-					X:0
 					Y:PARENT_BOTTOM - HEIGHT - 30
 					Width:550
-					Height:150
+					Height:164
-					ItemSpacing:1
+					ItemSpacing:4
+					Align:Bottom
 					Children:
 						Container@CHAT_TEMPLATE:
 							X:2
-							Y:0
 							Width:PARENT_RIGHT-27
 							Height:16
 							Children:
@@ -64,8 +55,8 @@ Container@CHAT_PANEL:
 									Height:15
 									VAlign:Top
 								Label@TEXT:
-									X:10
+									X:12
-									Width:PARENT_RIGHT - 60
+									Width:PARENT_RIGHT - 17
 									Height:15
 									WordWrap:true
 									VAlign:Top

mods/ra/chrome/settings.yaml

@@ -104,12 +104,6 @@ Background@SETTINGS_MENU:
 					Width:200
 					Height:20
 					Text: Invert Mouse Drag Scrolling
-				Checkbox@TEAMCHAT_TOGGLE:
-					X:0
-					Y:120
-					Width:200
-					Height:20
-					Text: Shift-Enter Toggles Team Chat
 				Checkbox@SHOW_SHELLMAP:
 					X:0
 					Y:150