Reworked the scripting system to be fully agnostic (#355)

Author: adriengivry

Sources/Overload/OvCore/include/OvCore/ECS/Components/Behaviour.h

@@ -6,9 +6,9 @@
 
 #pragma once
 
-#include <sol.hpp>
-
-#include "OvCore/ECS/Components/CPhysicalObject.h"
+#include <OvCore/ECS/Components/CPhysicalObject.h>
+#include <OvTools/Utils/OptRef.h>
+#include <OvCore/Scripting/ScriptEngine.h>
 
 namespace OvCore::ECS { class Actor; }
 
@@ -38,31 +38,20 @@ namespace OvCore::ECS::Components
 		virtual std::string GetName() override;
 
 		/**
-		* Register the behaviour to lua
-		* Returns true on success
-		* @param p_luaState
-		* @param p_rootFolder
-		*/
-		bool RegisterToLuaContext(sol::state& p_luaState, const std::string& p_scriptFolder);
-
-		/**
-		* Register the behaviour to lua
-		* Returns true on success
+		* Sets the script associated with this behaviour
+		* @param p_script
 		*/
-		void UnregisterFromLuaContext();
+		void SetScript(std::unique_ptr<Scripting::Script>&& p_script);
 
 		/**
-		* Call a lua function for this behaviour
-		* @param p_functionName
-		* @param p_args
+		* Returns the script context of this behaviour
 		*/
-		template<typename... Args>
-		void LuaCall(const std::string& p_functionName, Args&&... p_args);
+		OvTools::Utils::OptRef<Scripting::Script> GetScript();
 
 		/**
-		* Return the lua table attached to this behaviour
+		* Removes the script associated with this behaviour
 		*/
-		sol::table& GetTable();
+		void RemoveScript();
 
 		/**
 		* Called when the scene start right before OnStart
@@ -166,14 +155,9 @@ namespace OvCore::ECS::Components
 		virtual void OnInspector(OvUI::Internal::WidgetContainer & p_root) override;
 
 	public:
-		static OvTools::Eventing::Event<Behaviour*> CreatedEvent;
-		static OvTools::Eventing::Event<Behaviour*> DestroyedEvent;
-
 		const std::string name;
 
 	private:
-		sol::table m_object = sol::nil;
+		std::unique_ptr<Scripting::Script> m_script;
 	};
 }
-
-#include "OvCore/ECS/Components/Behaviour.inl"

Sources/Overload/OvCore/include/OvCore/ECS/Components/Behaviour.inl

@@ -0,0 +1,19 @@
+/**
+* @project: Overload
+* @author: Overload Tech.
+* @licence: MIT
+*/
+
+#pragma once
+
+namespace OvCore::Scripting
+{
+	/**
+	* Available scripting languages
+	*/
+	enum class EScriptingLanguage
+	{
+		LUA,
+		NONE
+	};
+}

Sources/Overload/OvCore/include/OvCore/Scripting/Common/EScriptingLanguage.h

@@ -0,0 +1,46 @@
+/**
+* @project: Overload
+* @author: Overload Tech.
+* @licence: MIT
+*/
+
+#pragma once
+
+#include <OvCore/Scripting/Common/EScriptingLanguage.h>
+
+namespace OvCore::Scripting
+{
+	/**
+	* Interface for any scripting backend to implement.
+	* This class defines the necessary methods that a scripting engine should provide
+	* to interact with the engine's components and handle various lifecycle events.
+	*/
+	template<EScriptingLanguage Language, class Context>
+	class TScript
+	{
+	public:
+		/**
+		* Constructor of the generic script
+		*/
+		TScript();
+
+		/**
+		* Destructor of the generic script (virtual to allow polymorphism)
+		*/
+		virtual ~TScript();
+
+		/**
+		* Checks if the script context is valid.
+		* @return True if the context is valid, false otherwise.
+		*/
+		bool IsValid() const;
+
+		/**
+		* Return the context of the script
+		*/
+		inline const Context& GetContext() const { return m_context; }
+
+	protected:
+		Context m_context;
+	};
+}

Sources/Overload/OvCore/include/OvCore/Scripting/Common/TScript.h

@@ -0,0 +1,182 @@
+/**
+* @project: Overload
+* @author: Overload Tech.
+* @licence: MIT
+*/
+
+#pragma once
+
+#include <string>
+#include <vector>
+
+#include <OvCore/Scripting/Common/EScriptingLanguage.h>
+
+namespace OvCore::ECS::Components
+{
+	class Behaviour;
+	class CPhysicalObject;
+}
+
+namespace OvCore::Scripting
+{
+	/**
+	* Interface for any scripting backend to implement.
+	* This class defines the necessary methods that a scripting engine should provide
+	* to interact with the engine's components and handle various lifecycle events.
+	*/
+	template<EScriptingLanguage Language, class Context>
+	class TScriptEngine
+	{
+	public:
+		/**
+		* Constructor of the generic script engine
+		*/
+		TScriptEngine();
+
+		/**
+		* Destructor of the generic script engine (virtual to allow polymorphism)
+		*/
+		virtual ~TScriptEngine();
+
+		/**
+		* Defines the root location of the script folder
+		* @param p_rootFolder
+		*/
+		void SetScriptRootFolder(const std::string& p_rootFolder);
+
+		/**
+		* Returns a list of valid extensions for scripts.
+		*/
+		std::vector<std::string> GetValidExtensions();
+
+		/**
+		* Returns the content for a default script
+		* @param p_name Name of the class or object represented by this script
+		*/
+		std::string GetDefaultScriptContent(const std::string& p_name);
+
+		/**
+		* Returns the extension for a default script
+		*/
+		std::string GetDefaultExtension();
+
+		/**
+		* Adds a behaviour to the scripting engine.
+		* @param p_toAdd The behaviour to add.
+		*/
+		void AddBehaviour(OvCore::ECS::Components::Behaviour& p_toAdd);
+
+		/**
+		* Removes a behaviour from the scripting engine.
+		* @param p_toRemove The behaviour to remove.
+		*/
+		void RemoveBehaviour(OvCore::ECS::Components::Behaviour& p_toRemove);
+
+		/**
+		* Reloads the scripting engine.
+		*/
+		void Reload();
+
+		/**
+		* Checks if the scripting engine is in a good state.
+		* @return True if the engine is okay, false otherwise.
+		*/
+		bool IsOk() const;
+
+		/**
+		* Called when a behaviour is awakened.
+		* @param p_target The target behaviour.
+		*/
+		void OnAwake(OvCore::ECS::Components::Behaviour& p_target);
+
+		/**
+		* Called when a behaviour starts.
+		* @param p_target The target behaviour.
+		*/
+		void OnStart(OvCore::ECS::Components::Behaviour& p_target);
+
+		/**
+		* Called when a behaviour is enabled.
+		* @param p_target The target behaviour.
+		*/
+		void OnEnable(OvCore::ECS::Components::Behaviour& p_target);
+
+		/**
+		* Called when a behaviour is disabled.
+		* @param p_target The target behaviour.
+		*/
+		void OnDisable(OvCore::ECS::Components::Behaviour& p_target);
+
+		/**
+		* Called when a behaviour is destroyed.
+		* @param p_target The target behaviour.
+		*/
+		void OnDestroy(OvCore::ECS::Components::Behaviour& p_target);
+
+		/**
+		* Called every frame to update a behaviour.
+		* @param p_target The target behaviour.
+		* @param p_deltaTime The time elapsed since the last frame.
+		*/
+		void OnUpdate(OvCore::ECS::Components::Behaviour& p_target, float p_deltaTime);
+
+		/**
+		* Called every physics frame to update a behaviour.
+		* @param p_target The target behaviour.
+		* @param p_deltaTime The time elapsed since the last physics frame.
+		*/
+		void OnFixedUpdate(OvCore::ECS::Components::Behaviour& p_target, float p_deltaTime);
+
+		/**
+		* Called every frame after OnUpdate to perform late updates on a behaviour.
+		* @param p_target The target behaviour.
+		* @param p_deltaTime The time elapsed since the last frame.
+		*/
+		void OnLateUpdate(OvCore::ECS::Components::Behaviour& p_target, float p_deltaTime);
+
+		/**
+		* Called when a behaviour's owner enters a collision with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the collision.
+		*/
+		void OnCollisionEnter(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+		/**
+		* Called when a behaviour's owner stays in collision with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the collision.
+		*/
+		void OnCollisionStay(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+		/**
+		* Called when a behaviour's owner exits a collision with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the collision.
+		*/
+		void OnCollisionExit(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+		/**
+		* Called when a behaviour's owner enters a trigger with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the trigger.
+		*/
+		void OnTriggerEnter(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+		/**
+		* Called when a behaviour's owner stays in a trigger with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the trigger.
+		*/
+		void OnTriggerStay(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+		/**
+		* Called when a behaviour's owner exits a trigger with another physical object.
+		* @param p_target The target behaviour.
+		* @param p_otherObject The other physical object involved in the trigger.
+		*/
+		void OnTriggerExit(OvCore::ECS::Components::Behaviour& p_target, OvCore::ECS::Components::CPhysicalObject& p_otherObject);
+
+	protected:
+		Context m_context;
+	};
+}