Implement boilerplate for script handled scene compatibility without chicanery. Add Required Area ini property. Script handling should work already as far as I can tell, doesn't for some reason.

Author: Bit-Crust

Source/Activities/GAScripted.cpp

@@ -61,9 +61,6 @@ int GAScripted::Create() {
 		return -1;
 	}
 
-	// Scan the script file for any mentions/uses of Areas.
-	CollectRequiredAreas();
-
 	// If the GAScripted has a OnSave() function, we assume it can be saved by default
 	ReloadScripts();
 	m_AllowsUserSaving = HasSaveFunction();
@@ -100,6 +97,11 @@ int GAScripted::ReadProperty(const std::string_view& propName, Reader& reader) {
 	MatchProperty("AddPieSlice", {
 		m_PieSlicesToAdd.emplace_back(std::unique_ptr<PieSlice>(dynamic_cast<PieSlice*>(g_PresetMan.ReadReflectedPreset(reader))));
 	});
+	MatchProperty("AddRequiredArea", {
+		std::string requiredArea;
+		reader >> requiredArea;
+		m_RequiredAreas.insert(requiredArea);
+	});
 
 	EndPropertyList;
 }
@@ -117,6 +119,10 @@ int GAScripted::Save(Writer& writer) const {
 		writer.NewPropertyWithValue("AddPieSlice", pieSliceToAdd.get());
 	}
 
+	for (const std::string& requiredArea: m_RequiredAreas) {
+		writer.NewPropertyWithValue("AddRequiredArea", requiredArea);
+	}
+
 	return 0;
 }
 
@@ -141,7 +147,6 @@ int GAScripted::ReloadScripts() {
 	}
 
 	int error = 0;
-	CollectRequiredAreas();
 
 	// If it hasn't been yet, run the file that specifies the Lua functions for this' operating logic (including the scene test function)
 	if (!g_LuaMan.GetMasterScriptState().GlobalIsDefined(m_LuaClassName)) {
@@ -187,21 +192,6 @@ bool GAScripted::SceneIsCompatible(Scene* pScene, int teams) {
 		return false;
 	}
 
-	// Check if all Areas required by this are defined in the Scene
-	for (std::set<std::string>::iterator itr = m_RequiredAreas.begin(); itr != m_RequiredAreas.end(); ++itr) {
-		// If Area is missing, this Scene is not up to par
-		if (!pScene->HasArea(*itr)) {
-			return false;
-		}
-	}
-
-	// Temporarily store the scene so the Lua state can access it and check for the necessary Areas etc.
-	g_LuaMan.GetMasterScriptState().SetTempEntity(pScene);
-	// Cast the test scene it to a Scene object in Lua
-	if (g_LuaMan.GetMasterScriptState().RunScriptString("TestScene = ToScene(LuaMan.TempEntity);") < 0) {
-		return false;
-	}
-
 	// If it hasn't been yet, run the file that specifies the Lua functions for this' operating logic (including the scene test function)
 	if (!g_LuaMan.GetMasterScriptState().GlobalIsDefined(m_LuaClassName)) {
 		// Temporarily store this Activity so the Lua state can access it
@@ -218,10 +208,31 @@ bool GAScripted::SceneIsCompatible(Scene* pScene, int teams) {
 	}
 
 	// Call the defined function, but only after first checking if it exists
-	g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + ".SceneTest then " + m_LuaClassName + ":SceneTest(); end");
+	bool conditionMet = false;
+	int error = RunLuaConditionalTest("IsCompatibleScene", conditionMet, {pScene}, {}, {});
+	if (error < 0) {
+		RTEAbort("Error")
+		return false;
+	} else if (error == 0) {
+		//RTEAbort("Missing")
+		conditionMet = true;
+	} else {
+		RTEAbort("Passed")
+	}
 
-	// If the test left the Scene pointer still set, it means it passed the test
-	return g_LuaMan.GetMasterScriptState().GlobalIsDefined("TestScene");
+	if (!conditionMet) {
+		return false;
+	}
+
+	// Check if all Areas required by this are defined in the Scene
+	for (std::set<std::string>::iterator itr = m_RequiredAreas.begin(); itr != m_RequiredAreas.end(); ++itr) {
+		// If Area is missing, this Scene is not up to par
+		if (!pScene->HasArea(*itr)) {
+			return false;
+		}
+	}
+
+	return true;
 }
 
 void GAScripted::HandleCraftEnteringOrbit(ACraft* orbitedCraft) {
@@ -378,60 +389,16 @@ int GAScripted::RunLuaFunction(const std::string& functionName, const std::vecto
 	return error;
 }
 
-void GAScripted::CollectRequiredAreas() {
-	// Open the script file so we can check it out
-	std::ifstream scriptFile = std::ifstream(g_PresetMan.GetFullModulePath(m_ScriptPath.c_str()));
-	if (!scriptFile.good()) {
-		return;
+int GAScripted::RunLuaConditionalTest(const std::string& functionName, bool& returnParam, const std::vector<const Entity*>& functionEntityArguments, const std::vector<std::string_view>& functionLiteralArguments, const std::vector<LuabindObjectWrapper*>& functionObjectArguments) {
+	// Call the defined function, but only after first checking if it exists
+	auto funcItr = m_ScriptFunctions.find(functionName);
+	if (funcItr == m_ScriptFunctions.end()) {
+		return 0;
 	}
 
-	// Harvest the required Area:s from the file
-	m_RequiredAreas.clear();
-
-	bool blockCommented = false;
+	int error = g_LuaMan.GetMasterScriptState().RunScriptConditionalTestFunctionObject(funcItr->second.get(), "_G", m_LuaClassName, returnParam, functionEntityArguments, functionLiteralArguments, functionObjectArguments);
 
-	while (!scriptFile.eof()) {
-		// Go through the script file, line by line
-		char rawLine[512];
-		scriptFile.getline(rawLine, 512);
-		std::string line = rawLine;
-		std::string::size_type pos = 0;
-		std::string::size_type endPos = 0;
-		std::string::size_type commentPos = std::string::npos;
-
-		// Check for block comments
-		if (!blockCommented && (commentPos = line.find("--[[", 0)) != std::string::npos) {
-			blockCommented = true;
-		}
-
-		// Find the end of the block comment
-		if (blockCommented) {
-			if ((commentPos = line.find("]]", commentPos == std::string::npos ? 0 : commentPos)) != std::string::npos) {
-				blockCommented = false;
-				pos = commentPos;
-			}
-		}
-
-		// Process the line as usual
-		if (!blockCommented) {
-			// See if this line is commented out anywhere
-			commentPos = line.find("--", 0);
-			do {
-				// Find the beginning of a mentioned Area name
-				pos = line.find(":GetArea(\"", pos);
-				if (pos != std::string::npos && pos < commentPos) {
-					// Move position forward to the actual Area name
-					pos += 10;
-					// Find the end of the Area name
-					endPos = line.find_first_of('"', pos);
-					// Copy it out and put into the list
-					if (endPos != std::string::npos) {
-						m_RequiredAreas.insert(line.substr(pos, endPos - pos));
-					}
-				}
-			} while (pos != std::string::npos && pos < commentPos);
-		}
-	}
+	return error;
 }
 
 void GAScripted::AddPieSlicesToActiveActorPieMenus() {

Source/Activities/GAScripted.h

@@ -23,7 +23,7 @@ namespace RTE {
 
 		/// Public member variable, method and friend function declarations
 	public:
-		ScriptFunctionNames("StartActivity", "UpdateActivity", "PauseActivity", "EndActivity", "OnSave", "CraftEnteredOrbit", "OnMessage", "OnGlobalMessage");
+		ScriptFunctionNames("StartActivity", "UpdateActivity", "PauseActivity", "EndActivity", "OnSave", "CraftEnteredOrbit", "OnMessage", "IsCompatibleScene", "OnGlobalMessage");
 
 		// Concrete allocation and cloning definitions
 		EntityAllocation(GAScripted);
@@ -132,13 +132,10 @@ namespace RTE {
 		void Draw(BITMAP* pTargetBitmap, const Vector& targetPos = Vector()) override;
 
 		int RunLuaFunction(const std::string& functionName, const std::vector<const Entity*>& functionEntityArguments = std::vector<const Entity*>(), const std::vector<std::string_view>& functionLiteralArguments = std::vector<std::string_view>(), const std::vector<LuabindObjectWrapper*>& functionObjectArguments = std::vector<LuabindObjectWrapper*>());
+		int RunLuaConditionalTest(const std::string& functionName, bool& returnParam, const std::vector<const Entity*>& functionEntityArguments = std::vector<const Entity*>(), const std::vector<std::string_view>& functionLiteralArguments = std::vector<std::string_view>(), const std::vector<LuabindObjectWrapper*>& functionObjectArguments = std::vector<LuabindObjectWrapper*>());
 
 		/// Protected member variable and method declarations
 	protected:
-		/// Goes through the script file and checks for any mentions and uses of
-		/// Area:s that are required for this Activity to run in a Scene.
-		void CollectRequiredAreas();
-
 		/// Does nothing - we do this in script! Just overrides the base behaviour.
 		void InitAIs() override{};
 

Source/Managers/LuaMan.cpp

@@ -625,6 +625,80 @@ int LuaStateWrapper::RunScriptFunctionObject(const LuabindObjectWrapper* functio
 	return status;
 }
 
+int LuaStateWrapper::RunScriptConditionalTestFunctionObject(const LuabindObjectWrapper* functionObject, const std::string& selfGlobalTableName, const std::string& selfGlobalTableKey, bool& returnParam, const std::vector<const Entity*>& functionEntityArguments, const std::vector<std::string_view>& functionLiteralArguments, const std::vector<LuabindObjectWrapper*>& functionObjectArguments) {
+	int status = 0;
+
+	std::lock_guard<std::recursive_mutex> lock(m_Mutex);
+	s_currentLuaState = this;
+	m_CurrentlyRunningScriptPath = functionObject->GetFilePath();
+
+	lua_pushcfunction(m_State, &AddFileAndLineToError);
+	functionObject->GetLuabindObject()->push(m_State);
+
+	int argumentCount = functionEntityArguments.size() + functionLiteralArguments.size() + functionObjectArguments.size();
+	if (!selfGlobalTableName.empty() && TableEntryIsDefined(selfGlobalTableName, selfGlobalTableKey)) {
+		lua_getglobal(m_State, selfGlobalTableName.c_str());
+		lua_getfield(m_State, -1, selfGlobalTableKey.c_str());
+		lua_remove(m_State, -2);
+		argumentCount++;
+	}
+
+	for (const Entity* functionEntityArgument: functionEntityArguments) {
+		std::unique_ptr<LuabindObjectWrapper> downCastEntityAsLuabindObjectWrapper(LuaAdaptersEntityCast::s_EntityToLuabindObjectCastFunctions.at(functionEntityArgument->GetClassName())(const_cast<Entity*>(functionEntityArgument), m_State));
+		downCastEntityAsLuabindObjectWrapper->GetLuabindObject()->push(m_State);
+	}
+
+	for (const std::string_view& functionLiteralArgument: functionLiteralArguments) {
+		char* stringToDoubleConversionFailed = nullptr;
+		if (functionLiteralArgument == "nil") {
+			lua_pushnil(m_State);
+		} else if (functionLiteralArgument == "true" || functionLiteralArgument == "false") {
+			lua_pushboolean(m_State, functionLiteralArgument == "true" ? 1 : 0);
+		} else if (double argumentAsNumber = std::strtod(functionLiteralArgument.data(), &stringToDoubleConversionFailed); !*stringToDoubleConversionFailed) {
+			lua_pushnumber(m_State, argumentAsNumber);
+		} else {
+			lua_pushlstring(m_State, functionLiteralArgument.data(), functionLiteralArgument.size());
+		}
+	}
+
+	for (const LuabindObjectWrapper* functionObjectArgument: functionObjectArguments) {
+		if (functionObjectArgument->GetLuabindObject()->interpreter() != m_State) {
+			LuabindObjectWrapper copy = functionObjectArgument->GetCopyForState(*m_State);
+			copy.GetLuabindObject()->push(m_State);
+		} else {
+			functionObjectArgument->GetLuabindObject()->push(m_State);
+		}
+	}
+
+	const std::string& path = functionObject->GetFilePath();
+	std::chrono::steady_clock::time_point begin = std::chrono::steady_clock::now();
+	{
+		ZoneScoped;
+		ZoneName(path.c_str(), path.length());
+
+		if (lua_pcall(m_State, argumentCount, LUA_MULTRET, -argumentCount - 2) > 0) {
+			//returnParam = 1 == lua_toboolean(m_State, 1);
+			m_LastError = lua_tostring(m_State, -1);
+			lua_pop(m_State, 1);
+			g_ConsoleMan.PrintString("ERROR: " + m_LastError);
+			ClearErrors();
+			status = -1;
+		}
+	}
+	std::chrono::steady_clock::time_point end = std::chrono::steady_clock::now();
+
+	// only track time in non-MT scripts, for now
+	if (&g_LuaMan.GetMasterScriptState() == this) {
+		m_ScriptTimings[path].m_Time += std::chrono::duration_cast<std::chrono::microseconds>(end - begin).count();
+		m_ScriptTimings[path].m_CallCount++;
+	}
+
+	lua_pop(m_State, 1);
+
+	m_CurrentlyRunningScriptPath = "";
+	return status;
+}
+
 int LuaStateWrapper::RunScriptFile(const std::string& filePath, bool consoleErrors, bool doInSandboxedEnvironment) {
 	const std::string fullScriptPath = g_PresetMan.GetFullModulePath(filePath);
 	if (fullScriptPath.empty()) {

Source/Managers/LuaMan.h

@@ -112,6 +112,16 @@ namespace RTE {
 		/// @param functionLiteralArguments Optional vector of strings that should be passed into the Lua function. Entries must be surrounded with escaped quotes (i.e.`\"`) they'll be passed in as-is, allowing them to act as booleans, etc.. Defaults to empty.
 		/// @return An error return value signaling success or any particular failure. Anything below 0 is an error signal.
 		int RunScriptFunctionObject(const LuabindObjectWrapper* functionObjectWrapper, const std::string& selfGlobalTableName, const std::string& selfGlobalTableKey, const std::vector<const Entity*>& functionEntityArguments = std::vector<const Entity*>(), const std::vector<std::string_view>& functionLiteralArguments = std::vector<std::string_view>(), const std::vector<LuabindObjectWrapper*>& functionObjectArguments = std::vector<LuabindObjectWrapper*>());
+		
+		/// Runs the given Lua function object. The first argument to the function will always be the self object.
+		/// If either argument list has entries, they will be passed into the function in order, with entity arguments first.
+		/// @param functionObjectWrapper The LuabindObjectWrapper containing the Lua function to be run.
+		/// @param selfGlobalTableName The name of the global Lua table that gives access to the self object.
+		/// @param selfGlobalTableKey The key for this object in the respective global Lua table.
+		/// @param functionEntityArguments Optional vector of entity pointers that should be passed into the Lua function. Their internal Lua states will not be accessible. Defaults to empty.
+		/// @param functionLiteralArguments Optional vector of strings that should be passed into the Lua function. Entries must be surrounded with escaped quotes (i.e.`\"`) they'll be passed in as-is, allowing them to act as booleans, etc.. Defaults to empty.
+		/// @return An error return value signaling success or any particular failure. Anything below 0 is an error signal.
+		int RunScriptConditionalTestFunctionObject(const LuabindObjectWrapper* functionObjectWrapper, const std::string& selfGlobalTableName, const std::string& selfGlobalTableKey, bool& returnParam, const std::vector<const Entity*>& functionEntityArguments = std::vector<const Entity*>(), const std::vector<std::string_view>& functionLiteralArguments = std::vector<std::string_view>(), const std::vector<LuabindObjectWrapper*>& functionObjectArguments = std::vector<LuabindObjectWrapper*>());
 
 		/// Opens and loads a file containing a script and runs it on the state.
 		/// @param filePath The path to the file to load and run.