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,66 @@
+#pragma once
+
+#include "RE/B/BSFixedString.h"
+#include "RE/B/BSScript_ObjectTypeInfo.h"
+#include "RE/B/BSScript_Variable.h"
+#include "RE/B/BSTSmartPointer.h"
+
+namespace RE
+{
+	namespace BSScript
+	{
+		class Object
+		{
+		public:
+			~Object();
+
+			ObjectTypeInfo*                     GetTypeInfo();
+			[[nodiscard]] const ObjectTypeInfo* GetTypeInfo() const;
+			[[nodiscard]] constexpr bool        IsConstructed() const noexcept { return static_cast<bool>(constructed); }
+			[[nodiscard]] constexpr bool        IsInitialized() const noexcept { return static_cast<bool>(initialized); }
+			[[nodiscard]] constexpr bool        IsValid() const noexcept { return static_cast<bool>(valid); }
+
+			[[nodiscard]] void* Resolve(std::uint32_t a_typeID) const;
+
+			[[nodiscard]] std::uint32_t DecRef() const
+			{
+				using func_t = decltype(&Object::DecRef);
+				static REL::Relocation<func_t> func{ ID::BSScript_Object::DecRef };
+				return func(this);
+			}
+
+			[[nodiscard]] std::size_t GetHandle() const
+			{
+				using func_t = decltype(&Object::GetHandle);
+				static REL::Relocation<func_t> func{ ID::BSScript_Object::GetHandle };
+				return func(this);
+			}
+
+			void IncRef() const
+			{
+				using func_t = decltype(&Object::IncRef);
+				static REL::Relocation<func_t> func{ ID::BSScript_Object::IncRef };
+				return func(this);
+			}
+
+			Variable*                     GetProperty(const BSFixedString& a_name);
+			[[nodiscard]] const Variable* GetProperty(const BSFixedString& a_name) const;
+
+			// TODO: Figure out if F4_HEAP_REDEFINE_NEW is necessary here
+			//			F4_HEAP_REDEFINE_NEW(Object);
+
+			// members
+			std::uint32_t                   constructed: 1;            // 00:00
+			std::uint32_t                   initialized: 1;            // 00:01
+			std::uint32_t                   valid: 1;                  // 00:02
+			std::uint32_t                   remainingPropsToInit: 29;  // 00:03
+			BSTSmartPointer<ObjectTypeInfo> type;                      // 08
+			BSFixedString                   currentState;              // 10
+			void*                           lockStructure;             // 18
+			std::size_t                     handle;                    // 20
+			std::uint32_t                   refCountAndHandleLock;     // 28
+			Variable                        variables[0];              // 30
+		};
+		static_assert(sizeof(Object) == 0x30);
+	}
+}