Merge branch 'pr/67'

Author: Cammin

Assets/LDtkUnity/Editor/Builders/LDtkBuilderEntity.cs

@@ -24,7 +24,7 @@ public LDtkBuilderEntity(LDtkProjectImporter project, Level level, LDtkComponent
 
         public LDtkComponentEntity[] BuildEntityLayerInstances()
         {
-            SortingOrder.Next();
+            SortingOrder.Next(Layer.Identifier);
 
             LDtkFieldParser.CacheRecentBuilder(this);
 

Assets/LDtkUnity/Editor/Builders/LDtkBuilderIntGridValue.cs

@@ -17,7 +17,7 @@ public LDtkBuilderIntGridValue(LDtkProjectImporter importer, Level level, LDtkCo
         public void BuildIntGridValues()
         {
             RoundTilemapPos();
-            SortingOrder.Next();
+            SortingOrder.Next(Layer.Identifier); 
 
             LayerDefinition layerDef = Layer.Definition;
             IntGridValueDefinition[] intGridValueDefs = layerDef.IntGridValues;

Assets/LDtkUnity/Editor/Builders/LDtkBuilderLevel.cs

@@ -1,4 +1,5 @@
-using UnityEngine;
+using System.Collections.Generic;
+using UnityEngine;
 
 namespace LDtkUnity.Editor
 {
@@ -102,8 +103,8 @@ private void BuildLevelProcess()
             AddIidComponent();
             LDtkProfiler.EndSample();
 
-            LDtkProfiler.BeginSample("new LDtkSortingOrder");
-            _sortingOrder = new LDtkSortingOrder();
+            LDtkProfiler.BeginSample("LDtkSortingOrder");
+            CreateSortingOrder();
             LDtkProfiler.EndSample();
 
             LDtkProfiler.BeginSample("BuildLayerInstances");
@@ -131,6 +132,24 @@ private void BuildLevelProcess()
             LDtkProfiler.EndSample();
         }
 
+        private void CreateSortingOrder()
+        {
+            var orders = _project.LayerCustomSortingOrders;
+
+            if (!_project.UseLayerCustomSortingOrders || orders.IsNullOrEmpty())
+            {
+                _sortingOrder = new LDtkSortingOrder();
+                return;
+            }
+
+            var sortingOrders = new Dictionary<string, int>(orders.Length);
+            foreach (LDtkLayerCustomSortingOrder order in orders)
+            {
+                sortingOrders.Add(order._ldtkLayerName, order._ldtkLayerOrder);
+            }
+            _sortingOrder = new LDtkSortingOrder(sortingOrders);
+        }
+
         private void BuildFields()
         {
             bool addedFields = TryAddFields();

Assets/LDtkUnity/Editor/Builders/LDtkBuilderTileset.cs

@@ -21,7 +21,7 @@ public LDtkBuilderTileset(LDtkProjectImporter project, Level level, LDtkComponen
 
         private void ConstructNewTilemap()
         {
-            SortingOrder.Next();
+            SortingOrder.Next(Layer.Identifier);
 
             string tilemapName = Layer.IsTilesLayer ? "Tiles" : "AutoLayer";
 

Assets/LDtkUnity/Editor/Builders/LDtkSortingOrder.cs

@@ -1,11 +1,41 @@
-namespace LDtkUnity.Editor
+using System.Collections.Generic;
+
+namespace LDtkUnity.Editor
 {
+    /// <summary>
+    /// Increments for each occurrence of a tilemap or entity when building layers to ensure everything is layered correctly.
+    /// This can be overridden to jump to custom-set sorting order numbers if needed.
+    /// </summary>
     internal sealed class LDtkSortingOrder
     {
         public int SortingOrderValue { get; private set; } = 0;
+        private readonly Dictionary<string, int> _layerNameOverrides;
+        private readonly HashSet<string> _layerNameOccurrences;
+
+        public LDtkSortingOrder(Dictionary<string, int> layerNameOverrides = null)
+        {
+            _layerNameOverrides = layerNameOverrides;
 
-        public void Next()
+            if (layerNameOverrides != null)
+            {
+                _layerNameOccurrences = new HashSet<string>(layerNameOverrides.Count);
+            }
+        }
+        
+        public void Next(string layerIdentifier = null)
         {
+            //note: this supports repeated layer occurrences, even if that never happens.
+            
+            //Jump to the custom order if we get the first occurrence of a layer
+            if (layerIdentifier != null && _layerNameOccurrences != null && _layerNameOccurrences.Add(layerIdentifier))
+            {
+                if (_layerNameOverrides != null && _layerNameOverrides.TryGetValue(layerIdentifier, out int order))
+                {
+                    SortingOrderValue = order;
+                    return;
+                }
+            }
+            
             SortingOrderValue--;
         }
     }

Assets/LDtkUnity/Editor/CustomEditor/Importer/LDtkProjectImporterEditor.cs

@@ -17,6 +17,7 @@ internal sealed class LDtkProjectImporterEditor : LDtkImporterEditor
         private LDtkSectionIntGrids _sectionIntGrids;
         private LDtkSectionEntities _sectionEntities;
         private LDtkSectionEnums _sectionEnums;
+        private LDtkSectionLayerCustomSortingOrder _sectionCustomSortingOrder;
         private bool _shouldApply = true;
 
 
@@ -41,13 +42,15 @@ public override void OnEnable()
             _sectionIntGrids = new LDtkSectionIntGrids(this, serializedObject);
             _sectionEntities = new LDtkSectionEntities(this, serializedObject);
             _sectionEnums = new LDtkSectionEnums(this, serializedObject);
+            _sectionCustomSortingOrder = new LDtkSectionLayerCustomSortingOrder(this, serializedObject);
 
             _sectionDrawers = new[]
             {
                 (ILDtkSectionDrawer)_sectionMain,
                 _sectionIntGrids,
                 _sectionEntities,
                 _sectionEnums,
+                _sectionCustomSortingOrder,
                 SectionDependencies
             };
 
@@ -175,6 +178,10 @@ private void ShowGUI()
             _sectionEnums.Draw(defs.Enums);
             LDtkProfiler.EndSample();            
 
+            LDtkProfiler.BeginSample("CustomSortingOrderSection");
+            _sectionCustomSortingOrder.Draw(defs.Layers);
+            LDtkProfiler.EndSample();        
+            
             LDtkProfiler.BeginSample("DependenciesSection");
             SectionDependencies.Draw();
             LDtkProfiler.EndSample();

Assets/LDtkUnity/Editor/CustomEditor/SectionDrawers/LDtkSectionDataDrawer.cs

@@ -157,8 +157,9 @@ private void AddMissingData(string[] newAssetKeys)
             SerializedProperty[] elements = ArrayProp.GetArrayElements();
             string[] elementKeys = elements.Select(GetKeyForElement).ToArray();
 
-            foreach (string newAssetKey in newAssetKeys)
+            for (var i = 0; i < newAssetKeys.Length; i++)
             {
+                string newAssetKey = newAssetKeys[i];
                 if (elementKeys.Contains(newAssetKey))
                 {
                     //we previously already have it, don't add one
@@ -173,12 +174,17 @@ private void AddMissingData(string[] newAssetKeys)
                 insertedKeyProp.stringValue = newAssetKey;
 
                 SerializedProperty insertedValueProp = GetValuePropForElement(insertedProp);
-                insertedValueProp.objectReferenceValue = null;
+                SetDefaultElementValue(insertedValueProp, i);
 
                 //Debug.Log($"Inserted new asset at {0} for key {newAssetKey}");
             }
         }
-        
+
+        protected virtual void SetDefaultElementValue(SerializedProperty insertedValueProp, int i)
+        {
+            insertedValueProp.objectReferenceValue = null;
+        }
+
         private void BubbleSortArray(string[] assetKeys)
         {
             if (ArrayProp.arraySize != assetKeys.Length)
@@ -251,11 +257,11 @@ private SerializedProperty GetKeyPropForArray(int arrayIndex)
             SerializedProperty element = ArrayProp.GetArrayElementAtIndex(arrayIndex);
             return GetKeyPropForElement(element);
         }
-        private SerializedProperty GetKeyPropForElement(SerializedProperty element)
+        protected virtual SerializedProperty GetKeyPropForElement(SerializedProperty element)
         {
             return element.FindPropertyRelative(LDtkAsset<Object>.PROPERTY_KEY);
         }
-        private SerializedProperty GetValuePropForElement(SerializedProperty element)
+        protected virtual SerializedProperty GetValuePropForElement(SerializedProperty element)
         {
             return element.FindPropertyRelative(LDtkAsset<Object>.PROPERTY_ASSET);
         }

Assets/LDtkUnity/Editor/CustomEditor/SectionDrawers/LDtkSectionLayerCustomSortingOrder.cs

@@ -0,0 +1,67 @@
+using System.Collections.Generic;
+using UnityEditor;
+using UnityEngine;
+
+namespace LDtkUnity.Editor
+{
+    internal sealed class LDtkSectionLayerCustomSortingOrder : LDtkSectionDataDrawer<LayerDefinition>
+    {
+        private SerializedProperty _useProp;
+        private static GUIContent _usePropLabel = new GUIContent("Use Custom Sorting Orders");
+        
+        protected override string PropertyName => LDtkProjectImporter.LAYER_SORTING_ORDERS;
+        protected override string GuiText => "Custom Sorting Orders";
+
+        protected override string GuiTooltip =>
+            "Normally in the import process, the sorting order is decremented for all occurrences of LDtk layers, starting from 0.\n" +
+            "However, this option can be toggled on to customize sorting orders for specific layers.";
+        
+        protected override Texture GuiImage => LDtkIconUtility.LoadLayerIcon();
+        protected override string ReferenceLink => LDtkHelpURL.SECTION_CUSTOM_SORTING_ORDER;
+
+        public LDtkSectionLayerCustomSortingOrder(LDtkImporterEditor editor, SerializedObject serializedObject) : base(editor, serializedObject)
+        {
+        }
+
+        public override void Init()
+        {
+            base.Init();
+            _useProp = SerializedObject.FindProperty(LDtkProjectImporter.USE_LAYER_SORTING_ORDERS);
+        }
+        
+        protected override void GetDrawers(LayerDefinition[] defs, List<LDtkContentDrawer<LayerDefinition>> drawers)
+        {
+            for (var i = 0; i < defs.Length; i++)
+            {
+                LDtkDrawerLayerCustomSortingOrder drawer = 
+                    new LDtkDrawerLayerCustomSortingOrder(defs[i], ArrayProp.GetArrayElementAtIndex(i));
+                
+                drawers.Add(drawer);
+            }
+        }
+        
+        protected override void DrawDropdownContent()
+        {
+            EditorGUILayout.PropertyField(_useProp, _usePropLabel);
+            using (new EditorGUI.DisabledScope(!_useProp.boolValue))
+            {
+                base.DrawDropdownContent();
+            }
+        }
+
+        protected override SerializedProperty GetKeyPropForElement(SerializedProperty element)
+        {
+            return element.FindPropertyRelative(LDtkLayerCustomSortingOrder.NAME);
+        }
+
+        protected override SerializedProperty GetValuePropForElement(SerializedProperty element)
+        {
+            return element.FindPropertyRelative(LDtkLayerCustomSortingOrder.ORDER);
+        }
+
+        protected override void SetDefaultElementValue(SerializedProperty insertedValueProp, int i)
+        {
+            insertedValueProp.intValue = -i;
+        }
+    }
+}

Assets/LDtkUnity/Editor/CustomEditor/SectionDrawers/LDtkSectionLayerCustomSortingOrder.cs.meta

@@ -107,7 +107,7 @@ protected override void DrawDropdownContent()
             DrawField(CreateLevelBoundsTrigger, LDtkProjectImporter.CREATE_LEVEL_BOUNDS_TRIGGER);
             DrawField(UseParallax, LDtkProjectImporter.USE_PARALLAX);
             DrawField(ScaleEntities, LDtkProjectImporter.SCALE_ENTITIES);
-
+            
             Editor.DrawDependenciesProperty();
         }