Commonwealth-Online/Commonwealth-Online-Public
2
0
Fork 0
Code Pull Requests Activity

docs: add plugin setup guide

Browse Source
This commit is contained in:
andrew
2026-05-30 18:33:24 +12:00
parent f3db41c402
commit b61043a3fe
1776 changed files with 122386 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugin/lib/commonlibf4/include/RE/P/PlayerCharacter.h
+537
View File
@@ -0,0 +1,537 @@
#pragma once
#include "RE/A/AITimeStamp.h"
#include "RE/A/Actor.h"
#include "RE/B/BGSCharacterTint.h"
#include "RE/B/BGSEquipIndex.h"
#include "RE/B/BGSObjectInstance.h"
#include "RE/B/BSPointerHandle.h"
#include "RE/B/BSSimpleList.h"
#include "RE/B/BSSoundHandle.h"
#include "RE/B/BSSpinLock.h"
#include "RE/B/BSTArray.h"
#include "RE/B/BSTEvent.h"
#include "RE/B/BSTHashMap.h"
#include "RE/B/BSTSmartPointer.h"
#include "RE/B/BSTTuple.h"
#include "RE/C/CrimeGoldStruct.h"
#include "RE/D/DifficultyLevel.h"
#include "RE/F/FriendshipFactionsStruct.h"
#include "RE/I/IMovementPlayerControlsFilter.h"
#include "RE/N/NiPoint3.h"
#include "RE/N/NiPointer.h"
#include "RE/N/NiTMap.h"
#include "RE/P/PLAYER_TARGET_LOC.h"
#include "RE/P/PlayerAutoAimActorEvent.h"
#include "RE/P/PlayerCommandTypeEvent.h"
#include "RE/P/PlayerCoverData.h"
#include "RE/S/SCENE_ACTION_PLAYER_RESPONSE_TYPE.h"
#include "RE/S/SayOnceTimeStampStruct.h"
#include "RE/S/StolenItemValueStruct.h"
#include "RE/S/SubgraphHandle.h"
#include "RE/T/TeleportPath.h"
#include "RE/X/XPChangeData.h"
namespace RE
{
enum class DEFAULT_OBJECT;
enum class PLAYER_ACTION;
class BGSActorCellEvent;
class BGSActorDeathEvent;
class BGSInstancedQuestObjective;
class BipedAnim;
class BSLight;
class BSPathingSolution;
class Crime;
class EquippedItem;
class ImageSpaceModifierInstanceDOF;
class ImageSpaceModifierInstanceForm;
class ItemChange;
class MenuModeChangeEvent;
class MenuOpenCloseEvent;
class NiAVObject;
class NiLight;
class NiNode;
class OtherEventEnabledEvent;
class PickRefUpdateEvent;
class PlayerActionObject;
class PositionPlayerEvent;
class QuestTargetArray;
class TESHitEvent;
class TESQuestStageItem;
class UserEventEnabledEvent;
namespace PerkValueEvents
{
class PerkEntryUpdatedEvent;
}
inline bool IsPlayerInDialogue()
{
using func_t = decltype(&IsPlayerInDialogue);
static REL::Relocation<func_t> func{ ID::IsPlayerInDialogue };
return func();
}
class __declspec(novtable) PlayerCharacter :
public Actor, // 000
public BSTEventSource<BGSActorCellEvent>, // 4C8
public BSTEventSource<BGSActorDeathEvent>, // 520
public BSTEventSource<PositionPlayerEvent>, // 578
public BSTEventSource<PickRefUpdateEvent>, // 5D0
public BSTEventSink<MenuOpenCloseEvent>, // 490
public BSTEventSink<MenuModeChangeEvent>, // 498
public BSTEventSink<UserEventEnabledEvent>, // 4A0
public BSTEventSink<OtherEventEnabledEvent>, // 4A8
public BSTEventSink<TESHitEvent>, // 4B0
public BSTEventSink<PerkValueEvents::PerkEntryUpdatedEvent>, // 4B8
public IMovementPlayerControlsFilter // 4C0
{
public:
static constexpr auto RTTI{ RTTI::PlayerCharacter };
static constexpr auto VTABLE{ VTABLE::PlayerCharacter };
static constexpr auto FORM_ID{ ENUM_FORM_ID::kACHR };
enum class CHAR_GEN_DISABLE_FLAGS
{
kDisableSave = 0x1,
kDisableWait = 0x2,
kShowControlsDisabledMessage = 0x4
};
enum class GrabbingType
{
kNone = 0x0,
kNormal = 0x1,
kTelekinesis = 0x2
};
enum class PROGRESS_EVENT
{
kLevelUp = 0x0,
kDeath = 0x1,
kChargen = 0x2
};
class PlayerActionObject
{
public:
// members
float timer; // 0
ObjectRefHandle refObj; // 4
REX::TEnumSet<PLAYER_ACTION, std::int32_t> next; // 8
};
static_assert(sizeof(PlayerActionObject) == 0xC);
class ScopedInventoryChangeMessageContext
{
public:
ScopedInventoryChangeMessageContext(bool a_suppressMessages, bool a_suppressAudio) :
suppressMessages(a_suppressMessages), suppressAudio(a_suppressAudio)
{
ctor(suppressMessages, suppressAudio);
}
~ScopedInventoryChangeMessageContext()
{
dtor();
}
// members
const bool suppressMessages{ false }; // 00
const bool suppressAudio{ false }; // 01
private:
void ctor(bool a_suppressMessages, bool a_suppressAudio)
{
using func_t = decltype(&ScopedInventoryChangeMessageContext::ctor);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::ScopedInventoryChangeMessageContext::ctor };
return func(this, a_suppressMessages, a_suppressAudio);
}
void dtor()
{
using func_t = decltype(&ScopedInventoryChangeMessageContext::dtor);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::ScopedInventoryChangeMessageContext::dtor };
return func(this);
}
};
static_assert(sizeof(ScopedInventoryChangeMessageContext) == 0x2);
// add
virtual void InitiateSpectator(Actor*) { return; } // 133
virtual std::uint32_t GetViolentCrimeGoldValue(const TESFaction* a_faction); // 134
virtual std::uint32_t GetNonViolentCrimeGoldValue(const TESFaction* a_faction); // 135
virtual void ClearAllCrimeGold(TESFaction* a_faction); // 136
[[nodiscard]] static PlayerCharacter* GetSingleton()
{
static REL::Relocation<NiPointer<PlayerCharacter>*> singleton{ ID::PlayerCharacter::Singleton };
return singleton->get();
}
[[nodiscard]] static ActorHandle GetPlayerHandle()
{
static REL::Relocation<ActorHandle*> singleton{ ID::PlayerCharacter::GetPlayerHandle };
return *singleton;
}
DifficultyLevel GetDifficultyLevel()
{
using func_t = decltype(&PlayerCharacter::GetDifficultyLevel);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::GetDifficultyLevel };
return func(this);
}
bool IsGodMode()
{
using func_t = decltype(&PlayerCharacter::IsGodMode);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::IsGodMode };
return func(this);
}
bool IsHolotapePlaying(BGSNote* a_holotape)
{
using func_t = decltype(&PlayerCharacter::IsHolotapePlaying);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::IsHolotapePlaying };
return func(this, a_holotape);
}
bool IsImmortal()
{
using func_t = decltype(&PlayerCharacter::IsImmortal);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::IsImmortal };
return func(this);
}
bool IsLockedOutOfTerminal(ObjectRefHandle a_handle);
bool IsPipboyLightOn()
{
using func_t = decltype(&PlayerCharacter::IsPipboyLightOn);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::IsPipboyLightOn };
return func(this);
}
void LockOutOfTerminal(ObjectRefHandle a_handle);
void PauseHolotape(BGSNote* a_holotape)
{
using func_t = decltype(&PlayerCharacter::PauseHolotape);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::PauseHolotape };
return func(this, a_holotape);
}
void PlayHolotape(BGSNote* a_holotape)
{
using func_t = decltype(&PlayerCharacter::PlayHolotape);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::PlayHolotape };
return func(this, a_holotape);
}
void QueueFastTravel(ObjectRefHandle a_marker, bool a_allowAutoSave)
{
using func_t = decltype(&PlayerCharacter::QueueFastTravel);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::QueueFastTravel };
return func(this, a_marker, a_allowAutoSave);
}
void RemoveLastUsedPowerArmor()
{
using func_t = decltype(&PlayerCharacter::RemoveLastUsedPowerArmor);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::RemoveLastUsedPowerArmor };
return func(this);
}
void SelectPerk(TESFormID a_formID, std::int8_t a_rank = 0)
{
using func_t = decltype(&PlayerCharacter::SelectPerk);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SelectPerk };
return func(this, a_formID, a_rank);
}
void SetEscaping(bool a_flag, bool a_escaped)
{
using func_t = decltype(&PlayerCharacter::SetEscaping);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SetEscaping };
return func(this, a_flag, a_escaped);
}
void SetVATSCriticalCount(uint32_t a_critCount)
{
using func_t = decltype(&PlayerCharacter::SetVATSCriticalCount);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SetVATSCriticalCount };
return func(this, a_critCount);
}
void ShowPipboyLight(bool a_show, bool a_skipEffects)
{
using func_t = decltype(&PlayerCharacter::ShowPipboyLight);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::ShowPipboyLight };
return func(this, a_show, a_skipEffects);
}
void SetLastDialogueInput(uint32_t dialogueOption)
{
using func_t = decltype(&PlayerCharacter::SetLastDialogueInput);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SetLastDialogueInput };
return func(this, dialogueOption);
}
void ClearPrison()
{
using func_t = decltype(&PlayerCharacter::ClearPrison);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::ClearPrison };
return func(this);
}
bool ReloadWeapon(const BGSObjectInstanceT<TESObjectWEAP>* a_weapon, BGSEquipIndex a_equipIndex)
{
using func_t = decltype(&PlayerCharacter::ReloadWeapon);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::ReloadWeapon };
return func(this, a_weapon, a_equipIndex);
}
void SetPerkCount(std::uint8_t a_count)
{
using func_t = decltype(&PlayerCharacter::SetPerkCount);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SetPerkCount };
return func(this, a_count);
}
bool HasLOSToTarget(Actor* a_targetRef, bool* pickPerformed)
{
using func_t = decltype(&PlayerCharacter::HasLOSToTarget);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::HasLOSToTarget };
return func(this, a_targetRef, pickPerformed);
}
void SetAIControlledPackage(bool a_enable)
{
using func_t = decltype(&PlayerCharacter::SetAIControlledPackage);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::SetAIControlledPackage };
return func(this, a_enable);
}
void EnableRadio(bool a_enable)
{
using func_t = decltype(&PlayerCharacter::EnableRadio);
static REL::Relocation<func_t> func{ ID::PlayerCharacter::EnableRadio };
return func(this, a_enable);
}
// members
BSSpinLock actorToDisplayOnHUDLock; // 628
BSSpinLock questTargetLock; // 630
BSTHashMap<const TESFaction*, CrimeGoldStruct> crimeGoldMap; // 638
BSTHashMap<const TESFaction*, StolenItemValueStruct> stolenItemValueMap; // 668
PlayerCoverData coverData; // 698
ObjectRefHandle commandWaitMarker; // 6C4
BSTHashMap<const TESFaction*, FriendshipFactionsStruct> factionOwnerFriendsMap; // 6C8
NiPoint3A lastKnownGoodPosition; // 700
NiPoint3A lastKnownGoodNavmeshPosition; // 710
NiPoint3 bulletAutoAim; // 720
NiPoint3 cachedVelocity; // 72C
BSTArray<ObjectRefHandle> currentMapMarkers; // 738
BSTArray<BSTTuple<NiPoint3, AITimeStamp>> velocityArray; // 750
BSTArray<ProjectileHandle> runesCast; // 768
BSTArray<TESImageSpaceModifier*> animationImageSpaceModifiers; // 78-
BSTArray<ImageSpaceModifierInstanceForm*> animationImageSpaceInstances; // 798
BSTArray<BSTTuple<NiPointer<NiLight>, bool>> playerLights; // 7B0
BSSimpleList<TESQuestStageItem*> questLog; // 7C8
BSTArray<BGSInstancedQuestObjective> objectives; // 7D9
BSTHashMap<TESQuest*, QuestTargetArray*> questTargets; // 7F0
BSTHashMap<std::uint32_t, SayOnceTimeStampStruct> currentSayOnceInfosMap; // 820
BSTHashMap<std::uint32_t, SayOnceTimeStampStruct> currentSpeechRepeatMap; // 850
BSSimpleList<ObjectRefHandle> droppedRefList; // 880
NiTMap<std::uint32_t, std::uint8_t> randomDoorSpaceMap; // 890
TESWorldSpace* cachedWorldspace; // 8B0
NiPoint3 exteriorPosition; // 8B8
BSTSmallArray<SubgraphHandle, 2> pipboyAnimSubGraph; // 8C8
PLAYER_TARGET_LOC queuedTargetLoc; // 8E8
PLAYER_TARGET_LOC queuedFlightLoc; // 948
NiPoint3A flightGridCenter; // 9B0
BSPathingSolution* flightMountPathingSolution; // 9C0
const TESObjectCELL* flightMountPreloadCell; // 9C8
BSSoundHandle magicFailureSound; // 9D0
BSTArray<std::uint32_t> rumorTopicInfoList; // 9D8
std::uint32_t testChallangeInfoID; // 9F0
DialoguePackage* closestConversation; // 9F8
DialoguePackage* aiConversationRunning; // A00
std::int32_t numberofStealWarnings; // A08
float stealWarningTimer; // A0C
std::int32_t numberofPickpocketWarnings; // A10
float pickPocketWarningTimer; // A14
AITimeStamp warnToLeaveTimeStamp; // A18
AITimeStamp usingTeleportDoorTimeStamp; // A1C
NiPointer<ImageSpaceModifierInstanceDOF> ironsightsDOFInstance; // A20
TESFaction* currentPrisonFaction; // A28
std::uint32_t jailSentence; // A30
NiPointer<NiAVObject> autoAimDebugSphere; // A38
BGSNote* currHolotape; // A40
BSSoundHandle soundHand; // A48
std::int32_t vampireFeedDetection; // A50
std::uint32_t mapMarkerIterator; // A54
ObjectRefHandle forceActivateRef; // A58
ObjectRefHandle loopingActivateRef; // A5C
std::uint32_t dialogueCameraLastSceneID; // A60
PlayerActionObject playerActionObjects[15]; // A64
REX::TEnumSet<PLAYER_ACTION, std::int32_t> mostRecentAction; // B18
ActorHandle actorDoingPlayerCommand; // B1C
BSTValueEventSource<PlayerCommandTypeEvent> playerCurrentCommandType; // B20
BSTArray<void*> grabSprings; // B38 - hkRefPtr<hknpBSMouseSpringAction>
NiPoint3 grabUserRotation; // B50
ObjectRefHandle grabbedObject; // B5C
float grabObjectWeight; // B60
float grabDistance; // B64
std::uint32_t secondsToSleepPerUpdate; // B68
std::uint32_t sleepSeconds; // B6C
BSTSmartPointer<BipedAnim> firstPersonBipedAnim; // B70
NiPointer<NiNode> firstPerson3D; // B78
NiAVObject* firstPersonTorso; // B80
NiAVObject* firstPersonEye; // B88
float eyeHeight; // B90
float greetTimer; // B94
float encumberedTimer; // B98
float powerAttackTimer; // B9C
float autoReloadTimer; // BA0
float pivotToFaceCamera; // BA4
std::int32_t hourstosleep; // BA8
std::int32_t amountStolenSold; // BAC
std::uint32_t valueStolen; // BB0
ActorHandle lastRiddenMount; // BB4
ActorHandle lightTarget; // BB8
float sortActorDistanceTimer; // BBC
float sitHeadingDelta; // BC0
ObjectRefHandle playerMapMarker; // BC4
TeleportPath* playerMarkerPath; // BC8
std::uint32_t skillTrainingsThisLevel; // BD0
TESClass* defaultClass; // BD8
std::uint32_t crimeCounts[7]; // BE0
AlchemyItem* pendingPoison; // C00
std::time_t lastPlayingTimeUpdate; // C08
std::time_t totalPlayingTime; // C10
std::uint32_t characterSeed; // C18
TESForm* lastKnownGoodLocation; // C20
NiPointer<BSLight> firstPersonLight; // C28
NiPointer<BSLight> thirdPersonLight; // C30
NiPointer<BSLight> pipboyLight; // C38
NiPointer<NiLight> niPipboyLight; // C40
float dropAngleMod; // C48
float lastDropAngleMod; // C4C
BSTValueEventSource<PlayerAutoAimActorEvent> autoAimActor; // C50
ObjectRefHandle homingTarget; // C68
float homingTargetTimer; // C6C
NiPointer<NiAVObject> targeted3D; // C70
CombatGroup* combatGroup; // C78
BSTArray<ActorHandle> actorsToDisplayOnTheHUD; // C80
BSTArray<EquippedItem> lastOneHandItems; // C98
std::uint32_t teammateCount; // CB0
float combatTimer; // CB4
float yieldTimer; // CB8
float chaseTimer; // CBC
float drawSheatheSafetyTimer; // CC0
std::uint32_t activeCombatantCount; // CC4
BGSLocation* currentLocation; // CC8
AITimeStamp cachedVelocityTimeStamp; // CD0
float telekinesisDistance; // CD4
float commandTimer; // CD8
float dialogueCameraChangeRate; // CDC
float fireWeaponEventTimer; // CE0
REX::TEnumSet<DEFAULT_OBJECT, std::int32_t> animationObjectAction; // CE4
REX::TEnumSet<GrabbingType, std::int32_t> grabType; // CE8
ActorHandle assumedIdentity; // CEC
std::int8_t murder; // CF0
std::int8_t perkCount; // CF1
std::int8_t byCharGenFlag; // CF2
Crime* resistArrestCrime; // CF8
BGSCharacterTint::Entries* tintingData; // D00
BGSTextureSet* complexion; // D08
TESRace* charGenRace; // D10
EffectSetting* currentAlchemyEffect; // D18
ItemChange* currentTemperingInventoryItem; // D20
TESObjectREFR* commandTarget; // D28
TESObjectREFR* walkThroughDoor; // D30
REX::TEnumSet<COMMAND_TYPE, std::int32_t> currentCommand; // D38
REX::TEnumSet<SCENE_ACTION_PLAYER_RESPONSE_TYPE, std::int32_t> playerDialogueInput; // D3C
ActorValueInfo* stimpakTarget; // D40
float vatsCriticalCharge; // D48
std::uint32_t vatsCriticalCount; // D4C
std::uint32_t maxVATSCriticalCount; // D50
float timeBlendingOutFirstPersonOffset; // D54
ActorHandle lastMagnetismActor; // D58
NiPoint3 magnetismActorPos; // D5C
ObjectRefHandle workstationBeingLeft; // D68
ActorHandle actorLeavingWorkstation; // D6C
BGSScene* allowDialogueCameraScene; // D70
ActorHandle helloActor; // D78
TESObjectREFR* weaponAmmoRef; // D80
std::int32_t equippingAmmoCount; // D88
float dialogueCameraResumeTimer; // D8C
ObjectRefHandle lastUsedPowerArmor; // D90
TeleportPath* lastUsedPowerArmorMarkerPath; // D98
TESObjectWEAP* lastUsedThrownWeapon; // DA0
BSSoundHandle powerArmorInteriorSoundHandle; // DA8
BSTArray<BSTTuple<ObjectRefHandle, float>> lockedTerminals; // DB0
BSTArray<BSTTuple<std::int32_t, std::int32_t>> boneMapping1stTo3rd; // DC8
BSTOptional<XPChangeData> syncedXPChange; // DE0
std::int32_t queuedSwitch: 1; // DF4:00
std::uint32_t charGenHUDMode; // DF8
bool insideMemoryHUDMode: 1; // DFC:0
bool xpSyncedWithHUDNotification: 1; // DFC:1
bool travelUseDoor: 1; // DFC:2
bool transporting: 1; // DFC:3
bool overAutoAimTarget: 1; // DFC:4
bool showQuestItemsInInventory: 1; // DFC:5
bool hostileDetection: 1; // DFC:6
bool escaping: 1; // DFC:7
bool forceQuestTargetRepath: 1; // DFD:0
bool speaking: 1; // DFD:1
bool isSleeping: 1; // DFD:2
bool actorinSneakRange: 1; // DFD:3
bool greetingPlayer: 1; // DFD:4
bool beenAttacked: 1; // DFD:5
bool allowEGMCacheClear: 1; // DFD:6
bool aiControlledToPos: 1; // DFD:7
bool aiControlledFromPos: 1; // DFE:0
bool aiControlledPackage: 1; // DFE:1
bool returnToLastKnownGoodPosition: 1; // DFE:2
bool beingChased: 1; // DFE:3
bool is3rdPersonModelShown: 1; // DFE:4
bool hideFirstPersonGeometry: 1; // DFE:5
bool insufficientChargeMessageShownL: 1; // DFE:6
bool insufficientChargeMessageShownR: 1; // DFE:7
bool target3DDistant: 1; // DFF:0
bool playerInCombat: 1; // DFF:1
bool attemptedYieldInCurrentCombat: 1; // DFF:2
bool currentAlchemyIsPoison: 1; // DFF:3
bool positioning: 1; // DFF:4
bool crimeReporting: 1; // DFF:5
bool healthTutorialShown: 1; // DFF:6
bool magickaTutorialShown: 1; // DFF:7
bool staminaTutorialShown: 1; // E00:0
bool goToJailQueued: 1; // E00:1
bool doorAutosaveQueued: 1; // E00:2
bool sprintToggled: 1; // E00:3
bool useHighSpeedLoading: 1; // E00:4
bool sceneActionActive: 1; // E00:5
bool sayingHello: 1; // E00:6
bool disabledRadio: 1; // E00:7
bool updateAutoAimActor: 1; // E01:0
bool autoReload: 1; // E01:1
bool usingScopeWithOverlay: 1; // E01:2
bool steadyingWeapon: 1; // E01:3
bool speechChallengeReward: 1; // E01:4
bool blendOutFirstPersonOffset: 1; // E01:5
bool dialogueCameraConsiderResume: 1; // E01:6
bool shouldFollowerSupressIdleChatter: 1; // E01:7
bool idleChatter: 1; // E02:0
bool switchingPerspectives: 1; // E02:1
bool onElevator: 1; // E02:2
bool sayCommandResponse: 1; // E02:3
bool inLooksMenu: 1; // E02:4
bool playingTimeFrozen: 1; // E02:5
bool everModded: 1; // E02:6
};
static_assert(sizeof(PlayerCharacter) == 0xE10);
}