docs: add plugin setup guide

2026-05-30 18:33:24 +12:00
parent f3db41c402
commit b61043a3fe
1776 changed files with 122386 additions and 2 deletions
@@ -0,0 +1,84 @@
+#pragma once
+
+namespace RE
+{
+	enum class SCRIPT_OUTPUT;
+	class ConditionCheckParams;
+	class SCRIPT_LINE;
+	class SCRIPT_PARAMETER;
+	class ScriptCompileData;
+	class ScriptLocals;
+
+	class SCRIPT_FUNCTION
+	{
+	public:
+		using ConditionFunction_t = bool(ConditionCheckParams& a_data, void* a_param2, void* a_param1, float& a_returnValue);
+		using CompileFunction_t = bool(const std::uint16_t a_paramCount, const SCRIPT_PARAMETER* a_parameters, SCRIPT_LINE* a_scriptLine, ScriptCompileData* a_compileData);
+		using ExecuteFunction_t = bool(const SCRIPT_PARAMETER* a_parameters, const char* a_compiledParams, TESObjectREFR* a_refObject, TESObjectREFR* a_container, Script* a_script, ScriptLocals* a_scriptLocals, float& a_returnValue, std::uint32_t& a_offset);
+
+		[[nodiscard]] static auto GetConsoleFunctions()
+		{
+			static REL::Relocation<SCRIPT_FUNCTION(*)[523]> functions{ ID::SCRIPT_FUNCTION::ConsoleFunctions };
+			return std::span{ *functions };
+		}
+
+		static SCRIPT_FUNCTION* LocateConsoleCommand(const std::string_view a_longName)
+		{
+			for (auto& command : GetConsoleFunctions()) {
+				if (command.functionName && std::strlen(command.functionName) == a_longName.size())
+					if (_strnicmp(command.functionName, a_longName.data(), a_longName.size()) == 0)
+						return std::addressof(command);
+			}
+
+			return nullptr;
+		}
+
+		[[nodiscard]] static auto GetScriptFunctions()
+		{
+			static REL::Relocation<SCRIPT_FUNCTION(*)[818]> functions{ ID::SCRIPT_FUNCTION::ScriptFunctions };
+			return std::span{ *functions };
+		}
+
+		static SCRIPT_FUNCTION* LocateScriptCommand(const std::string_view a_longName)
+		{
+			for (auto& command : GetScriptFunctions()) {
+				if (command.functionName && std::strlen(command.functionName) == a_longName.size())
+					if (_strnicmp(command.functionName, a_longName.data(), a_longName.size()) == 0)
+						return std::addressof(command);
+			}
+
+			return nullptr;
+		}
+
+		template <std::uint16_t SIZE>
+		inline void SetParameters(SCRIPT_PARAMETER (&a_params)[SIZE])
+		{
+			paramCount = SIZE;
+			parameters = a_params;
+		}
+
+		void SetParameters();
+
+		// members
+		const char*                                functionName{ "" };                       // 00
+		const char*                                shortName{ "" };                          // 08
+		REX::TEnumSet<SCRIPT_OUTPUT, std::int32_t> output;                                   // 10
+		const char*                                helpString{ "" };                         // 18
+		bool                                       referenceFunction{ false };               // 20
+		std::uint16_t                              paramCount{ 0 };                          // 22
+		SCRIPT_PARAMETER*                          parameters{ nullptr };                    // 28
+		ExecuteFunction_t*                         executeFunction{ nullptr };               // 30
+		CompileFunction_t*                         compileFunction{ GetCompileFunction() };  // 38
+		ConditionFunction_t*                       conditionFunction{ nullptr };             // 40
+		bool                                       editorFilter{ false };                    // 48
+		bool                                       invalidatesCellList{ false };             // 49
+
+	private:
+		[[nodiscard]] inline static CompileFunction_t* GetCompileFunction()
+		{
+			static REL::Relocation<CompileFunction_t*> value{ ID::SCRIPT_FUNCTION::CompileFunction };
+			return value.get();
+		}
+	};
+	static_assert(sizeof(SCRIPT_FUNCTION) == 0x50);
+}