Customizable RuleTile Unity-Technologies#2 (Unity-Technologies#38)

* Add Rule Override Tile

* Fix new override tile error

* Add Rule Base RuleOverrideTile

* Change RuleOverrideTile base class to TileBase

This change allows RuleOverrideTile to use tile inherited from RuleTile, and to reduce the data stored by the asset.

* Fix new RuleOverrideTile error when tile is empty and Advanced enabled

* Customizable RuleTile

* Fix base class RuleTile have not display tooltip

Author: johnsoncodehk

Assets/Tilemap/Tiles/Rule Override Tile/Scripts/Editor/RuleOverrideTileEditor.cs

@@ -171,7 +171,7 @@ public void DrawOriginalRuleElement(Rect rect, RuleTile.TilingRule originalRule,
 					RuleTileEditor.RuleInspectorOnGUI(inspectorRect, originalRule);
 				else
 					RuleOriginalDefaultInspectorOnGUI(inspectorRect, originalRule);
-				RuleTileEditor.RuleMatrixOnGUI(matrixRect, originalRule);
+				RuleTileEditor.RuleMatrixOnGUI(overrideTile.m_Tile, matrixRect, originalRule);
 				RuleTileEditor.SpriteOnGUI(spriteRect, originalRule);
 			}
 		}

Assets/Tilemap/Tiles/Rule Tile/ScriptTemplates.meta

@@ -0,0 +1,29 @@
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using UnityEngine.Tilemaps;
+
+[CreateAssetMenu]
+public class #SCRIPTNAME# : RuleTile<#SCRIPTNAME#.Neighbor> {
+
+	public bool customField;
+
+	public class Neighbor : RuleTile.TilingRule.Neighbor {
+		public const int Null = 3;
+		public const int NotNull = 4;
+	}
+
+	public override bool RuleMatch(int neighbor, TileBase tile) {
+		switch (neighbor) {
+			case Neighbor.Null: return tile == null;
+			case Neighbor.NotNull: return tile != null;
+		}
+		return base.RuleMatch(neighbor, tile);
+	}
+
+#if UNITY_EDITOR
+	public override void RuleOnGUI(Rect rect, Vector2Int pos, int neighbor) {
+		base.RuleOnGUI(rect, pos, neighbor);
+	}
+#endif
+}

Assets/Tilemap/Tiles/Rule Tile/ScriptTemplates/NewCustomRuleTile.cs.txt

@@ -0,0 +1,17 @@
+namespace UnityEditor
+{
+	static class CustomRuleTileMenu
+	{
+		[MenuItem("Assets/Create/Custom Rule Tile Script", false, 89)]
+		static void CreateCustomRuleTile()
+		{
+			CreateScriptAsset("Assets/Tilemap/Tiles/Rule Tile/ScriptTemplates/NewCustomRuleTile.cs.txt", "NewCustomRuleTile.cs");
+		}
+		static void CreateScriptAsset(string templatePath, string destName)
+		{
+			typeof(ProjectWindowUtil)
+				.GetMethod("CreateScriptAsset", System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.NonPublic)
+				.Invoke(null, new object[] { templatePath, destName });
+		}
+	}
+}

Assets/Tilemap/Tiles/Rule Tile/ScriptTemplates/NewCustomRuleTile.cs.txt.meta

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using System.Linq;
 using UnityEditor.Sprites;
 using UnityEditorInternal;
 using UnityEngine;
@@ -10,44 +11,13 @@
 
 namespace UnityEditor
 {
-	[CustomEditor(typeof(RuleTile))]
+	[CustomEditor(typeof(RuleTile), true)]
 	[CanEditMultipleObjects]
 	internal class RuleTileEditor : Editor
 	{
-		private const string s_XIconString = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAABoSURBVDhPnY3BDcAgDAOZhS14dP1O0x2C/LBEgiNSHvfwyZabmV0jZRUpq2zi6f0DJwdcQOEdwwDLypF0zHLMa9+NQRxkQ+ACOT2STVw/q8eY1346ZlE54sYAhVhSDrjwFymrSFnD2gTZpls2OvFUHAAAAABJRU5ErkJggg==";
-		private const string s_Arrow0 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAACYSURBVDhPzZExDoQwDATzE4oU4QXXcgUFj+YxtETwgpMwXuFcwMFSRMVKKwzZcWzhiMg91jtg34XIntkre5EaT7yjjhI9pOD5Mw5k2X/DdUwFr3cQ7Pu23E/BiwXyWSOxrNqx+ewnsayam5OLBtbOGPUM/r93YZL4/dhpR/amwByGFBz170gNChA6w5bQQMqramBTgJ+Z3A58WuWejPCaHQAAAABJRU5ErkJggg==";
-		private const string s_Arrow1 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAABqSURBVDhPxYzBDYAgEATpxYcd+PVr0fZ2siZrjmMhFz6STIiDs8XMlpEyi5RkO/d66TcgJUB43JfNBqRkSEYDnYjhbKD5GIUkDqRDwoH3+NgTAw+bL/aoOP4DOgH+iwECEt+IlFmkzGHlAYKAWF9R8zUnAAAAAElFTkSuQmCC";
-		private const string s_Arrow2 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAAC0SURBVDhPjVE5EsIwDMxPKFKYF9CagoJH8xhaMskLmEGsjOSRkBzYmU2s9a58TUQUmCH1BWEHweuKP+D8tphrWcAHuIGrjPnPNY8X2+DzEWE+FzrdrkNyg2YGNNfRGlyOaZDJOxBrDhgOowaYW8UW0Vau5ZkFmXbbDr+CzOHKmLinAXMEePyZ9dZkZR+s5QX2O8DY3zZ/sgYcdDqeEVp8516o0QQV1qeMwg6C91toYoLoo+kNt/tpKQEVvFQAAAAASUVORK5CYII=";
-		private const string s_Arrow3 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAAB2SURBVDhPzY1LCoAwEEPnLi48gW5d6p31bH5SMhp0Cq0g+CCLxrzRPqMZ2pRqKG4IqzJc7JepTlbRZXYpWTg4RZE1XAso8VHFKNhQuTjKtZvHUNCEMogO4K3BhvMn9wP4EzoPZ3n0AGTW5fiBVzLAAYTP32C2Ay3agtu9V/9PAAAAAElFTkSuQmCC";
-		private const string s_Arrow5 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAABqSURBVDhPnY3BCYBADASvFx924NevRdvbyoLBmNuDJQMDGjNxAFhK1DyUQ9fvobCdO+j7+sOKj/uSB+xYHZAxl7IR1wNTXJeVcaAVU+614uWfCT9mVUhknMlxDokd15BYsQrJFHeUQ0+MB5ErsPi/6hO1AAAAAElFTkSuQmCC";
-		private const string s_Arrow6 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAACaSURBVDhPxZExEkAwEEVzE4UiTqClUDi0w2hlOIEZsV82xCZmQuPPfFn8t1mirLWf7S5flQOXjd64vCuEKWTKVt+6AayH3tIa7yLg6Qh2FcKFB72jBgJeziA1CMHzeaNHjkfwnAK86f3KUafU2ClHIJSzs/8HHLv09M3SaMCxS7ljw/IYJWzQABOQZ66x4h614ahTCL/WT7BSO51b5Z5hSx88AAAAAElFTkSuQmCC";
-		private const string s_Arrow7 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAABQSURBVDhPYxh8QNle/T8U/4MKEQdAmsz2eICx6W530gygr2aQBmSMphkZYxqErAEXxusKfAYQ7XyyNMIAsgEkaYQBkAFkaYQBsjXSGDAwAAD193z4luKPrAAAAABJRU5ErkJggg==";
-		private const string s_Arrow8 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAACYSURBVDhPxZE9DoAwCIW9iUOHegJXHRw8tIdx1egJTMSHAeMPaHSR5KVQ+KCkCRF91mdz4VDEWVzXTBgg5U1N5wahjHzXS3iFFVRxAygNVaZxJ6VHGIl2D6oUXP0ijlJuTp724FnID1Lq7uw2QM5+thoKth0N+GGyA7IA3+yM77Ag1e2zkey5gCdAg/h8csy+/89v7E+YkgUntOWeVt2SfAAAAABJRU5ErkJggg==";
 		private const string s_MirrorX = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwQAADsEBuJFr7QAAABh0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC41ZYUyZQAAAG1JREFUOE+lj9ENwCAIRB2IFdyRfRiuDSaXAF4MrR9P5eRhHGb2Gxp2oaEjIovTXSrAnPNx6hlgyCZ7o6omOdYOldGIZhAziEmOTSfigLV0RYAB9y9f/7kO8L3WUaQyhCgz0dmCL9CwCw172HgBeyG6oloC8fAAAAAASUVORK5CYII=";
 		private const string s_MirrorY = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABh0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC41ZYUyZQAAAG9JREFUOE+djckNACEMAykoLdAjHbPyw1IOJ0L7mAejjFlm9hspyd77Kk+kBAjPOXcakJIh6QaKyOE0EB5dSPJAiUmOiL8PMVGxugsP/0OOib8vsY8yYwy6gRyC8CB5QIWgCMKBLgRSkikEUr5h6wOPWfMoCYILdgAAAABJRU5ErkJggg==";
 		private const string s_Rotated = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwQAADsEBuJFr7QAAABh0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC41ZYUyZQAAAHdJREFUOE+djssNwCAMQxmIFdgx+2S4Vj4YxWlQgcOT8nuG5u5C732Sd3lfLlmPMR4QhXgrTQaimUlA3EtD+CJlBuQ7aUAUMjEAv9gWCQNEPhHJUkYfZ1kEpcxDzioRzGIlr0Qwi0r+Q5rTgM+AAVcygHgt7+HtBZs/2QVWP8ahAAAAAElFTkSuQmCC";
-		
-		private static Texture2D[] s_Arrows;
-		public static Texture2D[] arrows
-		{
-			get
-			{
-				if (s_Arrows == null)
-				{
-					s_Arrows = new Texture2D[10];
-					s_Arrows[0] = Base64ToTexture(s_Arrow0);
-					s_Arrows[1] = Base64ToTexture(s_Arrow1);
-					s_Arrows[2] = Base64ToTexture(s_Arrow2);
-					s_Arrows[3] = Base64ToTexture(s_Arrow3);
-					s_Arrows[5] = Base64ToTexture(s_Arrow5);
-					s_Arrows[6] = Base64ToTexture(s_Arrow6);
-					s_Arrows[7] = Base64ToTexture(s_Arrow7);
-					s_Arrows[8] = Base64ToTexture(s_Arrow8);
-					s_Arrows[9] = Base64ToTexture(s_XIconString);
-				}
-				return s_Arrows;
-			}
-		}
 
 		private static Texture2D[] s_AutoTransforms;
 		public static Texture2D[] autoTransforms
@@ -57,9 +27,9 @@ public static Texture2D[] autoTransforms
 				if (s_AutoTransforms == null)
 				{
 					s_AutoTransforms = new Texture2D[3];
-					s_AutoTransforms[0] = Base64ToTexture(s_Rotated);
-					s_AutoTransforms[1] = Base64ToTexture(s_MirrorX);
-					s_AutoTransforms[2] = Base64ToTexture(s_MirrorY);
+					s_AutoTransforms[0] = RuleTile.Base64ToTexture(s_Rotated);
+					s_AutoTransforms[1] = RuleTile.Base64ToTexture(s_MirrorX);
+					s_AutoTransforms[2] = RuleTile.Base64ToTexture(s_MirrorY);
 				}
 				return s_AutoTransforms;
 			}
@@ -121,7 +91,7 @@ private void OnDrawElement(Rect rect, int index, bool isactive, bool isfocused)
 
 			EditorGUI.BeginChangeCheck();
 			RuleInspectorOnGUI(inspectorRect, rule);
-			RuleMatrixOnGUI(matrixRect, rule);
+			RuleMatrixOnGUI(tile, matrixRect, rule);
 			SpriteOnGUI(spriteRect, rule);
 			if (EditorGUI.EndChangeCheck())
 				SaveTile();
@@ -151,13 +121,19 @@ public override void OnInspectorGUI()
 		{
 			tile.m_DefaultSprite = EditorGUILayout.ObjectField("Default Sprite", tile.m_DefaultSprite, typeof(Sprite), false) as Sprite;
 			tile.m_DefaultColliderType = (Tile.ColliderType)EditorGUILayout.EnumPopup("Default Collider", tile.m_DefaultColliderType);
+
+			var baseFields = typeof(RuleTile).GetFields().Select(field => field.Name);
+			var fields = target.GetType().GetFields().Select(field => field.Name).Where(field => !baseFields.Contains(field));
+			foreach (var field in fields)
+				EditorGUILayout.PropertyField(serializedObject.FindProperty(field), true);
+			
 			EditorGUILayout.Space();
 
 			if (m_ReorderableList != null && tile.m_TilingRules != null)
 				m_ReorderableList.DoLayoutList();
 		}
 
-		internal static void RuleMatrixOnGUI(Rect rect, RuleTile.TilingRule tilingRule)
+		internal static void RuleMatrixOnGUI(RuleTile tile, Rect rect, RuleTile.TilingRule tilingRule)
 		{
 			Handles.color = EditorGUIUtility.isProSkin ? new Color(1f, 1f, 1f, 0.2f) : new Color(0f, 0f, 0f, 0.2f);
 			int index = 0;
@@ -183,21 +159,20 @@ internal static void RuleMatrixOnGUI(Rect rect, RuleTile.TilingRule tilingRule)
 					Rect r = new Rect(rect.xMin + x * w, rect.yMin + y * h, w - 1, h - 1);
 					if (x != 1 || y != 1)
 					{
-						switch (tilingRule.m_Neighbors[index])
-						{
-							case RuleTile.TilingRule.Neighbor.This:
-								GUI.DrawTexture(r, arrows[y*3 + x]);
-								break;
-							case RuleTile.TilingRule.Neighbor.NotThis:
-								GUI.DrawTexture(r, arrows[9]);
-								break;
-						}
+						tile.RuleOnGUI(r, new Vector2Int(x, y), tilingRule.m_Neighbors[index]);
 						if (Event.current.type == EventType.MouseDown && r.Contains(Event.current.mousePosition))
 						{
                             int change = 1;
 						    if (Event.current.button == 1)
 								change = -1;
-							tilingRule.m_Neighbors[index] = (RuleTile.TilingRule.Neighbor) (((int)tilingRule.m_Neighbors[index] + change) % 3);
+
+							var allConsts = tile.m_NeighborType.GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy);
+							var neighbors = allConsts.Select(c => (int)c.GetValue(null)).ToList();
+							neighbors.Sort();
+
+							int oldIndex = neighbors.IndexOf(tilingRule.m_Neighbors[index]);
+							int newIndex = (int)Mathf.Repeat(oldIndex + change, neighbors.Count);
+							tilingRule.m_Neighbors[index] = neighbors[newIndex];
 							GUI.changed = true;
 							Event.current.Use();
 						}
@@ -351,14 +326,6 @@ private static Type GetType(string TypeName)
 			}
 			return null;
 		}
-
-		private static Texture2D Base64ToTexture(string base64)
-		{
-			Texture2D t = new Texture2D(1, 1);
-			t.hideFlags = HideFlags.HideAndDontSave;
-			t.LoadImage(System.Convert.FromBase64String(base64));
-			return t;
-		}
 
 		[Serializable]
 		class RuleTileRuleWrapper