Add Build Actions option to editor settings for build button configuration

Source/Editor/Editor.cs

@@ -242,8 +242,6 @@ namespace FlaxEditor
             StateMachine = new EditorStateMachine(this);
             Undo = new EditorUndo(this);
 
-            ScriptsBuilder.ScriptsReloadBegin += ScriptsBuilder_ScriptsReloadBegin;
-            ScriptsBuilder.ScriptsReloadEnd += ScriptsBuilder_ScriptsReloadEnd;
             UIControl.FallbackParentGetDelegate += OnUIControlFallbackParentGet;
         }
 
@@ -260,18 +258,6 @@ namespace FlaxEditor
             return null;
         }
 
-        private void ScriptsBuilder_ScriptsReloadBegin()
-        {
-            EnsureState<EditingSceneState>();
-            StateMachine.GoToState<ReloadingScriptsState>();
-        }
-
-        private void ScriptsBuilder_ScriptsReloadEnd()
-        {
-            EnsureState<ReloadingScriptsState>();
-            StateMachine.GoToState<EditingSceneState>();
-        }
-
         internal void RegisterModule(EditorModule module)
         {
             Log("Register Editor module " + module);
@@ -497,9 +483,6 @@ namespace FlaxEditor
             Surface.VisualScriptSurface.NodesCache.Clear();
             Instance = null;
 
-            ScriptsBuilder.ScriptsReloadBegin -= ScriptsBuilder_ScriptsReloadBegin;
-            ScriptsBuilder.ScriptsReloadEnd -= ScriptsBuilder_ScriptsReloadEnd;
-
             // Invoke new instance if need to open a project
             if (!string.IsNullOrEmpty(_projectToOpen))
             {

Source/Editor/Modules/UIModule.cs

@@ -507,7 +507,7 @@ namespace FlaxEditor.Modules
             _toolStripRotate = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Rotate32, () => Editor.MainTransformGizmo.ActiveMode = TransformGizmoBase.Mode.Rotate).LinkTooltip("Change Gizmo tool mode to Rotate (2)");
             _toolStripScale = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Scale32, () => Editor.MainTransformGizmo.ActiveMode = TransformGizmoBase.Mode.Scale).LinkTooltip("Change Gizmo tool mode to Scale (3)");
             ToolStrip.AddSeparator();
-            _toolStripBuildScenes = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Build32, Editor.BuildScenesOrCancel).LinkTooltip("Build scenes data - CSG, navmesh, static lighting, env probes (Ctrl+F10)");
+            _toolStripBuildScenes = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Build32, Editor.BuildScenesOrCancel).LinkTooltip("Build scenes data - CSG, navmesh, static lighting, env probes - configurable via Build Actions in editor options (Ctrl+F10)");
             ToolStrip.AddSeparator();
             _toolStripPlay = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Play32, Editor.Simulation.RequestPlayOrStopPlay).LinkTooltip("Start/Stop game (F5)");
             _toolStripPause = (ToolStripButton)ToolStrip.AddButton(Editor.Icons.Pause32, Editor.Simulation.RequestResumeOrPause).LinkTooltip("Pause/Resume game(F6)");

Source/Editor/Options/GeneralOptions.cs

@@ -32,6 +32,42 @@ namespace FlaxEditor.Options
             LastOpened,
         }
 
+        /// <summary>
+        /// The build actions.
+        /// </summary>
+        public enum BuildAction
+        {
+            /// <summary>
+            /// Builds Constructive Solid Geometry brushes into meshes.
+            /// </summary>
+            [Tooltip("Builds Constructive Solid Geometry brushes into meshes.")]
+            CSG,
+
+            /// <summary>
+            /// Builds Env Probes and Sky Lights to prerendered cube textures.
+            /// </summary>
+            [Tooltip("Builds Env Probes and Sky Lights to prerendered cube textures.")]
+            EnvProbes,
+
+            /// <summary>
+            /// Builds static lighting into lightmaps.
+            /// </summary>
+            [Tooltip("Builds static lighting into lightmaps.")]
+            StaticLighting,
+
+            /// <summary>
+            /// Builds navigation meshes.
+            /// </summary>
+            [Tooltip("Builds navigation meshes.")]
+            NavMesh,
+
+            /// <summary>
+            /// Compiles the scripts.
+            /// </summary>
+            [Tooltip("Compiles the scripts.")]
+            CompileScripts,
+        }
+
         /// <summary>
         /// Gets or sets the scene to load on editor startup.
         /// </summary>
@@ -53,6 +89,19 @@ namespace FlaxEditor.Options
         [EditorDisplay("General", "Editor FPS"), EditorOrder(110), Tooltip("Limit for the editor draw/update frames per second rate (FPS). Use higher values if you need more responsive interface or lower values to use less device power. Value 0 disables any limits.")]
         public float EditorFPS { get; set; } = 60.0f;
 
+        /// <summary>
+        /// Gets or sets the sequence of actions to perform when using Build Scenes button. Can be used to configure this as button (eg. compile code or just update navmesh).
+        /// </summary>
+        [EditorDisplay("General"), EditorOrder(200), Tooltip("The sequence of actions to perform when using Build Scenes button. Can be used to configure this as button (eg. compile code or just update navmesh).")]
+        public BuildAction[] BuildActions { get; set; } =
+        {
+            BuildAction.CSG,
+            BuildAction.EnvProbes,
+            BuildAction.StaticLighting,
+            BuildAction.EnvProbes,
+            BuildAction.NavMesh,
+        };
+
         /// <summary>
         /// Gets or sets a value indicating whether perform automatic scripts reload on main window focus.
         /// </summary>

Source/Editor/States/BuildingScenesState.cs

@@ -1,6 +1,9 @@
 // Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
+using FlaxEditor.Options;
 using FlaxEditor.SceneGraph.Actors;
 using FlaxEngine;
 using FlaxEngine.Utilities;
@@ -16,6 +19,9 @@ namespace FlaxEditor.States
     {
         private sealed class SubStateMachine : StateMachine
         {
+            public int ActionIndex = -1;
+            public readonly List<GeneralOptions.BuildAction> Actions = new List<GeneralOptions.BuildAction>();
+
             protected override void SwitchState(State nextState)
             {
                 if (CurrentState != null && nextState != null)
@@ -27,10 +33,40 @@ namespace FlaxEditor.States
 
         private abstract class SubState : State
         {
+            public virtual bool DirtyScenes => true;
+
+            public virtual bool CanReloadScripts => false;
+
+            public virtual void Before()
+            {
+            }
+
             public virtual void Update()
             {
             }
 
+            public virtual void Done()
+            {
+                var stateMachine = (SubStateMachine)StateMachine;
+                stateMachine.ActionIndex++;
+                if (stateMachine.ActionIndex < stateMachine.Actions.Count)
+                {
+                    var action = stateMachine.Actions[stateMachine.ActionIndex];
+                    var state = stateMachine.States.FirstOrDefault(x => x is ActionState a && a.Action == action);
+                    if (state != null)
+                    {
+                        StateMachine.GoToState(state);
+                    }
+                    else
+                    {
+                        Editor.LogError($"Missing or invalid build scene action {action}.");
+                    }
+                    return;
+                }
+
+                StateMachine.GoToState<EndState>();
+            }
+
             public virtual void Cancel()
             {
                 StateMachine.GoToState<EndState>();
@@ -45,18 +81,31 @@ namespace FlaxEditor.States
         {
             public override void OnEnter()
             {
-                var editor = Editor.Instance;
+                var stateMachine = (SubStateMachine)StateMachine;
-                foreach (var scene in Level.Scenes)
+                var scenesDirty = false;
+                foreach (var state in stateMachine.States)
                 {
-                    scene.ClearLightmaps();
+                    ((SubState)state).Before();
-                    editor.Scene.MarkSceneEdited(scene);
+                    scenesDirty |= ((SubState)state).DirtyScenes;
                 }
-                StateMachine.GoToState<CSGState>();
+                if (scenesDirty)
+                {
+                    foreach (var scene in Level.Scenes)
+                        Editor.Instance.Scene.MarkSceneEdited(scene);
+                }
+                Done();
             }
         }
 
-        private sealed class CSGState : SubState
+        private abstract class ActionState : SubState
         {
+            public abstract GeneralOptions.BuildAction Action { get; }
+        }
+
+        private sealed class CSGState : ActionState
+        {
+            public override GeneralOptions.BuildAction Action => GeneralOptions.BuildAction.CSG;
+
             public override void OnEnter()
             {
                 foreach (var scene in Level.Scenes)
@@ -68,13 +117,14 @@ namespace FlaxEditor.States
             public override void Update()
             {
                 if (!Editor.Internal_GetIsCSGActive())
-                    StateMachine.GoToState<EnvProbesNoGIState>();
+                    Done();
             }
         }
 
-
+        private class EnvProbesState : ActionState
-        private class EnvProbesNoGIState : SubState
         {
+            public override GeneralOptions.BuildAction Action => GeneralOptions.BuildAction.EnvProbes;
+
             public override void OnEnter()
             {
                 Editor.Instance.Scene.ExecuteOnGraph(node =>
@@ -94,12 +144,20 @@ namespace FlaxEditor.States
             public override void Update()
             {
                 if (!Editor.Instance.ProgressReporting.BakeEnvProbes.IsActive)
-                    StateMachine.GoToState<StaticLightingState>();
+                    Done();
             }
         }
 
-        private sealed class StaticLightingState : SubState
+        private sealed class StaticLightingState : ActionState
         {
+            public override GeneralOptions.BuildAction Action => GeneralOptions.BuildAction.StaticLighting;
+
+            public override void Before()
+            {
+                foreach (var scene in Level.Scenes)
+                    scene.ClearLightmaps();
+            }
+
             public override void OnEnter()
             {
                 Editor.LightmapsBakeEnd += OnLightmapsBakeEnd;
@@ -110,7 +168,6 @@ namespace FlaxEditor.States
                     OnLightmapsBakeEnd(false);
             }
 
-            /// <inheritdoc />
             public override void Cancel()
             {
                 Editor.Internal_BakeLightmaps(true);
@@ -125,21 +182,14 @@ namespace FlaxEditor.States
 
             private void OnLightmapsBakeEnd(bool failed)
             {
-                StateMachine.GoToState<EnvProbesWithGIState>();
+                Done();
             }
         }
 
-        private sealed class EnvProbesWithGIState : EnvProbesNoGIState
+        private sealed class NavMeshState : ActionState
         {
-            public override void Update()
+            public override GeneralOptions.BuildAction Action => GeneralOptions.BuildAction.NavMesh;
-            {
-                if (!Editor.Instance.ProgressReporting.BakeEnvProbes.IsActive)
-                    StateMachine.GoToState<NavMeshState>();
-            }
-        }
 
-        private sealed class NavMeshState : SubState
-        {
             public override void OnEnter()
             {
                 foreach (var scene in Level.Scenes)
@@ -151,7 +201,58 @@ namespace FlaxEditor.States
             public override void Update()
             {
                 if (!Navigation.IsBuildingNavMesh)
-                    StateMachine.GoToState<EndState>();
+                    Done();
+            }
+        }
+
+        private sealed class CompileScriptsState : ActionState
+        {
+            private bool _compiled, _reloaded;
+
+            public override GeneralOptions.BuildAction Action => GeneralOptions.BuildAction.CompileScripts;
+
+            public override bool DirtyScenes => false;
+
+            public override bool CanReloadScripts => true;
+
+            public override void OnEnter()
+            {
+                _compiled = _reloaded = false;
+                ScriptsBuilder.Compile();
+
+                ScriptsBuilder.CompilationSuccess += OnCompilationSuccess;
+                ScriptsBuilder.CompilationFailed += OnCompilationFailed;
+                ScriptsBuilder.ScriptsReloadEnd += OnScriptsReloadEnd;
+            }
+
+            public override void OnExit(State nextState)
+            {
+                ScriptsBuilder.CompilationSuccess -= OnCompilationSuccess;
+                ScriptsBuilder.CompilationFailed -= OnCompilationFailed;
+                ScriptsBuilder.ScriptsReloadEnd -= OnScriptsReloadEnd;
+
+                base.OnExit(nextState);
+            }
+
+            private void OnCompilationSuccess()
+            {
+                _compiled = true;
+            }
+
+            private void OnCompilationFailed()
+            {
+                Cancel();
+            }
+
+            private void OnScriptsReloadEnd()
+            {
+                _reloaded = true;
+            }
+
+            public override void Update()
+            {
+                if (_compiled && _reloaded)
+                    Done();
             }
         }
 
@@ -173,10 +274,10 @@ namespace FlaxEditor.States
             _stateMachine.AddState(new BeginState());
             _stateMachine.AddState(new SetupState());
             _stateMachine.AddState(new CSGState());
-            _stateMachine.AddState(new EnvProbesNoGIState());
+            _stateMachine.AddState(new EnvProbesState());
             _stateMachine.AddState(new StaticLightingState());
-            _stateMachine.AddState(new EnvProbesWithGIState());
             _stateMachine.AddState(new NavMeshState());
+            _stateMachine.AddState(new CompileScriptsState());
             _stateMachine.AddState(new EndState());
             _stateMachine.GoToState<BeginState>();
         }
@@ -192,6 +293,9 @@ namespace FlaxEditor.States
         /// <inheritdoc />
         public override bool CanEditContent => false;
 
+        /// <inheritdoc />
+        public override bool CanReloadScripts => ((SubState)_stateMachine.CurrentState).CanReloadScripts;
+
         /// <inheritdoc />
         public override bool IsPerformanceHeavy => true;
 
@@ -215,6 +319,11 @@ namespace FlaxEditor.States
         {
             Editor.Log("Starting scenes build...");
             _startTime = DateTime.Now;
+            _stateMachine.ActionIndex = -1;
+            _stateMachine.Actions.Clear();
+            var actions = (GeneralOptions.BuildAction[])Editor.Options.Options.General.BuildActions?.Clone();
+            if (actions != null)
+                _stateMachine.Actions.AddRange(actions);
             _stateMachine.GoToState<SetupState>();
         }
 

Source/Editor/States/EditingSceneState.cs

@@ -1,6 +1,7 @@
 // Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
 
 using FlaxEngine;
+using FlaxEngine.Utilities;
 
 namespace FlaxEditor.States
 {
@@ -39,5 +40,26 @@ namespace FlaxEditor.States
         {
             UpdateFPS();
         }
+
+        /// <inheritdoc />
+        public override void OnEnter()
+        {
+            base.OnEnter();
+
+            ScriptsBuilder.ScriptsReloadBegin += OnScriptsReloadBegin;
+        }
+
+        /// <inheritdoc />
+        public override void OnExit(State nextState)
+        {
+            ScriptsBuilder.ScriptsReloadBegin -= OnScriptsReloadBegin;
+
+            base.OnExit(nextState);
+        }
+
+        private void OnScriptsReloadBegin()
+        {
+            StateMachine.GoToState<ReloadingScriptsState>();
+        }
     }
 }

Source/Editor/States/ReloadingScriptsState.cs

@@ -1,6 +1,7 @@
 // Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
 
 using FlaxEngine;
+using FlaxEngine.Utilities;
 
 namespace FlaxEditor.States
 {
@@ -18,5 +19,26 @@ namespace FlaxEditor.States
         : base(editor)
         {
         }
+
+        /// <inheritdoc />
+        public override void OnEnter()
+        {
+            base.OnEnter();
+
+            ScriptsBuilder.ScriptsReloadEnd += OnScriptsReloadEnd;
+        }
+
+        /// <inheritdoc />
+        public override void OnExit(State nextState)
+        {
+            ScriptsBuilder.ScriptsReloadEnd -= OnScriptsReloadEnd;
+
+            base.OnExit(nextState);
+        }
+
+        private void OnScriptsReloadEnd()
+        {
+            StateMachine.GoToState<EditingSceneState>();
+        }
     }
 }

Source/Engine/Utilities/State.cs

@@ -12,9 +12,6 @@ namespace FlaxEngine.Utilities
         /// <summary>
         /// Gets the state machine.
         /// </summary>
-        /// <value>
-        /// The state machine.
-        /// </value>
         public StateMachine StateMachine => owner;
 
         /// <summary>

Source/Engine/Utilities/StateMachine.cs

@@ -35,6 +35,11 @@ namespace FlaxEngine.Utilities
         /// </summary>
         public event Action StateChanged;
 
+        /// <summary>
+        /// Gets the states (read-only).
+        /// </summary>
+        public IReadOnlyList<State> States => states;
+
         /// <summary>
         /// Gets state of given type.
         /// </summary>