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,149 @@
+#pragma once
+
+#include "RE/B/BSContainer.h"
+#include "RE/B/BSPointerHandle.h"
+#include "RE/B/BSSemaphore.h"
+#include "RE/B/BSSimpleList.h"
+#include "RE/B/BSSpinLock.h"
+#include "RE/B/BSTArray.h"
+#include "RE/B/BSTEvent.h"
+#include "RE/B/BSTSingleton.h"
+#include "RE/B/BSTSmartPointer.h"
+#include "RE/B/BSTempEffect.h"
+#include "RE/M/ModelReferenceEffect.h"
+#include "RE/N/NiPointer.h"
+#include "RE/P/PTYPE.h"
+#include "RE/S/ShaderReferenceEffect.h"
+
+namespace RE
+{
+	class Crime;
+	class MuzzleFlash;
+	class PositionPlayerEvent;
+	class SyncQueueObj;
+
+	class __declspec(novtable) ProcessLists :
+		public BSTEventSink<PositionPlayerEvent>,  // 000
+		public BSTSingletonSDM<ProcessLists>       // 008
+	{
+	public:
+		static constexpr auto RTTI{ RTTI::ProcessLists };
+		static constexpr auto VTABLE{ VTABLE::ProcessLists };
+
+		virtual ~ProcessLists();  // 00
+
+		// override
+		virtual BSEventNotifyControl ProcessEvent(const PositionPlayerEvent&, BSTEventSource<PositionPlayerEvent>*) override;  // 01
+
+		[[nodiscard]] static ProcessLists* GetSingleton()
+		{
+			static REL::Relocation<ProcessLists**> singleton{ ID::ProcessLists::Singleton };
+			return *singleton;
+		}
+
+		[[nodiscard]] bool AreHostileActorsNear(BSScrapArray<ActorHandle>* a_hostileActorArray)
+		{
+			using func_t = decltype(&ProcessLists::AreHostileActorsNear);
+			static REL::Relocation<func_t> func{ ID::ProcessLists::AreHostileActorsNear };
+			return func(this, a_hostileActorArray);
+		}
+
+		void ForEachMagicTempEffect(std::function<BSContainer::ForEachResult(BSTempEffect*)> a_callback)
+		{
+			BSAutoLock locker(magicEffectsLock);
+
+			for (auto& tempEffectPtr : magicEffects) {
+				const auto& tempEffect = tempEffectPtr.get();
+				if (tempEffect && a_callback(tempEffect) == BSContainer::ForEachResult::kStop) {
+					break;
+				}
+			}
+		}
+
+		void ForEachModelEffect(std::function<BSContainer::ForEachResult(ModelReferenceEffect*)> a_callback)
+		{
+			ForEachMagicTempEffect([a_callback](BSTempEffect* a_tempEffect) {
+				const auto modelEffect = a_tempEffect->As<ModelReferenceEffect>();
+				if (modelEffect && a_callback(modelEffect) == BSContainer::ForEachResult::kStop) {
+					return BSContainer::ForEachResult::kStop;
+				}
+				return BSContainer::ForEachResult::kContinue;
+			});
+		}
+
+		void ForEachShaderEffect(std::function<BSContainer::ForEachResult(ShaderReferenceEffect*)> a_callback)
+		{
+			ForEachMagicTempEffect([a_callback](BSTempEffect* a_tempEffect) {
+				const auto shaderEffect = a_tempEffect->As<ShaderReferenceEffect>();
+				if (shaderEffect && a_callback(shaderEffect) == BSContainer::ForEachResult::kStop) {
+					return BSContainer::ForEachResult::kStop;
+				}
+				return BSContainer::ForEachResult::kContinue;
+			});
+		}
+
+		[[nodiscard]] bool IsActorTargetingREFinPackage(const TESObjectREFR* a_actor, PTYPE a_type, bool a_onlyHigh)
+		{
+			using func_t = decltype(&ProcessLists::IsActorTargetingREFinPackage);
+			static REL::Relocation<func_t> func{ ID::ProcessLists::IsActorTargetingREFinPackage };
+			return func(this, a_actor, a_type, a_onlyHigh);
+		}
+
+		[[nodiscard]] std::int16_t RequestHighestDetectionLevelAgainstActor(Actor* a_actor, std::uint32_t& a_LOSCount)
+		{
+			using func_t = decltype(&ProcessLists::RequestHighestDetectionLevelAgainstActor);
+			static REL::Relocation<func_t> func{ ID::ProcessLists::RequestHighestDetectionLevelAgainstActor };
+			return func(this, a_actor, a_LOSCount);
+		}
+
+		// members
+		BSSemaphore                             movementSyncSema;               // 010
+		float                                   crimeUpdateTimer;               // 018
+		float                                   removeExcessDeadTimer;          // 01C
+		std::int32_t                            numberHighActors;               // 020
+		std::int32_t                            numberFullyEnabledHighActors;   // 024
+		std::int32_t                            crimeNumber;                    // 028
+		ActorHandle                             statdetect;                     // 02C
+		bool                                    runDetection;                   // 030
+		bool                                    showDetectionStats;             // 031
+		bool                                    processHigh;                    // 032
+		bool                                    processLow;                     // 033
+		bool                                    processMHigh;                   // 034
+		bool                                    processMLow;                    // 035
+		bool                                    processSche;                    // 036
+		bool                                    showSubtitle;                   // 037
+		bool                                    updatingLowList;                // 038
+		float                                   secondsPassedNoProcess;         // 03C
+		BSTArray<ActorHandle>                   highActorHandles;               // 040
+		BSTArray<ActorHandle>                   lowActorHandles;                // 058
+		BSTArray<ActorHandle>                   middleHighActorHandles;         // 070
+		BSTArray<ActorHandle>                   middleLowActorHandles;          // 088
+		BSTArray<ActorHandle>*                  allProcesss[4];                 // 0A0
+		BSSimpleList<Crime*>*                   globalCrimes[7];                // 0C0
+		BSTArray<NiPointer<BSTempEffect>>       globalTempEffects;              // 0F8
+		BSSpinLock                              globalEffectsLock;              // 110
+		BSTArray<NiPointer<BSTempEffect>>       magicEffects;                   // 118
+		BSSpinLock                              magicEffectsLock;               // 130
+		BSTArray<NiPointer<BSTempEffect>>       interfaceEffects;               // 138
+		BSSpinLock                              interfaceEffectsLock;           // 150
+		BSSimpleList<MuzzleFlash*>              referenceMuzzleFlashes;         // 158
+		BSTArray<ObjectRefHandle>               tempShouldMoves;                // 168
+		BSSimpleList<ActorHandle>               aliveActors;                    // 180
+		BSSimpleList<ActorHandle>               idleChatterActors;              // 190
+		BSSimpleList<ActorHandle>               randomDialogueActors;           // 1A0
+		BSTArray<ActorHandle>                   initPackageLocationsQueue;      // 1B0
+		BSSpinLock                              packageLocationsQueueLock;      // 1C8
+		BSTArray<ActorHandle>                   initAnimPositionQueue;          // 1D0
+		BSTArray<BSTSmartPointer<SyncQueueObj>> syncPositionQueue;              // 1E8
+		float                                   playerActionCommentTimer;       // 200
+		float                                   playerKnockObjectCommentTimer;  // 204
+		std::uint32_t                           currentLowActor;                // 208
+		std::uint32_t                           currentMiddleHighActor;         // 20C
+		std::uint32_t                           currentMiddleLowActor;          // 210
+		bool                                    runSchedules;                   // 214
+		bool                                    runMovement;                    // 215
+		bool                                    runAnimations;                  // 216
+		bool                                    updateActorsInPlayerCell;       // 217
+	};
+	static_assert(sizeof(ProcessLists) == 0x218);
+}