feat: Added layer sorting option

Author: WMsans

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.Linq;
+using UnityEngine;
 
 namespace LDtkUnity.Editor
 {
@@ -102,8 +103,9 @@ private void BuildLevelProcess()
             AddIidComponent();
             LDtkProfiler.EndSample();
 
-            LDtkProfiler.BeginSample("new LDtkSortingOrder");
-            _sortingOrder = new LDtkSortingOrder();
+            LDtkProfiler.BeginSample("LDtkSortingOrder");
+            var sortingOrders = _project.LayerSortingOrders.ToDictionary(x => x.Layer, x => x.Order);
+            _sortingOrder = new LDtkSortingOrder(sortingOrders);
             LDtkProfiler.EndSample();
 
             LDtkProfiler.BeginSample("BuildLayerInstances");

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,12 +1,29 @@
-namespace LDtkUnity.Editor
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace LDtkUnity.Editor
 {
     internal sealed class LDtkSortingOrder
     {
         public int SortingOrderValue { get; private set; } = 0;
+        private readonly Dictionary<string, int> _overrides;
+        private int _autoValue = 0;
+
+        public LDtkSortingOrder(Dictionary<string, int> overrides = null)
+        {
+            _overrides = overrides;
+        }
 
-        public void Next()
+        public void Next(string layerIdentifier = null)
         {
-            SortingOrderValue--;
+            if (layerIdentifier != null && _overrides != null && _overrides.TryGetValue(layerIdentifier, out int order))
+            {
+                SortingOrderValue = order;
+                Debug.Log(order);
+                return;
+            }
+            
+            SortingOrderValue = --_autoValue;
         }
     }
 }

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

@@ -57,6 +57,11 @@ internal sealed class LDtkSectionMain : LDtkSectionDrawer
             text = "Scale Entities",
             tooltip = "Apply a scale factor to entity prefab instances if they were resized in LDtk."
         };
+        private static readonly GUIContent CustomSortingOrders = new GUIContent
+        {
+            text = "Custom Sorting Orders",
+            tooltip = "Enable this to customize the sorting order for specific layers. If disabled, layers will automatically decrement starting from 0."
+        };
 
         protected override string GuiText => "Main";
         protected override string GuiTooltip => "This is the importer menu.\n" +
@@ -107,10 +112,56 @@ protected override void DrawDropdownContent()
             DrawField(CreateLevelBoundsTrigger, LDtkProjectImporter.CREATE_LEVEL_BOUNDS_TRIGGER);
             DrawField(UseParallax, LDtkProjectImporter.USE_PARALLAX);
             DrawField(ScaleEntities, LDtkProjectImporter.SCALE_ENTITIES);
+            
+            DrawLayerSortingOrders(); 
 
             Editor.DrawDependenciesProperty();
         }
 
+        private void DrawLayerSortingOrders()
+        {
+            SerializedProperty customProp = DrawField(CustomSortingOrders, LDtkProjectImporter.CUSTOM_SORTING_ORDERS);
+
+            if (!customProp.boolValue)
+            {
+                return;
+            }
+
+            SerializedProperty sortingOrderArray = SerializedObject.FindProperty(LDtkProjectImporter.LAYER_SORTING_ORDERS);
+            
+            // Sync array with data
+            LayerDefinition[] layers = _data.Defs.Layers;
+            if (sortingOrderArray.arraySize != layers.Length)
+            {
+                sortingOrderArray.arraySize = layers.Length;
+            }
+
+            for (int i = 0; i < layers.Length; i++)
+            {
+                SerializedProperty element = sortingOrderArray.GetArrayElementAtIndex(i);
+                SerializedProperty layerNameProp = element.FindPropertyRelative("Layer");
+                SerializedProperty orderProp = element.FindPropertyRelative("Order");
+
+                string layerName = layers[i].Identifier;
+                
+                // If name is different or empty (newly created), set it and default order
+                if (layerNameProp.stringValue != layerName)
+                {
+                    layerNameProp.stringValue = layerName;
+                    // Default auto generated value: -1, -2, etc. (starts at 0 and decrements)
+                    orderProp.intValue = -(i + 1);
+                }
+
+                EditorGUILayout.BeginHorizontal();
+                using (new EditorGUI.DisabledScope(true))
+                {
+                    EditorGUILayout.TextField(layerNameProp.stringValue);
+                }
+                EditorGUILayout.PropertyField(orderProp, GUIContent.none);
+                EditorGUILayout.EndHorizontal();
+            }
+        }
+
         private void PixelsPerUnitField()
         {
             GUIContent content = new GUIContent(PixelsPerUnit)

Assets/LDtkUnity/Editor/ScriptedImporter/LDtkProjectImporter.cs

@@ -38,6 +38,8 @@ internal sealed class LDtkProjectImporter : LDtkJsonImporter<LDtkProjectFile>
         public const string ENUM_GENERATE = nameof(_enumGenerate);
         public const string ENUM_PATH = nameof(_enumPath);
         public const string ENUM_NAMESPACE = nameof(_enumNamespace);
+        public const string CUSTOM_SORTING_ORDERS = nameof(_customSortingOrders);
+        public const string LAYER_SORTING_ORDERS = nameof(_layerSortingOrders); 
 
 
         /// <summary>
@@ -63,6 +65,16 @@ internal sealed class LDtkProjectImporter : LDtkJsonImporter<LDtkProjectFile>
         [SerializeField] private string _enumPath = null;
         [SerializeField] private string _enumNamespace = string.Empty;
 
+        [SerializeField] private bool _customSortingOrders = false;
+        
+        [Serializable]
+        public struct LayerSortingOrder
+        {
+            public string Layer;
+            public int Order;
+        }
+        [SerializeField] private LayerSortingOrder[] _layerSortingOrders = Array.Empty<LayerSortingOrder>(); 
+
 
         public LDtkProjectFile JsonFile => _jsonFile;
         public bool IntGridValueColorsVisible => _intGridValueColorsVisible;
@@ -74,6 +86,8 @@ internal sealed class LDtkProjectImporter : LDtkJsonImporter<LDtkProjectFile>
         public bool CreateLevelBoundsTrigger => _createLevelBoundsTrigger;
         public bool UseParallax => _useParallax;
         public bool ScaleEntities => _scaleEntities;
+        public bool CustomSortingOrders => _customSortingOrders;
+        public LayerSortingOrder[] LayerSortingOrders => _customSortingOrders ? _layerSortingOrders : Array.Empty<LayerSortingOrder>(); 
 
         //all of these are wiped after the entire import is done
         private LDtkArtifactAssets _artifacts;
@@ -424,4 +438,4 @@ public Sprite GetBackgroundArtifact(Level level)
             return asset;
         }
     }
-}
+}