Add script tags to map editor actor properties.

Author: darkademic

OpenRA.Mods.Common/Traits/ScriptTags.cs

@@ -9,15 +9,43 @@
  */
 #endregion
 
+using System;
 using System.Collections.Generic;
+using System.Linq;
 using OpenRA.Traits;
 
 namespace OpenRA.Mods.Common.Traits
 {
 	[Desc("Allows this actor to be 'tagged' with arbitrary strings. Tags must be unique or they will be rejected.")]
-	public class ScriptTagsInfo : TraitInfo
+	public class ScriptTagsInfo : TraitInfo, IEditorActorOptions
 	{
+		[Desc("Display order for the script tags text field in the map editor")]
+		public readonly int EditorScriptTagsDisplayOrder = 5;
+
 		public override object Create(ActorInitializer init) { return new ScriptTags(init, this); }
+
+		IEnumerable<EditorActorOption> IEditorActorOptions.ActorOptions(ActorInfo ai, World world)
+		{
+			yield return new EditorActorTextField("Tags", EditorScriptTagsDisplayOrder,
+				actor =>
+				{
+					var init = actor.GetInitOrDefault<ScriptTagsInit>(this);
+					if (init != null)
+						return string.Join(", ", init.Value);
+
+					return "";
+				},
+				(actor, value) =>
+				{
+					var tags = string.IsNullOrWhiteSpace(value)
+						? Array.Empty<string>() :
+						value.Split(',').Select(t => t.Trim()).Where(t => !string.IsNullOrWhiteSpace(t)).ToArray();
+					if (tags.Length == 0)
+						actor.RemoveInit<ScriptTagsInit>(this);
+					else
+						actor.ReplaceInit(new ScriptTagsInit(tags), this);
+				});
+		}
 	}
 
 	public class ScriptTags

OpenRA.Mods.Common/TraitsInterfaces.cs

@@ -715,6 +715,21 @@ public EditorActorDropdown(string name, int displayOrder,
 		}
 	}
 
+	public class EditorActorTextField : EditorActorOption
+	{
+		public readonly Func<EditorActorPreview, string> GetValue;
+		public readonly Action<EditorActorPreview, string> OnChange;
+
+		public EditorActorTextField(string name, int displayOrder,
+			Func<EditorActorPreview, string> getValue,
+			Action<EditorActorPreview, string> onChange)
+			: base(name, displayOrder)
+		{
+			GetValue = getValue;
+			OnChange = onChange;
+		}
+	}
+
 	[RequireExplicitImplementation]
 	public interface INotifyEditorPlacementInfo : ITraitInfoInterface
 	{

OpenRA.Mods.Common/Widgets/Logic/Editor/ActorEditLogic.cs

@@ -50,6 +50,7 @@ enum ActorIDStatus { Normal = 0, Duplicate = 1, Empty = 3 }
 		readonly Widget checkboxOptionTemplate;
 		readonly Widget sliderOptionTemplate;
 		readonly Widget dropdownOptionTemplate;
+		readonly Widget textFieldOptionTemplate;
 
 		ActorIDStatus actorIDStatus = ActorIDStatus.Normal;
 		ActorIDStatus nextActorIDStatus = ActorIDStatus.Normal;
@@ -84,6 +85,7 @@ public ActorEditLogic(Widget widget, World world, WorldRenderer worldRenderer, D
 			checkboxOptionTemplate = initContainer.Get("CHECKBOX_OPTION_TEMPLATE");
 			sliderOptionTemplate = initContainer.Get("SLIDER_OPTION_TEMPLATE");
 			dropdownOptionTemplate = initContainer.Get("DROPDOWN_OPTION_TEMPLATE");
+			textFieldOptionTemplate = initContainer.Get("TEXTFIELD_OPTION_TEMPLATE");
 			initContainer.RemoveChildren();
 
 			var deleteButton = actorEditPanel.Get<ButtonWidget>("DELETE_BUTTON");
@@ -319,6 +321,31 @@ ScrollItemWidget DropdownSetup(KeyValuePair<string, string> option, ScrollItemWi
 
 						initContainer.AddChild(dropdownContainer);
 					}
+					else if (o is EditorActorTextField tfo)
+					{
+						var textFieldContainer = textFieldOptionTemplate.Clone();
+						textFieldContainer.Bounds.Y = initContainer.Bounds.Height;
+						initContainer.Bounds.Height += textFieldContainer.Bounds.Height;
+						textFieldContainer.Get<LabelWidget>("LABEL").GetText = () => tfo.Name;
+
+						var editorActionHandle = new EditorActorOptionActionHandle<string>(tfo.OnChange, tfo.GetValue(SelectedActor));
+						editActorPreview.Add(editorActionHandle);
+
+						var textField = textFieldContainer.Get<TextFieldWidget>("OPTION");
+						textField.Text = tfo.GetValue(SelectedActor);
+
+						textField.OnTextEdited = () =>
+						{
+							tfo.OnChange(SelectedActor, textField.Text);
+							editorActionHandle.OnChange(textField.Text);
+						};
+
+						textField.OnEscKey = _ => { textField.YieldKeyboardFocus(); return true; };
+						textField.OnEnterKey = _ => { textField.YieldKeyboardFocus(); return true; };
+						typableFields.Add(textField);
+
+						initContainer.AddChild(textFieldContainer);
+					}
 				}
 
 				buttonContainer.Bounds.Y += initContainer.Bounds.Height - oldInitHeight;

mods/cnc/chrome/editor.yaml

@@ -783,6 +783,20 @@ Container@EDITOR_WORLD_ROOT:
 											Width: 213
 											Height: 25
 											Font: Bold
+								Container@TEXTFIELD_OPTION_TEMPLATE:
+									Width: PARENT_WIDTH
+									Height: 27
+									Children:
+										Label@LABEL:
+											Y: 1
+											Width: 55
+											Height: 25
+											Align: Right
+										TextField@OPTION:
+											X: 69
+											Y: 1
+											Width: 213
+											Height: 25
 						Container@BUTTON_CONTAINER:
 							Y: 70
 							Children:

mods/common/chrome/editor.yaml

@@ -751,6 +751,20 @@ Container@EDITOR_WORLD_ROOT:
 											Width: 213
 											Height: 25
 											Font: Bold
+								Container@TEXTFIELD_OPTION_TEMPLATE:
+									Width: PARENT_WIDTH
+									Height: 27
+									Children:
+										Label@LABEL:
+											Y: 1
+											Width: 55
+											Height: 25
+											Align: Right
+										TextField@OPTION:
+											X: 69
+											Y: 1
+											Width: 213
+											Height: 25
 						Container@BUTTON_CONTAINER:
 							Y: 75
 							Children: