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,69 @@
+#pragma once
+
+#include "RE/B/BSTFreeList.h"
+
+namespace RE
+{
+	class ScrapHeap;
+
+	template <class T>
+	class BSScrapHeapQueueElem;
+
+	template <class T>
+	class __declspec(novtable) BSTMessageQueue
+	{
+	public:
+		virtual ~BSTMessageQueue() = default;  // 00
+
+		// add
+		virtual bool Push(const T& a_message) = 0;     // 01
+		virtual bool TryPush(const T& a_message) = 0;  // 02
+		virtual bool Pop(T& a_message) = 0;            // 03
+		virtual bool TryPop(T& a_message) = 0;         // 04
+	};
+
+	template <class T>
+	class __declspec(novtable) BSTCommonMessageQueue :
+		public BSTMessageQueue<T>  // 00
+	{
+	public:
+		// override (BSTMessageQueue<T>)
+		bool Push(const T& a_message) override;     // 01
+		bool TryPush(const T& a_message) override;  // 02
+		bool Pop(T& a_message) override;            // 03
+		bool TryPop(T& a_message) override;         // 04
+
+		// add
+		virtual bool DoTryPush([[maybe_unused]] const T& a_message) { return false; }  // 05
+		virtual bool DoTryPop([[maybe_unused]] T& a_message) { return false; }         // 06
+
+		// members
+		std::uint32_t lock;  // 08
+	};
+
+	template <class T>
+	class __declspec(novtable) BSTCommonLLMessageQueue :
+		public BSTCommonMessageQueue<T>  // 00
+	{
+	public:
+		// members
+		BSTFreeList<T>*      freeList;  // 10
+		BSTFreeListElem<T>*  head;      // 18
+		BSTFreeListElem<T>** tail;      // 20
+	};
+
+	template <class T>
+	class __declspec(novtable) BSTCommonScrapHeapMessageQueue :
+		public BSTCommonMessageQueue<T>
+	{
+	public:
+		// override
+		virtual bool DoTryPush([[maybe_unused]] const T& a_message) override;  // 05
+		virtual bool DoTryPop([[maybe_unused]] T& a_message) override;         // 06
+
+		// members
+		ScrapHeap*                scrapHeap;  // 10
+		BSScrapHeapQueueElem<T>*  head;       // 18
+		BSScrapHeapQueueElem<T>** tail;       // 20
+	};
+}