Small refactors

Author: Sleitnick

Runtime/Code/Luau/AirshipComponentV2.cs

@@ -5,25 +5,35 @@
 using Assets.Code.Luau;
 using Luau;
 using UnityEngine;
+using UnityEngine.SceneManagement;
+using UnityEngine.Serialization;
 
+[AddComponentMenu("Airship/Airship Component")]
+[LuauAPI(LuauContext.Protected)]
 public class AirshipComponentV2 : MonoBehaviour {
+	private const bool ElevateToProtectedWithinCoreScene = true;
+	
 	public static LuauScript.AwakeData QueuedAwakeData = null;
 	private static int _airshipComponentIdGen = 10000000;
+	private static bool _validatedSceneInGameConfig = false;
 
 	public AirshipScript script;
 
 	public IntPtr thread;
 	[HideInInspector] public LuauContext context = LuauContext.Game;
-	
-	[HideInInspector] public LuauMetadata metadata = new();
+	[HideInInspector] public bool forceContext = false;
+	[FormerlySerializedAs("m_metadata")] [HideInInspector] public LuauMetadata metadata = new();
 
 	private readonly int _airshipComponentId = _airshipComponentIdGen++;
 	private readonly Dictionary<AirshipComponentUpdateType, bool> _hasAirshipUpdateMethods = new(); 
+	
+	public string TypescriptFilePath => script.m_path.Replace(".lua", ".ts");
 
 	[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
 	private static void OnReload() {
 		_airshipComponentIdGen = 10000000;
 		QueuedAwakeData = null;
+		_validatedSceneInGameConfig = false;
 	}
 
 	private void Awake() {
@@ -34,12 +44,26 @@ private void Awake() {
 		}
 
 		ScriptingEntryPoint.InvokeOnLuauStartup();
+		
+#if UNITY_EDITOR && !AIRSHIP_PLAYER
+		if (!_validatedSceneInGameConfig) {
+			var scene = gameObject.scene;
+			if (!LuauCore.IsProtectedScene(scene)) {
+				var sceneName = scene.name;
+				var gameConfig = GameConfig.Load();
+				if (gameConfig.gameScenes.ToList().Find((s) => s.name == sceneName) == null) {
+					throw new Exception(
+						$"Tried to load AirshipComponent ({name}) on GameObject ({gameObject.name}) in a scene not found in GameConfig.scenes. Please add \"{sceneName}\" to your Assets/GameConfig.asset");
+				}
+			}
+			_validatedSceneInGameConfig = true;
+		}
+#endif
 
-		// TODO:
 		// Assume protected context for bindings within CoreScene
-		// if (!this.contextOverwritten && ((gameObject.scene.name is "CoreScene" or "MainMenu") || (SceneManager.GetActiveScene().name is "CoreScene" or "MainMenu")) && ElevateToProtectedWithinCoreScene) {
-		// 	context = LuauContext.Protected;
-		// }
+		if (!forceContext && ((gameObject.scene.name is "CoreScene" or "MainMenu") || (SceneManager.GetActiveScene().name is "CoreScene" or "MainMenu")) && ElevateToProtectedWithinCoreScene) {
+			context = LuauContext.Protected;
+		}
 
 		// Load the component onto the thread:
 		thread = LuauScript.LoadAndExecuteScript(gameObject, context, LuauScriptCacheMode.Cached, script, true);

Runtime/Code/Luau/LuauScript.cs

@@ -2,6 +2,7 @@
 using System.IO;
 using Luau;
 using UnityEngine;
+using UnityEngine.SceneManagement;
 #if UNITY_EDITOR
 using UnityEditor;
 #endif
@@ -13,6 +14,8 @@ public enum LuauScriptCacheMode {
 
 [LuauAPI(LuauContext.Protected)]
 public class LuauScript : MonoBehaviour {
+	private const bool ElevateToProtectedWithinCoreScene = true;
+	
 	public static AwakeData QueuedAwakeData = null;
 
 	// Injected from LuauHelper
@@ -22,6 +25,7 @@ public class LuauScript : MonoBehaviour {
 
 	public IntPtr thread;
 	[HideInInspector] public LuauContext context = LuauContext.Game;
+	[HideInInspector] public bool forceContext = false;
 
 	[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
 	private static void OnReload() {
@@ -56,16 +60,16 @@ private static AirshipScript LoadBinaryFileFromPath(string fullFilePath) {
 #endif
 	}
 
-	public static LuauScript AddNew(GameObject go, string scriptPath, LuauContext context) {
+	public static LuauScript Create(GameObject go, string scriptPath, LuauContext context) {
 		var script = LoadBinaryFileFromPath(scriptPath);
 		if (script == null) {
 			throw new Exception($"Failed to load script from file: {scriptPath}");
 		}
 
-		return AddNew(go, script, context);
+		return Create(go, script, context);
 	}
 
-	public static LuauScript AddNew(GameObject go, AirshipScript script, LuauContext context) {
+	public static LuauScript Create(GameObject go, AirshipScript script, LuauContext context) {
 		var awakeData = new AwakeData() {
 			Script = script,
 			Context = context,
@@ -92,6 +96,11 @@ private void Awake() {
 			context = QueuedAwakeData.Context;
 			QueuedAwakeData = null;
 		}
+
+		// Assume protected context for bindings within CoreScene
+		if (!forceContext && ((gameObject.scene.name is "CoreScene" or "MainMenu") || (SceneManager.GetActiveScene().name is "CoreScene" or "MainMenu")) && ElevateToProtectedWithinCoreScene) {
+			context = LuauContext.Protected;
+		}
 
 		LoadAndExecuteScript(gameObject, context, LuauScriptCacheMode.NotCached, script, false);
 	}
@@ -171,5 +180,6 @@ public static IntPtr LoadAndExecuteScript(GameObject obj, LuauContext context, L
 	public class AwakeData {
 		public AirshipScript Script;
 		public LuauContext Context;
+		public bool ForceContext = false;
 	}
 }

Runtime/Code/Luau/ScriptingEntryPoint.cs

@@ -43,10 +43,10 @@ private void StartCoreScripts() {
 			}
 
 			// Main Menu
-			LuauScript.AddNew(new GameObject("MainMenuInGame"), MainMenuEntryScript, LuauContext.Protected);
+			LuauScript.Create(new GameObject("MainMenuInGame"), MainMenuEntryScript, LuauContext.Protected);
 
 			// Core
-			LuauScript.AddNew(new GameObject("@Easy/Core"), CoreEntryScript, LuauContext.Game);
+			LuauScript.Create(new GameObject("@Easy/Core"), CoreEntryScript, LuauContext.Game);
 		}
 	}
 }