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,94 @@
+#pragma once
+
+#include "RE/B/BSScaleformTranslator.h"
+#include "RE/B/BSStringT.h"
+#include "RE/B/BSTEvent.h"
+#include "RE/B/BSTSingleton.h"
+#include "Scaleform/G/GFx_Loader.h"
+#include "Scaleform/G/GFx_Movie.h"
+#include "Scaleform/P/Ptr.h"
+
+namespace Scaleform::GFx
+{
+	class DrawTextManager;
+}
+
+namespace RE
+{
+	class BSScaleformImageLoader;
+	class BSScaleformRenderer;
+	class IMenu;
+	class SFRendererInitializedEvent;
+
+	class __declspec(novtable) BSScaleformManager :
+		public BSTEventSink<SFRendererInitializedEvent>,  // 00
+		public BSTSingletonSDM<BSScaleformManager>        // 08
+	{
+	public:
+		static constexpr auto RTTI{ RTTI::BSScaleformManager };
+		static constexpr auto VTABLE{ VTABLE::BSScaleformManager };
+
+		using ScaleModeType = Scaleform::GFx::Movie::ScaleModeType;
+
+		[[nodiscard]] static BSScaleformManager* GetSingleton()
+		{
+			static REL::Relocation<BSScaleformManager**> singleton{ ID::BSScaleformManager::Singleton };
+			return *singleton;
+		}
+
+		BSScaleformTranslator* GetTranslator() const
+		{
+			return loader->GetStateAddRef<BSScaleformTranslator>();
+		}
+
+		bool IsNameValid(const char* a_name)
+		{
+			using func_t = decltype(&BSScaleformManager::IsNameValid);
+			static REL::Relocation<func_t> func{ ID::BSScaleformManager::IsNameValid };
+			return func(this, a_name);
+		}
+
+		bool LoadMovie(
+			IMenu&                                 a_menu,
+			Scaleform::Ptr<Scaleform::GFx::Movie>& a_movie,
+			const char*                            a_menuName,
+			const char*                            a_menuObjPath = nullptr,
+			ScaleModeType                          a_scaleMode = ScaleModeType::kShowAll,
+			float                                  a_backgroundAlpha = 0.0F)
+		{
+			using func_t = decltype(&BSScaleformManager::LoadMovie);
+			static REL::Relocation<func_t> func{ ID::BSScaleformManager::LoadMovie };
+			return func(this, a_menu, a_movie, a_menuName, a_menuObjPath, a_scaleMode, a_backgroundAlpha);
+		}
+
+		bool LoadMovieEx(
+			IMenu&           a_menu,
+			std::string_view a_filePath,
+			std::string_view a_menuObjPath = ""sv,
+			ScaleModeType    a_scaleMode = ScaleModeType::kShowAll,
+			float            a_backgroundAlpha = 0.0F);
+
+		// members
+		Scaleform::GFx::Loader*                         loader;          // 10
+		BSScaleformRenderer*                            renderer;        // 18
+		Scaleform::Ptr<Scaleform::GFx::DrawTextManager> textManager;     // 20
+		Scaleform::Ptr<BSScaleformImageLoader>          imageLoader;     // 28
+		BSString                                        validNameChars;  // 30
+
+	private:
+		[[nodiscard]] bool GetMovieFilename(char const* a_menuName, BSStaticStringT<260>& a_filePath)
+		{
+			using func_t = decltype(&BSScaleformManager::GetMovieFilename);
+			static REL::Relocation<func_t> func{ ID::BSScaleformManager::GetMovieFilename };
+			return func(this, a_menuName, a_filePath);
+		}
+
+		void InitMovieViewport(Scaleform::GFx::Movie& a_movie, const float a_dynamicWidthRatio, const float a_dynamicHeightRatio)
+		{
+			using func_t = decltype(&BSScaleformManager::InitMovieViewport);
+			static REL::Relocation<func_t> func{ ID::BSScaleformManager::InitMovieViewport };
+			return func(this, a_movie, a_dynamicWidthRatio, a_dynamicHeightRatio);
+		}
+	};
+	static_assert(sizeof(BSScaleformManager) == 0x40);
+}