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,195 @@
+#pragma once
+
+#include "RE/B/BGSLocalizedString.h"
+#include "RE/B/BSFixedString.h"
+#include "RE/B/BSTArray.h"
+#include "RE/T/TESCondition.h"
+
+namespace RE
+{
+	namespace BGSCharacterTint
+	{
+		enum class BlendOp : std::uint32_t
+		{
+			kDefault = 0x0,
+			kMultiply = 0x1,
+			kOverlay = 0x2,
+			kSoftLight = 0x3,
+			kHardLight = 0x4,
+			kTotal = 0x5
+		};
+
+		enum class EntryType : std::uint32_t
+		{
+			kMask = 0x0,
+			kPalette = 0x1,
+			kTexture = 0x2,
+			kUnknown = 0x3
+		};
+
+		enum class EntrySlot
+		{
+			kForeheadMask = 0x0,
+			kEyesMask = 0x1,
+			kNoseMask = 0x2,
+			kEarsMask = 0x3,
+			kCheeksMask = 0x4,
+			kMouthMask = 0x5,
+			kNeckMask = 0x6,
+			kLipColor = 0x7,
+			kCheekColor = 0x8,
+			kEyeliner = 0x9,
+			kEyeSocketUpper = 0xA,
+			kEyeSocketLower = 0xB,
+			kSkinTone = 0xC,
+			kPaint = 0xD,
+			kLaughLines = 0xE,
+			kCheekColorLower = 0xF,
+			kNose = 0x10,
+			kChin = 0x11,
+			kNeck = 0x12,
+			kForehead = 0x13,
+			kDirt = 0x14,
+			kScars = 0x15,
+			kFaceDetail = 0x16,
+			kBrow = 0x17,
+			kWrinkles = 0x18,
+			kBeard = 0x19
+		};
+
+		namespace Template
+		{
+			class __declspec(novtable) Entry
+			{
+			public:
+				static constexpr auto RTTI{ RTTI::BGSCharacterTint__Template__Entry };
+				static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__Template__Entry };
+
+				enum Flags : std::uint32_t
+				{
+					kOnOffOnly = 0x1,
+					kIsChargenDetaul = 0x2,
+					kTakesSkinTone = 0x4
+				};
+
+				virtual ~Entry();  // 00
+
+				// add
+				virtual float GetDefaultValue() { return 0.0F; }                    // 01
+				virtual void  InitItem(TESForm* a_owner);                           // 02
+				virtual void  CopyData(BGSCharacterTint::Template::Entry* a_copy);  // 03
+				virtual void  LoadImpl(TESFile* a_file) = 0;                        // 04
+
+				// members
+				BGSLocalizedString                                       name;               // 08
+				TESCondition                                             chargenConditions;  // 10
+				REX::TEnumSet<BGSCharacterTint::EntrySlot, std::int32_t> slot;               // 18
+				const std::uint16_t                                      uniqueID{ 0 };      // 1C
+				std::int8_t                                              flags;              // 1E
+			};
+			static_assert(sizeof(Entry) == 0x20);
+
+			class Group
+			{
+			public:
+				// members
+				BGSLocalizedString name;          // 00
+				std::uint32_t      id;            // 08
+				std::uint32_t      chargenIndex;  // 0C
+				BSTArray<Entry*>   entries;       // 10
+			};
+			static_assert(sizeof(Group) == 0x28);
+
+			class Groups
+			{
+			public:
+				// members
+				BSTArray<Group*> groups;  // 00
+			};
+			static_assert(sizeof(Groups) == 0x18);
+
+			class __declspec(novtable) Palette :
+				public Entry
+			{
+			public:
+				static constexpr auto RTTI{ RTTI::BGSCharacterTint__Template__Palette };
+				static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__Template__Palette };
+
+				class ColorValue
+				{
+				public:
+					BGSColorForm* color;     // 00
+					float         value;     // 08
+					BlendOp       blendOp;   // 0C
+					std::uint16_t swatchID;  // 01
+				};
+				static_assert(sizeof(ColorValue) == 0x18);
+
+				// Members
+				BSFixedString        maskTextureName;
+				std::uint32_t        defaultIndex;
+				BSTArray<ColorValue> colorValues;
+			};
+			static_assert(sizeof(Palette) == 0x48);
+		}
+
+		class __declspec(novtable) Entry
+		{
+		public:
+			static constexpr auto RTTI{ RTTI::BGSCharacterTint__Entry };
+			static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__Entry };
+
+			virtual ~Entry();  // 00
+
+			virtual bool      GetIsIdentical(const Entry* entry);                       // 08
+			virtual bool      CopyData(const Entry entry);                              // 10
+			virtual bool      SetFromTemplateDefault(const Template::Entry* entry);     // 18
+			virtual bool      GetMatchesTemplateDefault(const Template::Entry* entry);  // 20
+			virtual EntryType GetType();                                                // 28
+
+			// Members
+			Entry*        templateEntry;  // 08
+			std::uint16_t idLink;         // 10
+			std::uint8_t  tingingValue;   // 12
+		};
+		static_assert(sizeof(Entry) == 0x18);
+
+		class Entries
+		{
+		public:
+			BSTArray<Entry*> entriesA;
+		};
+		static_assert(sizeof(Entries) == 0x18);
+
+		class __declspec(novtable) MaskEntry :
+			public Entry
+		{
+		public:
+			static constexpr auto RTTI{ RTTI::BGSCharacterTint__MaskEntry };
+			static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__MaskEntry };
+		};
+		static_assert(sizeof(MaskEntry) == 0x18);
+
+		class __declspec(novtable) PaletteEntry :
+			public MaskEntry
+		{
+		public:
+			static constexpr auto RTTI{ RTTI::BGSCharacterTint__PaletteEntry };
+			static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__PaletteEntry };
+
+			// members
+			std::uint32_t tintingColor;  // 18
+			std::uint16_t swatchID;      // 1C
+		};
+		static_assert(sizeof(PaletteEntry) == 0x20);
+
+		class __declspec(novtable) TextureSetEntry :
+			public Entry
+		{
+		public:
+			static constexpr auto RTTI{ RTTI::BGSCharacterTint__TextureSetEntry };
+			static constexpr auto VTABLE{ VTABLE::BGSCharacterTint__TextureSetEntry };
+		};
+		static_assert(sizeof(TextureSetEntry) == 0x18);
+	}
+}