World Generator as a scriptable object

coryleach · coryleach · commit e391cf44cb19 · 2020-06-04T17:23:13.000-04:00
diff --git a/Demo/Demo-URP.unitypackage b/Demo/Demo-URP.unitypackage
diff --git a/Editor/WorldMapGeneratorEditor.cs b/Editor/WorldMapGeneratorEditor.cs
@@ -3,7 +3,7 @@
 
 namespace Gameframe.Procgen
 {
-    [CustomEditor(typeof(WorldMapGenerator), true)]
+    [CustomEditor(typeof(WorldMapGenController), true)]
     public class WorldMapGeneratorEditor : Editor
     {
         private bool autoUpdate = false;
@@ -14,14 +14,14 @@ public override void OnInspectorGUI()
             base.OnInspectorGUI();
             if (EditorGUI.EndChangeCheck() && autoUpdate)
             {
-                ((WorldMapGenerator) target).GenerateMap();
+                ((WorldMapGenController) target).GenerateMap();
             }
 
             autoUpdate = EditorGUILayout.Toggle("Auto Update", autoUpdate);
 
             if (GUILayout.Button("Generate"))
             {
-                ((WorldMapGenerator) target).GenerateMap();
+                ((WorldMapGenController) target).GenerateMap();
             }
         }
     }
diff --git a/Runtime/WorldMap/IWorldMapLayerData.cs b/Runtime/WorldMap/IWorldMapLayerData.cs
@@ -0,0 +1,6 @@
+﻿namespace Gameframe.Procgen
+{
+  public interface IWorldMapLayerData
+  {
+  }
+}
diff --git a/Runtime/WorldMap/IWorldMapLayerData.cs.meta b/Runtime/WorldMap/IWorldMapLayerData.cs.meta
diff --git a/Runtime/WorldMap/Layers/HeightMapLayerData.cs b/Runtime/WorldMap/Layers/HeightMapLayerData.cs
@@ -1,7 +1,7 @@
 ﻿namespace Gameframe.Procgen
 {
     [System.Serializable]
-    public class HeightMapLayerData : WorldMapLayerData
+    public class HeightMapLayerData : IWorldMapLayerData
     {
         public float[] heightMap;
     }
diff --git a/Runtime/WorldMap/Layers/HeightMapLayerGenerator.cs b/Runtime/WorldMap/Layers/HeightMapLayerGenerator.cs
@@ -3,8 +3,8 @@
 
 namespace Gameframe.Procgen
 {
-    [CreateAssetMenu]
-    public class HeightMapLayerGenerator : ScriptableObject
+    [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/HeightMapLayerGenerator")]
+    public class HeightMapLayerGenerator : WorldMapLayerGenerator
     {
         public enum MapType
         {
@@ -66,7 +66,7 @@ public HeightMapLayerData Generate(int width, int height, int seed)
             };
         }
 
-        public void AddToWorld(WorldMapData worldMapData)
+        public override void AddToWorld(WorldMapData worldMapData)
         {
             worldMapData.layers.Add(Generate(worldMapData.width,worldMapData.height,worldMapData.seed));
         }
diff --git a/Runtime/WorldMap/Layers/PoissonMapLayerData.cs b/Runtime/WorldMap/Layers/PoissonMapLayerData.cs
@@ -4,7 +4,7 @@
 namespace Gameframe.Procgen
 {
     [System.Serializable]
-    public class PoissonMapLayerData : WorldMapLayerData
+    public class PoissonMapLayerData : IWorldMapLayerData
     {
         public List<Vector2Int> points = new List<Vector2Int>();
     }
diff --git a/Runtime/WorldMap/Layers/PoissonMapLayerGenerator.cs b/Runtime/WorldMap/Layers/PoissonMapLayerGenerator.cs
@@ -2,15 +2,15 @@
 
 namespace Gameframe.Procgen
 {
-  [CreateAssetMenu]
-  public class PoissonMapLayerGenerator : ScriptableObject
+  [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/PoissonMapLayerGenerator")]
+  public class PoissonMapLayerGenerator : WorldMapLayerGenerator
   {
     public float radius = 10;
     public int maxSamplesPerPoint = 30;
     public bool useRegions = true;
     public int edgeAvoidance = 0;
 
-    public void AddToWorld(WorldMapData mapData)
+    public override void AddToWorld(WorldMapData mapData)
     {
       if (useRegions)
       {
diff --git a/Runtime/WorldMap/Layers/RegionMapLayerData.cs b/Runtime/WorldMap/Layers/RegionMapLayerData.cs
@@ -4,7 +4,7 @@
 namespace Gameframe.Procgen
 {
     [System.Serializable]
-    public class RegionMapLayerData : WorldMapLayerData
+    public class RegionMapLayerData : IWorldMapLayerData
     {
         public int[] regionMap;
         public List<RegionData> regions = new List<RegionData>();
diff --git a/Runtime/WorldMap/Layers/RegionMapLayerGenerator.cs b/Runtime/WorldMap/Layers/RegionMapLayerGenerator.cs
@@ -4,13 +4,13 @@
 
 namespace Gameframe.Procgen
 {
-  [CreateAssetMenu]
-  public class RegionMapLayerGenerator : ScriptableObject
+  [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/RegionMapLayerGenerator")]
+  public class RegionMapLayerGenerator : WorldMapLayerGenerator
   {
     public int regionCount = 5;
     public float waterLevel = 0.2380952f;
 
-    public void AddToWorld(WorldMapData mapData)
+    public override void AddToWorld(WorldMapData mapData)
     {
       var rng = new System.Random(mapData.seed);
       var regionLayer = new RegionMapLayerData();
diff --git a/Runtime/WorldMap/Layers/WorldMapLayerData.cs b/Runtime/WorldMap/Layers/WorldMapLayerData.cs
diff --git a/Runtime/WorldMap/Layers/WorldMapLayerGenerator.cs b/Runtime/WorldMap/Layers/WorldMapLayerGenerator.cs
@@ -4,6 +4,6 @@ namespace Gameframe.Procgen
 {
   public abstract class WorldMapLayerGenerator : ScriptableObject
   {
-    public abstract void AddToMap(WorldMapData mapData);
+    public abstract void AddToWorld(WorldMapData mapData);
   }
 }
diff --git a/Runtime/WorldMap/Views/WorldMapVoxelMeshView.cs b/Runtime/WorldMap/Views/WorldMapVoxelMeshView.cs
@@ -15,9 +15,7 @@ public class WorldMapVoxelMeshView : MonoBehaviour, IWorldMapView
     [SerializeField] private int chunkWidth = 16;
 
     [SerializeField] private int chunkHeight = 16;
-
-    [SerializeField] private WorldMapGenerator _generator;
-
+    
     [SerializeField] private bool edges = false;
 
     [SerializeField] private float edgeThickness = 1f;
@@ -26,12 +24,11 @@ public class WorldMapVoxelMeshView : MonoBehaviour, IWorldMapView
 
     [SerializeField] private List<WorldMapViewChunk> chunkList = new List<WorldMapViewChunk>();
 
+    /// <summary>
+    /// Start method here exists just to give us the enable checkbox in the inspector
+    /// </summary>
     public void Start()
     {
-      if (_generator != null)
-      {
-
-      }
     }
 
     private void OnDisable()
diff --git a/Runtime/WorldMap/WorldMapData.cs b/Runtime/WorldMap/WorldMapData.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using UnityEngine;
 
 namespace Gameframe.Procgen
 {
@@ -8,14 +9,16 @@ public class WorldMapData
         public int seed;
         public int width;
         public int height;
-        public List<WorldMapLayerData> layers = new List<WorldMapLayerData>();
+        
+        [SerializeReference]
+        public List<IWorldMapLayerData> layers = new List<IWorldMapLayerData>();
 
         /// <summary>
         /// Gets the first layer of the specified type
         /// </summary>
         /// <typeparam name="T">Type derived from WorldMapLayerData</typeparam>
         /// <returns>Returns the first layer of the requested type found. Otherwise null if no layer of that type exists.</returns>
-        public T GetLayer<T>() where T : WorldMapLayerData
+        public T GetLayer<T>() where T : class, IWorldMapLayerData
         {
             foreach (var layer in layers)
             {
diff --git a/Runtime/WorldMap/WorldMapGenController.cs b/Runtime/WorldMap/WorldMapGenController.cs
@@ -0,0 +1,39 @@
+﻿//Ignore those dumb 'never assigned to' warnings cuz this is Unity and our fields are serialized 
+#pragma warning disable CS0649
+
+using UnityEngine;
+
+namespace Gameframe.Procgen
+{
+    public class WorldMapGenController : MonoBehaviour
+    {
+        [SerializeField] private WorldMapGenerator _generator = null;
+        
+        [SerializeField] private int seed = 100;
+
+        [SerializeField, HideInInspector] private WorldMapData _mapData;
+
+        private void Start()
+        {
+            GenerateMap();
+        }
+
+        [ContextMenu("GenerateMap")]
+        public void GenerateMap()
+        {
+            _mapData = _generator.GenerateMap(seed);
+            DisplayMap(_mapData);
+        }
+
+        private void DisplayMap(WorldMapData mapData)
+        {
+            var mapViews = GetComponents<IWorldMapView>();
+            foreach (var view in mapViews)
+            {
+                view.DisplayMap(mapData);
+            }
+        }
+
+    }
+
+}
diff --git a/Runtime/WorldMap/WorldMapGenController.cs.meta b/Runtime/WorldMap/WorldMapGenController.cs.meta
diff --git a/Runtime/WorldMap/WorldMapGenerator.cs b/Runtime/WorldMap/WorldMapGenerator.cs
@@ -1,66 +1,44 @@
-﻿//Ignore those dumb 'never assigned to' warnings cuz this is Unity and our fields are serialized 
-#pragma warning disable CS0649
-
+﻿using System.Collections.Generic;
 using UnityEngine;
 
 namespace Gameframe.Procgen
 {
-    public class WorldMapGenerator : MonoBehaviour
+  [CreateAssetMenu(menuName = "Gameframe/Procgen/WorldMapGenerator")]
+  public class WorldMapGenerator : ScriptableObject
+  {
+    [SerializeField] private int mapWidth = 100;
+    [SerializeField] private int mapHeight = 100;
+    [SerializeField] private List<WorldMapLayerGenerator> layerGenerators = new List<WorldMapLayerGenerator>();
+    
+    public WorldMapData GenerateMap(int seed)
     {
-        [SerializeField] private int mapWidth = 100;
-
-        [SerializeField] private int mapHeight = 100;
-
-        [SerializeField] private HeightMapLayerGenerator heightMapGenerator;
-
-        [SerializeField] private RegionMapLayerGenerator regionMapGenerator;
-
-        [SerializeField] private PoissonMapLayerGenerator poissonMapGenerator;
-
-        [SerializeField] private int seed = 100;
-
-        private void Start()
-        {
-            GenerateMap();
-        }
-
-        [ContextMenu("GenerateMap")]
-        public void GenerateMap()
-        {
-            var worldData = new WorldMapData
-            {
-                seed = seed,
-                width = mapWidth,
-                height = mapHeight
-            };
-            heightMapGenerator.AddToWorld(worldData);
-            regionMapGenerator.AddToWorld(worldData);
-            poissonMapGenerator.AddToWorld(worldData);
-            DisplayMap(worldData);
-        }
-
-        private void DisplayMap(WorldMapData mapData)
-        {
-            var mapViews = GetComponents<IWorldMapView>();
-            foreach (var view in mapViews)
-            {
-                view.DisplayMap(mapData);
-            }
-        }
-
-        private void OnValidate()
-        {
-            if (mapWidth <= 0)
-            {
-                mapWidth = 1;
-            }
-
-            if (mapHeight <= 0)
-            {
-                mapHeight = 1;
-            }
-        }
+      var worldData = new WorldMapData
+      {
+        seed = seed,
+        width = mapWidth,
+        height = mapHeight
+      };
+      
+      for (int i = 0; i < layerGenerators.Count; i++)
+      {
+        layerGenerators[i].AddToWorld(worldData);
+      }
+      
+      return worldData;
+    }
 
+    private void OnValidate()
+    {
+      if (mapWidth <= 0)
+      {
+        mapWidth = 1;
+      }
+
+      if (mapHeight <= 0)
+      {
+        mapHeight = 1;
+      }
     }
+  }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Gameframe.Procgen`
`5`	`5`	`{`
`6`		`- [CustomEditor(typeof(WorldMapGenerator), true)]`
	`6`	`+ [CustomEditor(typeof(WorldMapGenController), true)]`
`7`	`7`	`public class WorldMapGeneratorEditor : Editor`
`8`	`8`	`{`
`9`	`9`	`private bool autoUpdate = false;`
`@@ -14,14 +14,14 @@ public override void OnInspectorGUI()`
`14`	`14`	`base.OnInspectorGUI();`
`15`	`15`	`if (EditorGUI.EndChangeCheck() && autoUpdate)`
`16`	`16`	`{`
`17`		`- ((WorldMapGenerator) target).GenerateMap();`
	`17`	`+ ((WorldMapGenController) target).GenerateMap();`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`autoUpdate = EditorGUILayout.Toggle("Auto Update", autoUpdate);`
`21`	`21`
`22`	`22`	`if (GUILayout.Button("Generate"))`
`23`	`23`	`{`
`24`		`- ((WorldMapGenerator) target).GenerateMap();`
	`24`	`+ ((WorldMapGenController) target).GenerateMap();`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +namespace Gameframe.Procgen
 +{
 +  public interface IWorldMapLayerData
 +  {
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`namespace Gameframe.Procgen`
`2`	`2`	`{`
`3`	`3`	`[System.Serializable]`
`4`		`- public class HeightMapLayerData : WorldMapLayerData`
	`4`	`+ public class HeightMapLayerData : IWorldMapLayerData`
`5`	`5`	`{`
`6`	`6`	`public float[] heightMap;`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`
`4`	`4`	`namespace Gameframe.Procgen`
`5`	`5`	`{`
`6`		`- [CreateAssetMenu]`
`7`		`- public class HeightMapLayerGenerator : ScriptableObject`
	`6`	`+ [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/HeightMapLayerGenerator")]`
	`7`	`+ public class HeightMapLayerGenerator : WorldMapLayerGenerator`
`8`	`8`	`{`
`9`	`9`	`public enum MapType`
`10`	`10`	`{`
`@@ -66,7 +66,7 @@ public HeightMapLayerData Generate(int width, int height, int seed)`
`66`	`66`	`};`
`67`	`67`	`}`
`68`	`68`
`69`		`- public void AddToWorld(WorldMapData worldMapData)`
	`69`	`+ public override void AddToWorld(WorldMapData worldMapData)`
`70`	`70`	`{`
`71`	`71`	`worldMapData.layers.Add(Generate(worldMapData.width,worldMapData.height,worldMapData.seed));`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`namespace Gameframe.Procgen`
`5`	`5`	`{`
`6`	`6`	`[System.Serializable]`
`7`		`- public class PoissonMapLayerData : WorldMapLayerData`
	`7`	`+ public class PoissonMapLayerData : IWorldMapLayerData`
`8`	`8`	`{`
`9`	`9`	`public List<Vector2Int> points = new List<Vector2Int>();`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,15 +2,15 @@`
`2`	`2`
`3`	`3`	`namespace Gameframe.Procgen`
`4`	`4`	`{`
`5`		`- [CreateAssetMenu]`
`6`		`- public class PoissonMapLayerGenerator : ScriptableObject`
	`5`	`+ [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/PoissonMapLayerGenerator")]`
	`6`	`+ public class PoissonMapLayerGenerator : WorldMapLayerGenerator`
`7`	`7`	`{`
`8`	`8`	`public float radius = 10;`
`9`	`9`	`public int maxSamplesPerPoint = 30;`
`10`	`10`	`public bool useRegions = true;`
`11`	`11`	`public int edgeAvoidance = 0;`
`12`	`12`
`13`		`- public void AddToWorld(WorldMapData mapData)`
	`13`	`+ public override void AddToWorld(WorldMapData mapData)`
`14`	`14`	`{`
`15`	`15`	`if (useRegions)`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`
`5`	`5`	`namespace Gameframe.Procgen`
`6`	`6`	`{`
`7`		`- [CreateAssetMenu]`
`8`		`- public class RegionMapLayerGenerator : ScriptableObject`
	`7`	`+ [CreateAssetMenu(menuName = "Gameframe/Procgen/Layers/RegionMapLayerGenerator")]`
	`8`	`+ public class RegionMapLayerGenerator : WorldMapLayerGenerator`
`9`	`9`	`{`
`10`	`10`	`public int regionCount = 5;`
`11`	`11`	`public float waterLevel = 0.2380952f;`
`12`	`12`
`13`		`- public void AddToWorld(WorldMapData mapData)`
	`13`	`+ public override void AddToWorld(WorldMapData mapData)`
`14`	`14`	`{`
`15`	`15`	`var rng = new System.Random(mapData.seed);`
`16`	`16`	`var regionLayer = new RegionMapLayerData();`