BM 125 SDK

Author: Bakkes

include/bakkesmod/wrappers/GameEvent/ReplayWrapper.h

@@ -5,7 +5,9 @@ template<typename T> class StructArrayWrapper;
 #include ".././Engine/ObjectWrapper.h"
 class ActorWrapper;
 class UnrealStringWrapper;
-
+#ifdef __cpp_lib_filesystem
+#include <filesystem>
+#endif
 #undef GetCurrentTime
 
 class BAKKESMOD_PLUGIN_IMPORT ReplayWrapper : public ObjectWrapper {
@@ -82,6 +84,12 @@ class BAKKESMOD_PLUGIN_IMPORT ReplayWrapper : public ObjectWrapper {
 	ReplayWrapper CreateCopy(float StartTime);
 	void ImportReplay(std::string Path);
 	void ExportReplay(std::string Path);
+#ifdef __cpp_lib_filesystem
+	void ImportReplay(std::filesystem::path Path);
+	void ExportReplay(std::filesystem::path Path);
+#endif
+
+
 	void SkipToFrame(int frame, unsigned long bFlush);
 	void SkipToTime(float Time, unsigned long bFlush);
 	float GetReplayTimeSeconds();

include/bakkesmod/wrappers/GameEvent/SaveData/TrainingEditorSaveDataWrapper.h

@@ -24,11 +24,17 @@ class BAKKESMOD_PLUGIN_IMPORT TrainingEditorSaveDataWrapper : public ObjectWrapp
 	void SetCreatedAt(unsigned long long newCreatedAt);
 	unsigned long long GetUpdatedAt();
 	void SetUpdatedAt(unsigned long long newUpdatedAt);
-	SteamID GetCreatorPlayerID();
+
+	[[deprecated("Use GetCreatorPlayerUniqueID instead")]]
+	SteamID GetCreatorPlayerID(); //DEPRECATED
+	
 	void SetCreatorPlayerID(SteamID newCreatorPlayerID);
 
 	//AUTO-GENERATED FUNCTION PROXIES
 	void Init();
+
+	//SELF-IMPLEMENTED
+	UniqueIDWrapper GetCreatorPlayerUniqueID();
 private:
 	PIMPL
 };

include/bakkesmod/wrappers/GameObject/ClubDetailsWrapper.h

@@ -2,10 +2,13 @@
 #include "../Engine/UnrealStringWrapper.h"
 #include "../StructArrayWrapper.h"
 #include "ClubSettingsWrapper.h"
+#include "../UniqueIDWrapper.h"
 
 struct BAKKESMOD_PLUGIN_IMPORT ClubMember {
 	unsigned char paddingForReasons[72];
-	SteamID GetSteamId();
+	[[deprecated("Use GetUniqueID instead")]]
+	SteamID GetSteamId(); //DEPRECATED
+	UniqueIDWrapper GetUniqueID();
 	UnrealStringWrapper GetName();
 };
 
@@ -23,11 +26,14 @@ class BAKKESMOD_PLUGIN_IMPORT ClubDetailsWrapper : public ClubSettingsWrapper {
 
 	//AUTO-GENERATED FROM FIELDS
 	unsigned long long GetClubID();
-	SteamID GetOwnerPlayerID();
+	[[deprecated("Use GetOwnerPlayerUniqueID instead")]]
+	SteamID GetOwnerPlayerID(); //DEPRECATED
+	UniqueIDWrapper GetOwnerPlayerUniqueID();
 	UnrealStringWrapper GetMotD();
 	unsigned long GetbVerified();
 	unsigned long long GetLastUpdatedTime();
 	StructArrayWrapper<ClubMember> GetMembers();
+
 	//END AUTO-GENERATED FROM FIELDS
 
 	//AUTO-GENERATED FROM METHODS

include/bakkesmod/wrappers/GameObject/PlayerReplicationInfoWrapper.h

@@ -2,6 +2,7 @@
 template<class T> class ArrayWrapper;
 template<typename T> class StructArrayWrapper;
 #include "../WrapperStructs.h"
+#include "../UniqueIDWrapper.h"
 #include ".././Engine/ActorWrapper.h"
 class UnrealStringWrapper;
 class TeamInfoWrapper;
@@ -62,15 +63,22 @@ class BAKKESMOD_PLUGIN_IMPORT PlayerReplicationInfoWrapper : public ActorWrapper
 	float GetExactPing();
 	void SetExactPing(float newExactPing);
 	UnrealStringWrapper GetSavedNetworkAddress();
-	SteamID GetUniqueId();
-	void SetUniqueId(SteamID newUniqueId);
+	[[deprecated("Use GetUniqueIdWrapper instead")]]
+	SteamID GetUniqueId();//DEPRECATED
+	[[deprecated("Use SetUniqueId that takes UniqueIDWrapper instead")]]
+	void SetUniqueId(SteamID newUniqueId);//DEPRECATED
+
+	UniqueIDWrapper GetUniqueIdWrapper();
+	void SetUniqueId(UniqueIDWrapper newUniqueId);
 
 	//AUTO-GENERATED FUNCTION PROXIES
 	void UnregisterPlayerFromSession();
 	void RegisterPlayerWithSession();
 	bool IsInvalidName();
 	unsigned char GetTeamNum();
-	void SetUniqueId2(SteamID& PlayerUniqueId);
+	[[deprecated("Use SetUniqueId2 that takes UniqueIDWrapper instead")]]
+	void SetUniqueId2(SteamID& PlayerUniqueId);//DEPRECATED
+	void SetUniqueId2(UniqueIDWrapper& PlayerUniqueId);
 	void SeamlessTravelTo(PlayerReplicationInfoWrapper NewPRI);
 	void IncrementDeaths(int Amt);
 	void CopyProperties(PlayerReplicationInfoWrapper PRI);

include/bakkesmod/wrappers/GameObject/PriWrapper.h

@@ -9,6 +9,7 @@ class GameEventWrapper;
 class FXActorWrapper;
 class AirControlComponentWrapper;
 class ClubDetailsWrapper;
+class UniqueIDWrapper;
 
 class BAKKESMOD_PLUGIN_IMPORT PriWrapper : public PriXWrapper {
 public:
@@ -91,8 +92,15 @@ class BAKKESMOD_PLUGIN_IMPORT PriWrapper : public PriXWrapper {
 	void SetPawnType(unsigned char newPawnType);
 	unsigned char GetReplicatedWorstNetQualityBeyondLatency();
 	void SetReplicatedWorstNetQualityBeyondLatency(unsigned char newReplicatedWorstNetQualityBeyondLatency);
-	SteamID GetPartyLeader();
-	void SetPartyLeader(SteamID newPartyLeader);
+
+	[[deprecated("Use GetPartyLeaderID instead")]]
+	SteamID GetPartyLeader();//DEPRECATED
+	[[deprecated("Use SetPartyLeader that takes UniqueIDWrapper instead")]]
+	void SetPartyLeader(SteamID newPartyLeader);//DEPRECATED
+
+	UniqueIDWrapper GetPartyLeaderID();
+	void SetPartyLeader(UniqueIDWrapper newPartyLeader);
+
 	int GetTotalXP();
 	void SetTotalXP(int newTotalXP);
 	int GetXpLevel();
@@ -213,8 +221,10 @@ class BAKKESMOD_PLUGIN_IMPORT PriWrapper : public PriXWrapper {
 	void ServerSplitScreenStatusChanged(unsigned long bInSplitScreen);
 	void UpdateSplitScreenStatus();
 	void OnPartyLeaderChanged();
-	void ServerSetPartyLeader(SteamID& InPartyLeader, unsigned long bInParty);
-	void SetPartyLeader2(SteamID& InPartyLeader, unsigned long bInParty);
+	[[deprecated("Function definition is empty and thus will not work")]]
+	void ServerSetPartyLeader(SteamID& InPartyLeader, unsigned long bInParty);//DEPRECATED
+	[[deprecated("Function definition is empty and thus will not work")]]
+	void SetPartyLeader2(SteamID& InPartyLeader, unsigned long bInParty);//DEPRECATED
 	void UpdatePartyStatus();
 	void OnSkillTierChanged();
 	void ReplicateSkillTier(int NewTier);

include/bakkesmod/wrappers/GameObject/PriXWrapper.h

@@ -14,7 +14,8 @@ class BAKKESMOD_PLUGIN_IMPORT PriXWrapper : public PlayerReplicationInfoWrapper
 	//AUTO-GENERATED FUNCTION PROXIES
 	void eventDestroyed();
 	void OnUniqueIdChanged();
-	void SetUniqueId(SteamID& PlayerUniqueId);
+	[[deprecated("Function definition is empty and thus will not work")]]
+	void SetUniqueId(SteamID& PlayerUniqueId);//DEPRECATED
 	void UnregisterPlayerFromSession();
 	void RegisterPlayerWithSession();
 	void OnTeamChanged();

include/bakkesmod/wrappers/GameWrapper.h

@@ -8,6 +8,10 @@
 #include <typeindex>
 #include "canvaswrapper.h"
 #include "mmrwrapper.h"
+
+#ifdef __cpp_lib_filesystem
+#include <filesystem>
+#endif
 class GameEventWrapper;
 class TutorialWrapper;
 class ServerWrapper;
@@ -23,6 +27,7 @@ class BindingsWrapper;
 class SequenceWrapper;
 class ItemsWrapper;
 class ClubDetailsWrapper;
+class UnrealStringWrapper;
 
 class BAKKESMOD_PLUGIN_IMPORT GameWrapper
 {
@@ -41,7 +46,11 @@ class BAKKESMOD_PLUGIN_IMPORT GameWrapper
 	bool IsSpectatingInOnlineGame();
 
 	bool IsPaused();
+	bool IsUsingEpicVersion();
+	bool IsUsingSteamVersion();
 
+	int GetSteamVersion();
+	std::string GetPsyBuildID();
 
 	ServerWrapper					GetOnlineGame();
 	//TutorialWrapper				GetGameEventAsTutorial();
@@ -79,7 +88,10 @@ class BAKKESMOD_PLUGIN_IMPORT GameWrapper
 	Supported file formats: Whatever D3DXCreateTextureFromFile supports.
 	*/
 	void							LoadToastTexture(std::string name, std::string path);
-
+	void							LoadToastTexture(std::string name, std::wstring path);
+#ifdef __cpp_lib_filesystem
+	void							LoadToastTexture(std::string name, std::filesystem::path path);
+#endif
 	/*
 	Texture is the name of the texture given in LoadToastTexture, not the path! "default" will show the normal BakkesMod logo
 	*/
@@ -90,7 +102,9 @@ class BAKKESMOD_PLUGIN_IMPORT GameWrapper
 	std::string 					GetRandomMap();
 	std::string 					GetCurrentMap();
 	unsigned long long				GetSteamID();
-	class UnrealStringWrapper				GetPlayerName();
+	std::string						GetEpicID();
+	UniqueIDWrapper					GetUniqueID();
+	UnrealStringWrapper				GetPlayerName();
 	ClubDetailsWrapper				GetLocalClub();
 	SequenceWrapper					GetMainSequence();
 
@@ -100,6 +114,14 @@ class BAKKESMOD_PLUGIN_IMPORT GameWrapper
     unsigned int					GetbMetric();
     UnrealStringWrapper				GetUILanguage();
     bool							GetbColorBlind();
+	// Path utilities
+#ifdef __cpp_lib_filesystem
+	std::filesystem::path			GetBakkesModPath();
+	std::filesystem::path			GetDataFolder();
+	std::filesystem::path			FixRelativePath(std::filesystem::path path);
+#endif
+	std::wstring					GetBakkesModPathW();
+	std::wstring					GetDataFolderW();
 
 	template<typename T, typename std::enable_if<std::is_base_of<ObjectWrapper, T>::value>::type* = nullptr>
 	void							HookEventWithCaller(std::string eventName, std::function<void(T caller, void* params, std::string eventName)> callback);
@@ -123,4 +145,4 @@ extern template void BAKKESMOD_PLUGIN_IMPORT GameWrapper::HookEventWithCallerPos
 extern template void BAKKESMOD_PLUGIN_IMPORT GameWrapper::HookEventWithCallerPost<CarComponentWrapper>(std::string eventName, std::function<void(CarComponentWrapper caller, void* params, std::string eventName)> callback);
 extern template void BAKKESMOD_PLUGIN_IMPORT GameWrapper::HookEventWithCallerPost<PlayerControllerWrapper>(std::string eventName, std::function<void(PlayerControllerWrapper caller, void* params, std::string eventName)> callback);
 extern template void BAKKESMOD_PLUGIN_IMPORT GameWrapper::HookEventWithCallerPost<BallWrapper>(std::string eventName, std::function<void(BallWrapper caller, void* params, std::string eventName)> callback);
-#pragma warning(pop)
+#pragma warning(pop)

include/bakkesmod/wrappers/GuiManagerWrapper.h

@@ -1,8 +1,9 @@
 #pragma once
 #include "./Engine/ObjectWrapper.h"
 #include "wrapperstructs.h"
-#include "../imgui/imgui.h"
+//#include "../imgui/imgui.h"
 #include <tuple>
+
 class BAKKESMOD_PLUGIN_IMPORT GuiManagerWrapper : public ObjectWrapper
 {
 public:

include/bakkesmod/wrappers/MMRWrapper.h

@@ -1,18 +1,58 @@
 #pragma once
 #include "./Engine/ObjectWrapper.h"
 #include "wrapperstructs.h"
+#include "UniqueIDWrapper.h"
+
+class MMRWrapper;
+
+struct BAKKESMOD_PLUGIN_IMPORT MMRNotifierToken
+{
+	friend class MMRWrapper;
+	// The deconstructor deregisters your plugin for MMR notifications.
+	~MMRNotifierToken();
+	
+	// Copying would break the deconstruction logic. 
+	MMRNotifierToken(const MMRNotifierToken& other) = delete;
+	MMRNotifierToken& operator=(const MMRNotifierToken& other) = delete;
+	// Move is OK
+	MMRNotifierToken(MMRNotifierToken&& other) noexcept = default;
+	MMRNotifierToken& operator=(MMRNotifierToken&& other) noexcept = default;
+	
+
+private:
+	explicit MMRNotifierToken(unsigned long long t);
+	// Do we need pimpl here?
+	unsigned long long token;
+};
+
 class BAKKESMOD_PLUGIN_IMPORT MMRWrapper : public ObjectWrapper
 {
 public:
 	CONSTRUCTORS(MMRWrapper);
+	bool IsSyncing(UniqueIDWrapper playerID);
 	bool IsSyncing(SteamID playerID);
+	bool IsSynced(UniqueIDWrapper playerID, int playlistID);
 	bool IsSynced(SteamID playerID, int playlistID);
 	bool IsRanked(int playlistID);
+
+	SkillRating GetPlayerSkillRating(UniqueIDWrapper playerID, int playlistID);
+	SkillRank GetPlayerRank(UniqueIDWrapper playerID, int playlistID);
+	float GetPlayerMMR(UniqueIDWrapper playerID, int playlistID);
+
 	SkillRating GetPlayerSkillRating(SteamID playerID, int playlistID);
 	SkillRank GetPlayerRank(SteamID playerID, int playlistID);
 	float GetPlayerMMR(SteamID playerID, int playlistID);
 	float CalculateMMR(SkillRating sr, bool disregardPlacements);
 	int GetCurrentPlaylist();
+
+	/// <summary>
+	/// Subscribe to MMR updates. The callback will receive a ID wrapper for the player that the MMR update is relevant for.
+	/// </summary>
+	/// <param name="notification_callback">The callback that will be called for each mmr update</param>
+	/// <returns>a token whos lifetime controls your callback registration. When the token is destroyed, so is your registration. </returns>
+	std::unique_ptr<MMRNotifierToken> RegisterMMRNotifier(std::function<void(UniqueIDWrapper id)>);
+
+
 private:
 	PIMPL
 };

include/bakkesmod/wrappers/UniqueIDWrapper.h

@@ -0,0 +1,43 @@
+#pragma once
+#pragma warning(push)
+#pragma warning(disable:4661)
+#include "WrapperStructs.h"
+
+class BAKKESMOD_PLUGIN_IMPORT UniqueIDWrapper
+{
+public:
+	//Empty constructor so it can be declared in classes and we can have 0 values
+	UniqueIDWrapper();
+	UniqueIDWrapper(std::uintptr_t mem);
+	UniqueIDWrapper(const UniqueIDWrapper& other);
+	UniqueIDWrapper& operator=(UniqueIDWrapper rhs);
+	~UniqueIDWrapper();
+
+	OnlinePlatform GetPlatform() const;
+	std::string GetEpicAccountID() const;
+	unsigned long long GetUID() const;
+	unsigned char GetSplitscreenID() const;
+
+	/*
+	String representation of the ID.
+	Will be the EpicID if nonempty. Uid otherwise
+	*/
+	std::string str() const;
+public:
+	/*
+	Not 100% with the internals here, think it depends on what the game reads. 
+	For some functionality you might get away with just the epicAccountID, others might rely on UID & platform.
+	And some others you might even need both. 
+	AKA: it's best you just retrieve this wrapper from the game from existing players instead of using this function.
+	This wrapper is an exception to most other wrappers, as in: you're allowed to store this one! woohoo
+	*/
+	static UniqueIDWrapper FromEpicAccountID(std::string epicAccountID, unsigned long long uid, OnlinePlatform platform, unsigned char splitscreenID = 0);
+
+	bool operator <(const UniqueIDWrapper& rhs) const;
+	bool operator==(const UniqueIDWrapper& rhs) const;
+	bool operator!=(const UniqueIDWrapper& rhs) const;
+protected:
+	PIMPL
+};
+
+#pragma warning(pop)

include/bakkesmod/wrappers/arraywrapper.h

@@ -11,6 +11,7 @@
 #include "./GameObject/TeamWrapper.h"
 #include "./GameObject/GoalWrapper.h"
 #include "./GameObject/BoostPickupWrapper.h"
+
 class ActorWrapper;
 class CarWrapper;
 class BallWrapper;
@@ -27,6 +28,7 @@ class PlayerControllerWrapper;
 
 class SequenceWrapper;
 class SequenceObjectWrapper;
+class SequenceVariableWrapper;
 
 class ProductWrapper;
 class OnlineProductWrapper;
@@ -111,6 +113,7 @@ template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<PlayerControllerWrapper>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<wchar_t>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<SequenceWrapper>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<SequenceObjectWrapper>;
+template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<SequenceVariableWrapper>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<ProductWrapper>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<OnlineProductWrapper>;
 template class BAKKESMOD_PLUGIN_IMPORT ArrayWrapper<ProductAttributeWrapper>;

include/bakkesmod/wrappers/canvaswrapper.h

@@ -20,6 +20,7 @@ class BAKKESMOD_PLUGIN_IMPORT CanvasWrapper
 	void FillTriangle(Vector2F p1, Vector2F p2, Vector2F p3, LinearColor color);
 	void DrawString(std::string text);
 	void DrawString(std::string text, float xScale, float yScale);
+	void DrawString(std::string text, float xScale, float yScale, bool dropShadow, bool wrapText=false);
     Vector2F GetStringSize(std::string text, float xScale=1, float yScale=1);
 	void DrawLine(Vector2F start, Vector2F end);
 	void DrawLine(Vector2F start, Vector2F end, float width);

include/bakkesmod/wrappers/items/ItemsWrapper.h

@@ -35,9 +35,12 @@ class BAKKESMOD_PLUGIN_IMPORT ItemsWrapper : public ObjectWrapper
 	ItemsWrapper(const ItemsWrapper& other);
 	ItemsWrapper& operator=(ItemsWrapper rhs);
 	~ItemsWrapper();
+	bool IsNull();
 	ArrayWrapper<ProductWrapper> GetAllProducts();
 	ProductWrapper GetProduct(int productId);
+	[[deprecated("This will 99% for sure crash")]]
 	ArrayWrapper<OnlineProductWrapper> GetUnlockedProducts();
+	ArrayWrapper<ProductWrapper> GetCachedUnlockedProducts();
 	ArrayWrapper<OnlineProductWrapper> GetOwnedProducts();
 
 	CertifiedStatDatabaseWrapper GetCertifiedStatDB();