PlayerInfo
Summary
Members | Descriptions |
---|---|
class URH_PlayerInfoSubobject | Player Info Subobject base class used to store player data. |
class URH_PlayerPresence | Player Presence class used to store player presence data. |
class URH_PlayerSessions | Player Sessions class used to store player session membership information. |
class URH_PlayerMatches | Player Matches class used to store player match history information. |
class URH_PlayerReports | Player Reports class used to store and send player report information. |
class URH_PlayerPlatformInfo | Stores information a specific platform the player has linked to their account. |
class URH_PlayerInfo | Stores and fetchs all the information about a given player. |
class URH_PlayerInfoSubsystem | Subsystem used to track and request information about players. |
struct FRH_PlayerSettingKeySetWrapper | Wrapper to help with setting keys for player settings. |
struct FRH_PlayerAndPlatformInfo | Wrapper to pair a players Unique Player Id and their current logged in Platform Id. |
class URH_PlayerInfoSubobject
Player Info Subobject base class used to store player data.
Summary
Members | Descriptions |
---|---|
public bool bInitialized | Tracks if the subobject has been initialized (updated at least once). |
public FDateTime LastUpdated | The last time the players data was updated on the client. |
public FString ETag | ETag to track if the data is stale during requests. |
public FGuid PlayerUuid | Players unique identifier. |
public FRH_OnPlayerInfoSubobjectUpdatedMulticastDynamicDelegate BLUEPRINT_OnUpdatedDelegate | Blueprint delegate to listen for updates. |
public FRH_OnPlayerInfoSubobjectUpdatedMulticastDelegate OnUpdatedDelegate | Native delegate to listen for presence updates. |
public TArray< FRH_OnRequestPlayerInfoSubobjectDelegateBlock > TemporaryRequestDelegates | Delegates stored to response to currently active requests. |
public class URH_PlayerInfo * GetPlayerInfo () const | Gets the PlayerInfo that owns this Player Matches object. |
public inline virtual void MarkUpdated () | Sets the last updated time to now. |
public inline virtual void MarkDirty () | Clears the last updated time to force an update. |
public inline virtual void RequestUpdate (bool bForceUpdate,const FRH_OnRequestPlayerInfoSubobjectDelegateBlock & Delegate) | Enqueues an update request for the players information from the RallyHere API. |
public inline void BLUEPRINT_RequestUpdate (bool bForceUpdate,const FRH_OnRequestPlayerInfoSubobjectDynamicDelegate & Delegate) | |
public virtual void CheckPollStatus (const bool bForceUpdate) | Updates the poll status to be active or inactive based on if it should currently be polling. |
protected FRH_AutoPollerPtr Poller | Poller for the players matches. |
protected FName PollTimerName | The name of the timer preset to use for polling. |
protected int32 PollPriority | The priority of the poll request. |
protected inline virtual bool ShouldPoll () const | Gets if the poller should be actively polling, only polls if something cares about it. |
protected inline virtual void Poll (const FRH_PollCompleteFunc & Delegate) | Starts a poll of the object data. |
protected template<> inline void UpdateBase (const T & Other) | Stores the response data from an API presence request. |
protected inline virtual void PollComplete (bool bSuccess,const FRH_PollCompleteFunc & Delegate) | Starts a poll of the object data. |
protected virtual void ExecuteUpdatedDelegates (bool bSuccess) | Handles executing any delegate listeners for the update. |
Members
public bool
bInitialized
Tracks if the subobject has been initialized (updated at least once).
#### `public FDateTime `[`LastUpdated`](#classURH__PlayerInfoSubobject_1ae5d67bedce410bcc2f7ee5e6ac49cd92)
The last time the players data was updated on the client.
#### `public FString `[`ETag`](#classURH__PlayerInfoSubobject_1a43c6b83f587859abb61d71842801a64c)
ETag to track if the data is stale during requests.
#### `public FGuid `[`PlayerUuid`](#classURH__PlayerInfoSubobject_1ae2cc7f7dfc47525f2d6edaf01b04403f)
Players unique identifier.
#### `public FRH_OnPlayerInfoSubobjectUpdatedMulticastDynamicDelegate `[`BLUEPRINT_OnUpdatedDelegate`](#classURH__PlayerInfoSubobject_1acd235146d3e5d44c3deeee04a658bee6)
Blueprint delegate to listen for updates.
#### `public FRH_OnPlayerInfoSubobjectUpdatedMulticastDelegate `[`OnUpdatedDelegate`](#classURH__PlayerInfoSubobject_1a79fe3beb1968bb4fec503603aab7c7c5)
Native delegate to listen for presence updates.
#### `public TArray< FRH_OnRequestPlayerInfoSubobjectDelegateBlock > `[`TemporaryRequestDelegates`](#classURH__PlayerInfoSubobject_1a5968c4b094b525f7e54adc02b11a35bf)
Delegates stored to response to currently active requests.
#### `public class `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * `[`GetPlayerInfo`](#classURH__PlayerInfoSubobject_1aa4e6fb9d2cdcfd4690022db8ea155e0e)`() const`
Gets the PlayerInfo that owns this Player Matches object.
Returns
The PlayerInfo that owns the Player Matches object.
#### `public inline virtual void `[`MarkUpdated`](#classURH__PlayerInfoSubobject_1a23487defc38d317099f23d9b68086f03)`()`
Sets the last updated time to now.
#### `public inline virtual void `[`MarkDirty`](#classURH__PlayerInfoSubobject_1ae49b2a6e09b8159f32f1ccedc27c3dcc)`()`
Clears the last updated time to force an update.
#### `public inline virtual void `[`RequestUpdate`](#classURH__PlayerInfoSubobject_1aab35a732de0ee7a292776887fae18190)`(bool bForceUpdate,const FRH_OnRequestPlayerInfoSubobjectDelegateBlock & Delegate)`
Enqueues an update request for the players information from the RallyHere API.
Parameters
-
bForceUpdate
If true, immediately requests an update rather than waiting for the next poll time. WARNING: Use this sparingly -
Delegate
Callback delegate for the request.
#### `public inline void `[`BLUEPRINT_RequestUpdate`](#classURH__PlayerInfoSubobject_1ad60fb784f621475df3a543126b379209)`(bool bForceUpdate,const FRH_OnRequestPlayerInfoSubobjectDynamicDelegate & Delegate)`
#### `public virtual void `[`CheckPollStatus`](#classURH__PlayerInfoSubobject_1a2e46e4cf8c81cee9eeafac9d8dcdee36)`(const bool bForceUpdate)`
Updates the poll status to be active or inactive based on if it should currently be polling.
Parameters
bForceUpdate
If true, immediately requests an update rather than waiting for the next poll time. WARNING: Use this sparingly
#### `protected FRH_AutoPollerPtr `[`Poller`](#classURH__PlayerInfoSubobject_1a9abab6c88fabe22a23835813a56bffbd)
Poller for the players matches.
#### `protected FName `[`PollTimerName`](#classURH__PlayerInfoSubobject_1a697ccd6d2e132cd4ac05fcc31e64272f)
The name of the timer preset to use for polling.
#### `protected int32 `[`PollPriority`](#classURH__PlayerInfoSubobject_1aa0795fa3b53d3842dc358564abed8f5d)
The priority of the poll request.
#### `protected inline virtual bool `[`ShouldPoll`](#classURH__PlayerInfoSubobject_1aa73d16e9e42fd18afd95db6723ead346)`() const`
Gets if the poller should be actively polling, only polls if something cares about it.
#### `protected inline virtual void `[`Poll`](#classURH__PlayerInfoSubobject_1aa6bc5fb282ea6eb162c44106b89d1fc5)`(const FRH_PollCompleteFunc & Delegate)`
Starts a poll of the object data.
Parameters
Delegate
Callback delegate for the poll.
#### `protected template<>`
`inline void `[`UpdateBase`](#classURH__PlayerInfoSubobject_1a9256fdd7baceb430ba944ce641646273)`(const T & Other)`
Stores the response data from an API presence request.
Parameters
Other
The presence data to store.
#### `protected inline virtual void `[`PollComplete`](#classURH__PlayerInfoSubobject_1a25950945c3f6bfd0122858aa944a2bac)`(bool bSuccess,const FRH_PollCompleteFunc & Delegate)`
Starts a poll of the object data.
Parameters
Delegate
Callback delegate for the poll.
#### `protected virtual void `[`ExecuteUpdatedDelegates`](#classURH__PlayerInfoSubobject_1a38d53acfed235ac77964549ec780a2d4)`(bool bSuccess)`
Handles executing any delegate listeners for the update.
Parameters
bSuccess
If the poll was successful.
## class `URH_PlayerPresence`
Player Presence class used to store player presence data.
Summary
Members | Descriptions |
---|---|
public ERHAPI_OnlineStatus Status | Online status of the player. |
public FString Message | Message set by a player to display on their presence information. |
public FString Platform | Which platform the player is currently playing / last seen on. |
public FString DisplayName | The players display name for their current or last seen platform. |
public TMap< FString, FString > CustomData | Custom data that can be set by the player. |
protected virtual void Poll (const FRH_PollCompleteFunc & Delegate) | Starts a poll of the players presence. |
protected inline virtual void Update (const GetPresenceType::Response & Other) | Stores the response data from an API presence request. |
typedef GetPresenceType |
Members
public ERHAPI_OnlineStatus
Status
Online status of the player.
#### `public FString `[`Message`](#classURH__PlayerPresence_1abd625e3be04fcb0527bbc719dc929d6e)
Message set by a player to display on their presence information.
#### `public FString `[`Platform`](#classURH__PlayerPresence_1ad461b02f3065a8e712a127e954fb9e36)
Which platform the player is currently playing / last seen on.
#### `public FString `[`DisplayName`](#classURH__PlayerPresence_1a93fef7276ca2b984c0d2e66ca3dc3852)
The players display name for their current or last seen platform.
#### `public TMap< FString, FString > `[`CustomData`](#classURH__PlayerPresence_1abbc5a206683a5117cc6c3aa200e137c8)
Custom data that can be set by the player.
#### `protected virtual void `[`Poll`](#classURH__PlayerPresence_1adf598cc475db7d98b03df67879097808)`(const FRH_PollCompleteFunc & Delegate)`
Starts a poll of the players presence.
Parameters
Delegate
Callback delegate for the poll.
#### `protected inline virtual void `[`Update`](#classURH__PlayerPresence_1aa6ef217e8b96b79fa309824e8bd73520)`(const GetPresenceType::Response & Other)`
Stores the response data from an API presence request.
Parameters
Other
The presence data to store.
#### `typedef `[`GetPresenceType`](#classURH__PlayerPresence_1a08e8229618b324bafea2d8195b6b9214)
## class `URH_PlayerSessions`
Player Sessions class used to store player session membership information.
Summary
Members | Descriptions |
---|---|
public FRHAPI_PlayerSessions Sessions | The sessions the player is a member of. |
protected virtual void Poll (const FRH_PollCompleteFunc & Delegate) | Starts a poll of the players sessions. |
protected inline virtual void Update (const GetSessionsType::Response & Other) | Stores the response data from an API request. |
typedef GetSessionsType |
Members
public
FRHAPI_PlayerSessions
Sessions
The sessions the player is a member of.
#### `protected virtual void `[`Poll`](#classURH__PlayerSessions_1a7adb05ae630f0bffb316507c08749a95)`(const FRH_PollCompleteFunc & Delegate)`
Starts a poll of the players sessions.
Parameters
Delegate
Callback delegate for the poll.
#### `protected inline virtual void `[`Update`](#classURH__PlayerSessions_1aec7d221dfaac8ca3386fc25280a9817e)`(const GetSessionsType::Response & Other)`
Stores the response data from an API request.
Parameters
Other
The response data to store.
#### `typedef `[`GetSessionsType`](#classURH__PlayerSessions_1afa8a5657954ca5d686f07cea03b23b92)
## class `URH_PlayerMatches`
Player Matches class used to store player match history information.
Summary
Members | Descriptions |
---|---|
public int32 PollPageSize | The size of the pages to poll, if 0, uses default. |
public int32 PollMaxPageCount | Polling of new pages is stopped after this value is reached, if 0, polls until all pages are polled. |
public FTimespan PollMaxAge | The maximum age after which to stop polling new pages, if 0, polls until max count is reached. |
public TMap< FString, FRHAPI_MatchPlayerWithMatch > Matches | The matches the player has participated in. |
protected virtual void Poll (const FRH_PollCompleteFunc & Delegate) | Starts a poll of the object data. |
protected virtual void PollNextPage (const FRH_PollCompleteFunc & Delegate,TSharedPtr< FPollContext > Context) | Starts a poll of the object data. |
protected inline virtual void Update (const GetMatchesType::Response & Other,TSharedPtr< FPollContext > Context) | Stores the response data from an API presence request. |
typedef GetMatchesType |
Members
public int32
PollPageSize
The size of the pages to poll, if 0, uses default.
#### `public int32 `[`PollMaxPageCount`](#classURH__PlayerMatches_1ab61d485e5d851ff8fea078e331c9c7b8)
Polling of new pages is stopped after this value is reached, if 0, polls until all pages are polled.
#### `public FTimespan `[`PollMaxAge`](#classURH__PlayerMatches_1ae4bebdc4d6137fb5585f4310b1d7c4e7)
The maximum age after which to stop polling new pages, if 0, polls until max count is reached.
#### `public TMap< FString, `[`FRHAPI_MatchPlayerWithMatch`](models/RHAPI_MatchPlayerWithMatch.md#structFRHAPI__MatchPlayerWithMatch)` > `[`Matches`](#classURH__PlayerMatches_1aca9fc68c9d093c1a90bce75d0f9832ea)
The matches the player has participated in.
#### `protected virtual void `[`Poll`](#classURH__PlayerMatches_1a40b839311638c5097b6bc1f74b3156d3)`(const FRH_PollCompleteFunc & Delegate)`
Starts a poll of the object data.
Parameters
Delegate
Callback delegate for the poll.
#### `protected virtual void `[`PollNextPage`](#classURH__PlayerMatches_1a2ca5a0cec9f116fd4469fb3a2a387e11)`(const FRH_PollCompleteFunc & Delegate,TSharedPtr< `[`FPollContext`](undefined.md#structURH__PlayerMatches_1_1FPollContext)` > Context)`
Starts a poll of the object data.
Parameters
-
Delegate
Callback delegate for the poll. -
Context
The context to use for the poll.
#### `protected inline virtual void `[`Update`](#classURH__PlayerMatches_1a2d718f1945307bc4570e9b6fc1a10a27)`(const GetMatchesType::Response & Other,TSharedPtr< `[`FPollContext`](undefined.md#structURH__PlayerMatches_1_1FPollContext)` > Context)`
Stores the response data from an API presence request.
Parameters
-
Other
The match data to store. -
Context
The context to use for the poll.
#### `typedef `[`GetMatchesType`](#classURH__PlayerMatches_1a13c41a6b6f28555aa13c6536c706c8b9)
## class `URH_PlayerReports`
Player Reports class used to store and send player report information.
Summary
Members | Descriptions |
---|---|
public virtual void GetReportsSentAsync (const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsBlock & Delegate) | Request a list of player reports send by this player. |
public inline void BLUEPRINT_GetReportsSentAsync (const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsDynamicDelegate & Delegate) | Request a list of player reports send by this player. |
public inline TArray< FRHAPI_PlayerReport > GetReportsSent () const | Get the current cached list of player reports sent by this player. |
public virtual void GetReportsReceivedAsync (const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsBlock & Delegate) | Request a list of player reports received by this player. |
public inline void BLUEPRINT_GetReportsReceivedAsync (const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsDynamicDelegate & Delegate) | Request a list of player reports received by this player. |
public inline virtual TArray< FRHAPI_PlayerReport > GetReportsReceived () const | Get the current cached list of player reports received by this player. |
public virtual void CreateReport (const FRHAPI_PlayerReportCreate & Report,const FRH_PlayerInfoCreatePlayerReportBlock & Delegate) | Create a new report for the target player. |
public inline void BLUEPRINT_CreateReport (const FRHAPI_PlayerReportCreate & Report,const FRH_PlayerInfoCreatePlayerReportDynamicDelegate & Delegate) | Create a new report for the target player. |
public virtual void CreateReport (const FRHAPI_PlayerReportCreate & Report,FAuthContextPtr AuthContext,const FRH_PlayerInfoCreatePlayerReportBlock & Delegate) | Create a new report for the target player with a specific auth context. |
protected TArray< FRHAPI_PlayerReport > ReportsSent | |
protected TArray< FRHAPI_PlayerReport > ReportsReceived | |
typedef GetReportsSentType | |
typedef GetReportsReceivedType | |
typedef CreateReportType |
Members
public virtual void
GetReportsSentAsync
(const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsBlock & Delegate)
Request a list of player reports send by this player.
Parameters
-
Cursor
The cursor to use for the request. -
PageSize
The size of the pages to poll, if 0, uses default -
Delegate
Callback delegate for the request.
#### `public inline void `[`BLUEPRINT_GetReportsSentAsync`](#classURH__PlayerReports_1abc1c0b9e9fb18c326cffcd0c21030078)`(const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsDynamicDelegate & Delegate)`
Request a list of player reports send by this player.
Parameters
-
Cursor
The cursor to use for the request. -
PageSize
The size of the pages to poll, if 0, uses default -
Delegate
Callback delegate for the request.
#### `public inline TArray< `[`FRHAPI_PlayerReport`](models/RHAPI_PlayerReport.md#structFRHAPI__PlayerReport)` > `[`GetReportsSent`](#classURH__PlayerReports_1a143d1f8a21fec0136747bd53bfe85750)`() const`
Get the current cached list of player reports sent by this player.
#### `public virtual void `[`GetReportsReceivedAsync`](#classURH__PlayerReports_1ace60d12bc864d0546372df009c41f5f2)`(const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsBlock & Delegate)`
Request a list of player reports received by this player.
Parameters
-
Cursor
The cursor to use for the request. -
PageSize
The size of the pages to poll, if 0, uses default -
Delegate
Callback delegate for the request.
#### `public inline void `[`BLUEPRINT_GetReportsReceivedAsync`](#classURH__PlayerReports_1af22eebdd08e50bf32cb51c42712d42bd)`(const FString & Cursor,const int32 PageSize,const FRH_PlayerInfoGetPlayerReportsDynamicDelegate & Delegate)`
Request a list of player reports received by this player.
Parameters
-
Cursor
The cursor to use for the request. -
PageSize
The size of the pages to poll, if 0, uses default -
Delegate
Callback delegate for the request.
#### `public inline virtual TArray< `[`FRHAPI_PlayerReport`](models/RHAPI_PlayerReport.md#structFRHAPI__PlayerReport)` > `[`GetReportsReceived`](#classURH__PlayerReports_1a34372b78a48405bac1101576e9aaa256)`() const`
Get the current cached list of player reports received by this player.
#### `public virtual void `[`CreateReport`](#classURH__PlayerReports_1a3a7db86764cfd8c2a83be10dd5d9d157)`(const `[`FRHAPI_PlayerReportCreate`](models/RHAPI_PlayerReportCreate.md#structFRHAPI__PlayerReportCreate)` & Report,const FRH_PlayerInfoCreatePlayerReportBlock & Delegate)`
Create a new report for the target player.
Parameters
-
Report
The report to create. -
Delegate
Callback delegate for the request.
#### `public inline void `[`BLUEPRINT_CreateReport`](#classURH__PlayerReports_1a6ed2cfcfa311ed6eaed59db909566e15)`(const `[`FRHAPI_PlayerReportCreate`](models/RHAPI_PlayerReportCreate.md#structFRHAPI__PlayerReportCreate)` & Report,const FRH_PlayerInfoCreatePlayerReportDynamicDelegate & Delegate)`
Create a new report for the target player.
Parameters
-
Report
The report to create. -
Delegate
Callback delegate for the request.
#### `public virtual void `[`CreateReport`](#classURH__PlayerReports_1a33a8bdc35ba9d092820b6796dc9763bf)`(const `[`FRHAPI_PlayerReportCreate`](models/RHAPI_PlayerReportCreate.md#structFRHAPI__PlayerReportCreate)` & Report,FAuthContextPtr AuthContext,const FRH_PlayerInfoCreatePlayerReportBlock & Delegate)`
Create a new report for the target player with a specific auth context.
Parameters
-
Report
The report to create. -
AuthContext
The auth context to use for the request. -
Delegate
Callback delegate for the request.
#### `protected TArray< `[`FRHAPI_PlayerReport`](models/RHAPI_PlayerReport.md#structFRHAPI__PlayerReport)` > `[`ReportsSent`](#classURH__PlayerReports_1afa610002ff1c15ed7e6dfdfce53b2263)
#### `protected TArray< `[`FRHAPI_PlayerReport`](models/RHAPI_PlayerReport.md#structFRHAPI__PlayerReport)` > `[`ReportsReceived`](#classURH__PlayerReports_1a3f561b683fa7026383b75e5494ca6959)
#### `typedef `[`GetReportsSentType`](#classURH__PlayerReports_1a66e9b68dfeb75fe986b3f615385e80a7)
#### `typedef `[`GetReportsReceivedType`](#classURH__PlayerReports_1a2bebbdb949cccf80084b2e5b3cb99951)
#### `typedef `[`CreateReportType`](#classURH__PlayerReports_1a6b101fa42b9857a05a752b07cade837d)
## class `URH_PlayerPlatformInfo`
Stores information a specific platform the player has linked to their account.
Summary
Members | Descriptions |
---|---|
public FRH_PlayerPlatformId PlayerPlatformId | Players Platform ID struct. |
public FString DisplayName | Last seen display name for the player on the platform. |
public inline virtual FRH_PlayerPlatformId GetPlayerPlatformId () const | Gets the Platform Id struct for the player. |
public inline virtual FString GetPlatformUserId () const | Gets the Platform Id for the player. |
public inline virtual ERHAPI_Platform GetPlatform () const | Gets the Platform Type for the player. |
public inline virtual FString GetLastKnownDisplayName () const | Gets the display name stored the last time this player logged in to the Rally Here server. |
Members
public
FRH_PlayerPlatformId
PlayerPlatformId
Players Platform ID struct.
#### `public FString `[`DisplayName`](#classURH__PlayerPlatformInfo_1a056f2023dd209b4807ac14a699cd594e)
Last seen display name for the player on the platform.
#### `public inline virtual `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` `[`GetPlayerPlatformId`](#classURH__PlayerPlatformInfo_1a521e63d00404a311a21c224d73001b0b)`() const`
Gets the Platform Id struct for the player.
Returns
The players Platform Id struct.
#### `public inline virtual FString `[`GetPlatformUserId`](#classURH__PlayerPlatformInfo_1aef5dad4953cf0c0edfb30119e6724bd9)`() const`
Gets the Platform Id for the player.
Returns
The players Platform Unique Id.
#### `public inline virtual ERHAPI_Platform `[`GetPlatform`](#classURH__PlayerPlatformInfo_1ae004f09524c3e8be17dedc18ab220e51)`() const`
Gets the Platform Type for the player.
Returns
The players Platform Type.
#### `public inline virtual FString `[`GetLastKnownDisplayName`](#classURH__PlayerPlatformInfo_1a285f132c06d72cdb4876115765de9af2)`() const`
Gets the display name stored the last time this player logged in to the Rally Here server.
Returns
The players display name for the platform.
## class `URH_PlayerInfo`
Stores and fetchs all the information about a given player.
Summary
Members | Descriptions |
---|---|
public inline FORCEINLINE FGuid & GetRHPlayerUuid () | Gets the players Unique player Id. |
public inline FORCEINLINE URH_PlayerPresence * GetPresence () const | Gets The players presence class. |
public inline FORCEINLINE URH_PlayerSessions * GetSessions () const | Gets The players sessions class. |
public inline FORCEINLINE URH_PlayerMatches * GetMatches () const | Gets The players matches class. |
public inline FORCEINLINE URH_PlayerReports * GetReports () const | Gets The players reports class. |
public inline virtual TArray< FRH_PlayerPlatformId > & GetPlayerPlatformIds () | Gets the associated platform ids of the player. |
public inline virtual const TArray< FRH_PlayerPlatformId > & GetPlayerPlatformIds () const | Gets the associated platform ids of the player. |
public virtual TArray< URH_PlayerPlatformInfo * > GetPlayerPlatforms () const | Gets the associated platforms of the player. |
public virtual URH_PlayerPlatformInfo * GetPlayerPlatformInfo (const FRH_PlayerPlatformId & PlayerPlatformId) const | Gets a specific platform for the player. |
public inline URH_PlayerInventory * GetPlayerInventory () const | Gets the players Inventory Subsystem. |
public inline URH_PlayerNotifications * GetPlayerNotifications () const | Gets the players Notification Subsystem. |
public virtual void StartStreamingNotifications () | Request to start streaming notifications for this player. |
public virtual void StopStreamingNotifications (bool bClearCache) | Requests to stop streaming notifications. |
public inline virtual const TMap< FString, FRH_PlayerSettingsDataWrapper > & GetAllStoredPlayerSettings () const | Gets all the players store settings data. |
public inline virtual const TMap< FString, FRHAPI_PlayerRankResponseV2 > & GetAllStoredPlayerRankings () const | Gets all the players stored ranking data. |
public virtual URH_PlayerInfoSubsystem * GetPlayerInfoSubsystem () const | Gets the players Info Subsystem that the Player Info is on. |
public virtual void InitializeForPlayer (const FGuid & PlayerUuid) | Initialized the player info from a given Player Unique Id. |
public virtual void GetLastKnownDisplayNameAsync (const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock & Delegate,const class URH_LocalPlayerSubsystem * LocalPlayerSubsystem) | Gets the last known display name for the player, will make required API calls to retrieve the information if needed. |
public inline void BLUEPRINT_GetLastKnownDisplayNameAsync (const class URH_LocalPlayerSubsystem * LocalPlayerSubsystem,const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameDynamicDelegate & Delegate) | |
public virtual bool GetLastKnownDisplayName (FString & OutDisplayName,ERHAPI_Platform PreferredPlatformType) const | Gets the last known display name for the player. |
public inline bool BLUEPRINT_GetLastKnownDisplayName (ERHAPI_Platform PreferredPlatformType,FString & OutDisplayName) const | |
public virtual void GetLinkedPlatformInfo (const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlatformsBlock & Delegate) | Gets the players linked platforms via API call. |
public inline void BLUEPRINT_GetLinkedPlatformInfo (const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlatformsDynamicDelegate & Delegate) | |
public virtual void GetPlayerSettings (const FString & SettingTypeId,const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerSettingsBlock & Delegate) | Gets the players settings information for a given type. |
public inline void BLUEPRINT_GetPlayerSettings (const FString & SettingTypeId,const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerSettingsDynamicDelegate & Delegate) | |
public virtual void SetPlayerSettings (const FString & SettingTypeId, FRH_PlayerSettingsDataWrapper & SettingsData,const FRH_PlayerInfoSetPlayerSettingsBlock & Delegate) | Sets the players settings information for a given type. |
public inline void BLUEPRINT_SetPlayerSettings (const FString & SettingTypeId, FRH_PlayerSettingsDataWrapper SettingsData,const FRH_PlayerInfoSetPlayerSettingsDynamicDelegate & Delegate) | |
public virtual void GetPlayerRankings (const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerRankingsBlock & Delegate) | Gets the players ranking information for a given type. |
public inline void BLUEPRINT_GetPlayerRankings (const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerRankingsDynamicDelegate & Delegate) | |
public virtual void UpdatePlayerRanking (const FString & RankId,const FRHAPI_PlayerRankUpdateRequest & RankData,const FRH_PlayerInfoGetPlayerRankingsBlock & Delegate) | Sets the players settings information for a given type. |
public inline void BLUEPRINT_UpdatePlayerRanking (const FString & RankId,const FRHAPI_PlayerRankUpdateRequest & RankData,const FRH_PlayerInfoGetPlayerRankingsDynamicDelegate & Delegate) | |
public FAuthContextPtr GetAuthContext () const | Gets the local Auth Context for making API calls. |
public virtual ERHAPI_Platform GetLoggedInPlatform () const | Gets the local users logged in platform type. |
protected FGuid RHPlayerUuid | The Unique Player Id for the player. |
protected TMap< FString, FRH_PlayerSettingsDataWrapper > PlayerSettingsByTypeId | Cache of Player Settings Data by their settings types. |
protected TMap< FString, FRH_PlayerSettingKeySetWrapper > PendingSettingRequestsByTypeId | When requesting multiple Player Settings Updates at once, this keeps track of pending requests so we know when all requests are completed. |
protected TMap< FString, FRH_PlayerSettingsDataWrapper > SetPlayerSettingResponses | Used when requesting multiple Player Settings Updates to track all their responses. |
protected TArray< FRH_PlayerPlatformId > LinkedPlayerPlatforms | Cache of all platforms the player is linked to. |
protected URH_PlayerPresence * PlayerPresence | The players Presence Information. |
protected URH_PlayerSessions * PlayerSessions | The players Sessions Information. |
protected URH_PlayerMatches * PlayerMatches | The players Matches Information. |
protected URH_PlayerReports * PlayerReports | The players Reports Information. |
protected URH_PlayerInventory * PlayerInventory | The Players Inventory Subsystem. |
protected URH_PlayerNotifications * PlayerNotifications | The Players Inventory Subsystem. |
protected TMap< FString, FRHAPI_PlayerRankResponseV2 > PlayerRankingsByRankingId | List of the player’s rankings. |
protected FDateTime LastRequestPlatforms | Tracks the last time the players linked platforms were requested for checking if the data is stale. |
protected TMap< FString, FDateTime > LastRequestSettingsByTypeId | Tracks the last time each settings type was request for checking if the data is stale. |
protected FDateTime LastRequestRankings | Tracks the last time the player rankings were requested for checking if the data is stale. |
protected virtual void OnGetPlayerLinkedPlatformsForLastKnownDisplayNameResponse (bool bSuccess,const TArray< URH_PlayerPlatformInfo * > & Platforms,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate,const class URH_LocalPlayerSubsystem * LocalPlayerSubsystem) | Handles the response to a Get Linked Platforms For Last Known Display Name call. |
protected virtual void OnDisplayNameSanitized (bool bSuccess,const FString & SanitizedMessage,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate) | Handles the response to sanitizing the players display name. |
protected virtual void OnGetPlayerLinkedPlatformsResponse (const GetPlatforms::Response & Response,const FRH_PlayerInfoGetPlatformsBlock Delegate) | Handles the response to a Get Linked Platforms call. |
protected virtual void OnGetPlayerSettingsResponse (const GetSettings::Response & Response,const FRH_PlayerInfoGetPlayerSettingsBlock Delegate,const FString SettingTypeId) | Handles the response to a Get Player Settings call. |
protected virtual void OnSetPlayerSettingsResponse (const SetSettings::Response & Response,const FRH_PlayerInfoSetPlayerSettingsBlock Delegate,const FString SettingTypeId,const FString SettingKey, FRH_PlayerSettingsDataWrapper SettingsData) | Handles the response to a Set Player Settings call. |
protected virtual void OnGetPlayerRankingsResponse (const GetRankings::Response & Response,const FRH_PlayerInfoGetPlayerRankingsBlock Delegate) | Handles the response to a Get Player Rankings call. |
protected virtual void OnUpdatePlayerRankingResponse (const UpdateRanking::Response & Response,const FRH_PlayerInfoGetPlayerRankingsBlock Delegate) | Handles the response to a Update Player Ranking call. |
typedef GetPlatforms | |
typedef GetSettings | |
typedef SetSettings | |
typedef GetRankings | |
typedef UpdateRanking |
Members
public inline FORCEINLINE FGuid &
GetRHPlayerUuid
()
Gets the players Unique player Id.
Returns
The players Unique Player Id.
#### `public inline FORCEINLINE `[`URH_PlayerPresence`](PlayerInfo.md#classURH__PlayerPresence)` * `[`GetPresence`](#classURH__PlayerInfo_1a30440b0a7ab410262e696bc6ac976568)`() const`
Gets The players presence class.
Returns
The players presence class.
#### `public inline FORCEINLINE `[`URH_PlayerSessions`](PlayerInfo.md#classURH__PlayerSessions)` * `[`GetSessions`](#classURH__PlayerInfo_1a3a012da0a55d1edb09a80dcf658ae7f4)`() const`
Gets The players sessions class.
Returns
The players sessions class.
#### `public inline FORCEINLINE `[`URH_PlayerMatches`](PlayerInfo.md#classURH__PlayerMatches)` * `[`GetMatches`](#classURH__PlayerInfo_1a18162aabb6b78affb52f918ae8517f84)`() const`
Gets The players matches class.
Returns
The players matches class.
#### `public inline FORCEINLINE `[`URH_PlayerReports`](PlayerInfo.md#classURH__PlayerReports)` * `[`GetReports`](#classURH__PlayerInfo_1a384f5b99113927ed0f47cf1278e45018)`() const`
Gets The players reports class.
Returns
The players reports class.
#### `public inline virtual TArray< `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` > & `[`GetPlayerPlatformIds`](#classURH__PlayerInfo_1a07f7aedb216f1536718b152d384d7ba9)`()`
Gets the associated platform ids of the player.
Returns
The players associated platforms ids.
#### `public inline virtual const TArray< `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` > & `[`GetPlayerPlatformIds`](#classURH__PlayerInfo_1a28f6726b50d19d49895f5ef07a080625)`() const`
Gets the associated platform ids of the player.
Returns
The players associated platforms ids.
#### `public virtual TArray< `[`URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * > `[`GetPlayerPlatforms`](#classURH__PlayerInfo_1a809c05d3726b297a8c9c1a5647e1b312)`() const`
Gets the associated platforms of the player.
Returns
The players associated platforms.
#### `public virtual `[`URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * `[`GetPlayerPlatformInfo`](#classURH__PlayerInfo_1a739b91e94755670e614506e17ee468d8)`(const `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` & PlayerPlatformId) const`
Gets a specific platform for the player.
Parameters
PlayerPlatformId
The Id of the platform being requested.
Returns
The platform requested for the player if it exists.
#### `public inline `[`URH_PlayerInventory`](Inventory.md#classURH__PlayerInventory)` * `[`GetPlayerInventory`](#classURH__PlayerInfo_1a430d123219813a6ba0c8100b367df6ec)`() const`
Gets the players Inventory Subsystem.
Returns
The players Inventory Subsystem.
#### `public inline `[`URH_PlayerNotifications`](Notifications.md#classURH__PlayerNotifications)` * `[`GetPlayerNotifications`](#classURH__PlayerInfo_1a6f1e1f6ef4d38ed87c2c2b920a5cd891)`() const`
Gets the players Notification Subsystem.
Returns
The players Notification Subsystem.
#### `public virtual void `[`StartStreamingNotifications`](#classURH__PlayerInfo_1af0c9066d3c0b17440adfaf7e6b9cca9f)`()`
Request to start streaming notifications for this player.
#### `public virtual void `[`StopStreamingNotifications`](#classURH__PlayerInfo_1a030ec9d94254cb742700d1c3947412dd)`(bool bClearCache)`
Requests to stop streaming notifications.
Parameters
[in[
bClearCache If true, the cache of notifications will be cleared.
#### `public inline virtual const TMap< FString, `[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` > & `[`GetAllStoredPlayerSettings`](#classURH__PlayerInfo_1a3eeb21bd2ebc5e074abc0de97d35ce9e)`() const`
Gets all the players store settings data.
Returns
The players stored settings data.
#### `public inline virtual const TMap< FString, `[`FRHAPI_PlayerRankResponseV2`](models/RHAPI_PlayerRankResponseV2.md#structFRHAPI__PlayerRankResponseV2)` > & `[`GetAllStoredPlayerRankings`](#classURH__PlayerInfo_1a2727915e9be4638dbd49310a6938645c)`() const`
Gets all the players stored ranking data.
Returns
The players stored settings data.
#### `public virtual `[`URH_PlayerInfoSubsystem`](PlayerInfo.md#classURH__PlayerInfoSubsystem)` * `[`GetPlayerInfoSubsystem`](#classURH__PlayerInfo_1a79f8f54e2bbda560cb138f54efbfd0ac)`() const`
Gets the players Info Subsystem that the Player Info is on.
Returns
The Player Info Subsystem.
#### `public virtual void `[`InitializeForPlayer`](#classURH__PlayerInfo_1a95e3c7c6762abe6c801e98e708905d39)`(const FGuid & PlayerUuid)`
Initialized the player info from a given Player Unique Id.
Parameters
PlayerUuid
The Unique Id of the player.
#### `public virtual void `[`GetLastKnownDisplayNameAsync`](#classURH__PlayerInfo_1a2294e1b29debae35974c1776ef703cfd)`(const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock & Delegate,const class `[`URH_LocalPlayerSubsystem`](LocalPlayer.md#classURH__LocalPlayerSubsystem)` * LocalPlayerSubsystem)`
Gets the last known display name for the player, will make required API calls to retrieve the information if needed.
Parameters
-
LocalPlayerSubsystem
The Local Player Subsystem to sanitizing player names. -
StaleThreshold
If set, will force a re-request of the players information if the last updated time was more than the threshold. -
bForceRefresh
If true, will force a re-request of the players information. -
PreferredPlatformType
If set, then that specific platforms display name will be returned if possible, otherwise will use your local platforms, otherwise the first platform found for the player. -
Delegate
Callback with the players display name.
#### `public inline void `[`BLUEPRINT_GetLastKnownDisplayNameAsync`](#classURH__PlayerInfo_1a2a5f9d31fb4c1096e06d68569d617257)`(const class `[`URH_LocalPlayerSubsystem`](LocalPlayer.md#classURH__LocalPlayerSubsystem)` * LocalPlayerSubsystem,const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameDynamicDelegate & Delegate)`
#### `public virtual bool `[`GetLastKnownDisplayName`](#classURH__PlayerInfo_1ac983a0c5b8e6e3df2f216b94b7fd249c)`(FString & OutDisplayName,ERHAPI_Platform PreferredPlatformType) const`
Gets the last known display name for the player.
Parameters
-
PreferredPlatformType
If set, then that specific platforms display name will be returned if possible, otherwise will use your local platforms, otherwise the first platform found for the player. -
OutDisplayName
The player’s display name.
Returns
If the call successfully found a display name for the player already stored on the client.
#### `public inline bool `[`BLUEPRINT_GetLastKnownDisplayName`](#classURH__PlayerInfo_1a4b096747849fe22e2c7934fb3212bb85)`(ERHAPI_Platform PreferredPlatformType,FString & OutDisplayName) const`
#### `public virtual void `[`GetLinkedPlatformInfo`](#classURH__PlayerInfo_1a3cdeb290b652d16aa44e5c6e1e4ae44c)`(const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlatformsBlock & Delegate)`
Gets the players linked platforms via API call.
Parameters
-
StaleThreshold
If set, will force a re-request of the players information if the last updated time was more than the threshold. -
bForceRefresh
If true, will force a re-request of the players information. -
Delegate
Callback with the players linked platforms.
#### `public inline void `[`BLUEPRINT_GetLinkedPlatformInfo`](#classURH__PlayerInfo_1a17dd835ef46a8418e6cf760eb076d01d)`(const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlatformsDynamicDelegate & Delegate)`
#### `public virtual void `[`GetPlayerSettings`](#classURH__PlayerInfo_1a6f0c823fb1c55bcf4ab2482092cfad2a)`(const FString & SettingTypeId,const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerSettingsBlock & Delegate)`
Gets the players settings information for a given type.
Parameters
-
SettingTypeId
The setting type requested. -
StaleThreshold
If set, will force a re-request of the players information if the last updated time was more than the threshold. -
bForceRefresh
If true, will force a re-request of the players information. -
Delegate
Callback with the players settings for the given type.
#### `public inline void `[`BLUEPRINT_GetPlayerSettings`](#classURH__PlayerInfo_1a76e2f0a5ded932bc524553a9a2d43976)`(const FString & SettingTypeId,const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerSettingsDynamicDelegate & Delegate)`
#### `public virtual void `[`SetPlayerSettings`](#classURH__PlayerInfo_1ab8f4ba97458cb8df50445db8547bbc4c)`(const FString & SettingTypeId,`[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` & SettingsData,const FRH_PlayerInfoSetPlayerSettingsBlock & Delegate)`
Sets the players settings information for a given type.
Parameters
-
SettingTypeId
The setting type to update. -
SettingsData
Data to be stored into the players settings. -
Delegate
Callback when the operation is complete with success information.
#### `public inline void `[`BLUEPRINT_SetPlayerSettings`](#classURH__PlayerInfo_1aebf4859d56d3fc772711fd1c8714d4f0)`(const FString & SettingTypeId,`[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` SettingsData,const FRH_PlayerInfoSetPlayerSettingsDynamicDelegate & Delegate)`
#### `public virtual void `[`GetPlayerRankings`](#classURH__PlayerInfo_1a03b9bc9136601f64145bec69a5e9e9e8)`(const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerRankingsBlock & Delegate)`
Gets the players ranking information for a given type.
Parameters
-
StaleThreshold
If set, will force a re-request of the players information if the last updated time was more than the threshold. -
bForceRefresh
If true, will force a re-request of the players information. -
Delegate
Callback with the players ranking for the given type.
#### `public inline void `[`BLUEPRINT_GetPlayerRankings`](#classURH__PlayerInfo_1adbfa47a9d0df7dec931ce18fa7b4f8b4)`(const FTimespan & StaleThreshold,bool bForceRefresh,const FRH_PlayerInfoGetPlayerRankingsDynamicDelegate & Delegate)`
#### `public virtual void `[`UpdatePlayerRanking`](#classURH__PlayerInfo_1afd6c1206e990ca64b9fa56a54e085094)`(const FString & RankId,const `[`FRHAPI_PlayerRankUpdateRequest`](models/RHAPI_PlayerRankUpdateRequest.md#structFRHAPI__PlayerRankUpdateRequest)` & RankData,const FRH_PlayerInfoGetPlayerRankingsBlock & Delegate)`
Sets the players settings information for a given type.
Parameters
-
SettingTypeId
The setting type to update. -
SettingsData
Data to be stored into the players settings. -
Delegate
Callback when the operation is complete with success information.
#### `public inline void `[`BLUEPRINT_UpdatePlayerRanking`](#classURH__PlayerInfo_1a60648275bd880b33cfb78b403e0832ac)`(const FString & RankId,const `[`FRHAPI_PlayerRankUpdateRequest`](models/RHAPI_PlayerRankUpdateRequest.md#structFRHAPI__PlayerRankUpdateRequest)` & RankData,const FRH_PlayerInfoGetPlayerRankingsDynamicDelegate & Delegate)`
#### `public FAuthContextPtr `[`GetAuthContext`](#classURH__PlayerInfo_1a38aa7a072a97be36bc623a9cda702cdf)`() const`
Gets the local Auth Context for making API calls.
Returns
Local auth context for the given player or instance
#### `public virtual ERHAPI_Platform `[`GetLoggedInPlatform`](#classURH__PlayerInfo_1a12baa089a6981ccb98fba0dab3ea550b)`() const`
Gets the local users logged in platform type.
Returns
The Platform type of the local user
#### `protected FGuid `[`RHPlayerUuid`](#classURH__PlayerInfo_1abd6b1bad2e1044b59af44d04f822cef1)
The Unique Player Id for the player.
#### `protected TMap< FString, `[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` > `[`PlayerSettingsByTypeId`](#classURH__PlayerInfo_1a17fa2a55af8c7efa708db4871753ae07)
Cache of Player Settings Data by their settings types.
#### `protected TMap< FString, `[`FRH_PlayerSettingKeySetWrapper`](PlayerInfo.md#structFRH__PlayerSettingKeySetWrapper)` > `[`PendingSettingRequestsByTypeId`](#classURH__PlayerInfo_1a65d3de9960e39b3dcacc0d885c14b016)
When requesting multiple Player Settings Updates at once, this keeps track of pending requests so we know when all requests are completed.
#### `protected TMap< FString, `[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` > `[`SetPlayerSettingResponses`](#classURH__PlayerInfo_1ae9c58905a224f950cec5f6fc65de81f3)
Used when requesting multiple Player Settings Updates to track all their responses.
#### `protected TArray< `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` > `[`LinkedPlayerPlatforms`](#classURH__PlayerInfo_1a9f74bbf7a958d7a5a00d7daa8c159c2f)
Cache of all platforms the player is linked to.
#### `protected `[`URH_PlayerPresence`](PlayerInfo.md#classURH__PlayerPresence)` * `[`PlayerPresence`](#classURH__PlayerInfo_1ae3c851503d0b5b8c024dc55252acb688)
The players Presence Information.
#### `protected `[`URH_PlayerSessions`](PlayerInfo.md#classURH__PlayerSessions)` * `[`PlayerSessions`](#classURH__PlayerInfo_1a7af4d09bb83333d3028bc9a94cf067fd)
The players Sessions Information.
#### `protected `[`URH_PlayerMatches`](PlayerInfo.md#classURH__PlayerMatches)` * `[`PlayerMatches`](#classURH__PlayerInfo_1a1f355fbb71f17bc3bb40283c931138aa)
The players Matches Information.
#### `protected `[`URH_PlayerReports`](PlayerInfo.md#classURH__PlayerReports)` * `[`PlayerReports`](#classURH__PlayerInfo_1a99a08ebcbd1c9c030f1d4ca7f9fcb572)
The players Reports Information.
#### `protected `[`URH_PlayerInventory`](Inventory.md#classURH__PlayerInventory)` * `[`PlayerInventory`](#classURH__PlayerInfo_1ab06228dae3921d141dbbf2bf895c55da)
The Players Inventory Subsystem.
#### `protected `[`URH_PlayerNotifications`](Notifications.md#classURH__PlayerNotifications)` * `[`PlayerNotifications`](#classURH__PlayerInfo_1ac1eb1a25b4d89a7f7c75cbb6d4c9e4a8)
The Players Inventory Subsystem.
#### `protected TMap< FString, `[`FRHAPI_PlayerRankResponseV2`](models/RHAPI_PlayerRankResponseV2.md#structFRHAPI__PlayerRankResponseV2)` > `[`PlayerRankingsByRankingId`](#classURH__PlayerInfo_1a5728d3241aef0abed0788e90422ad071)
List of the player’s rankings.
#### `protected FDateTime `[`LastRequestPlatforms`](#classURH__PlayerInfo_1aa5e1b18e6f2841b2f1e32914d8552756)
Tracks the last time the players linked platforms were requested for checking if the data is stale.
#### `protected TMap< FString, FDateTime > `[`LastRequestSettingsByTypeId`](#classURH__PlayerInfo_1aaa55e58e83b940311b96f7869bea9bba)
Tracks the last time each settings type was request for checking if the data is stale.
#### `protected FDateTime `[`LastRequestRankings`](#classURH__PlayerInfo_1a5e9c3bbbc44273cfa7286f52c457d435)
Tracks the last time the player rankings were requested for checking if the data is stale.
#### `protected virtual void `[`OnGetPlayerLinkedPlatformsForLastKnownDisplayNameResponse`](#classURH__PlayerInfo_1a49e19ae4082f15e22b2062c1cb78deb0)`(bool bSuccess,const TArray< `[`URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * > & Platforms,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate,const class `[`URH_LocalPlayerSubsystem`](LocalPlayer.md#classURH__LocalPlayerSubsystem)` * LocalPlayerSubsystem)`
Handles the response to a Get Linked Platforms For Last Known Display Name call.
Parameters
-
bSuccess
If the call was successful. -
Platforms
List of platforms the player is linked to. -
PreferredPlatformType
The preferred platform type to use for the player. -
Delegate
Delegate passed in for original call to respond to when call completes. -
LocalPlayerSubsystem
The local player subsystem that made the original call.
#### `protected virtual void `[`OnDisplayNameSanitized`](#classURH__PlayerInfo_1afe5a34e86382c3f78767f2d72e3819fd)`(bool bSuccess,const FString & SanitizedMessage,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate)`
Handles the response to sanitizing the players display name.
Parameters
-
bSuccess
If the call was successful. -
SanitizedMessage
The sanitized display name. -
PreferredPlatformType
The preferred platform type to use for the player. -
Delegate
Callback Delegate to return the name.
#### `protected virtual void `[`OnGetPlayerLinkedPlatformsResponse`](#classURH__PlayerInfo_1ada74501b2e422f1fcf8f76825d74cc58)`(const GetPlatforms::Response & Response,const FRH_PlayerInfoGetPlatformsBlock Delegate)`
Handles the response to a Get Linked Platforms call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes.
#### `protected virtual void `[`OnGetPlayerSettingsResponse`](#classURH__PlayerInfo_1a115f584e7b7b210193fd9e302abbd3ed)`(const GetSettings::Response & Response,const FRH_PlayerInfoGetPlayerSettingsBlock Delegate,const FString SettingTypeId)`
Handles the response to a Get Player Settings call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes. -
SettinyTypeId
The type of settings that were requested.
#### `protected virtual void `[`OnSetPlayerSettingsResponse`](#classURH__PlayerInfo_1a6f59dae05d5371b867091b180280f091)`(const SetSettings::Response & Response,const FRH_PlayerInfoSetPlayerSettingsBlock Delegate,const FString SettingTypeId,const FString SettingKey,`[`FRH_PlayerSettingsDataWrapper`](undefined.md#structFRH__PlayerSettingsDataWrapper)` SettingsData)`
Handles the response to a Set Player Settings call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes. -
SettinyTypeId
The type of settings that being updated requested. -
SettingKey
The key of the setting that was updated. -
SettingsData
The data of the setting that was updated.
#### `protected virtual void `[`OnGetPlayerRankingsResponse`](#classURH__PlayerInfo_1a53c355b2f85273d37008d685c3cc113c)`(const GetRankings::Response & Response,const FRH_PlayerInfoGetPlayerRankingsBlock Delegate)`
Handles the response to a Get Player Rankings call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes.
#### `protected virtual void `[`OnUpdatePlayerRankingResponse`](#classURH__PlayerInfo_1a214672d0d5001ec24098b5414b0fc35d)`(const UpdateRanking::Response & Response,const FRH_PlayerInfoGetPlayerRankingsBlock Delegate)`
Handles the response to a Update Player Ranking call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes.
#### `typedef `[`GetPlatforms`](#classURH__PlayerInfo_1a88c3597ebf7f47399d936f5a96d344f6)
#### `typedef `[`GetSettings`](#classURH__PlayerInfo_1ae425cac3ffa853a48c03df8caa2c8ca9)
#### `typedef `[`SetSettings`](#classURH__PlayerInfo_1af84cca7ca91da85ceec6caf73af9db11)
#### `typedef `[`GetRankings`](#classURH__PlayerInfo_1ae1180995c5f25cb946b6f47e44886c46)
#### `typedef `[`UpdateRanking`](#classURH__PlayerInfo_1a0dde72a36a43d91264f8dc89aafcd5de)
## class `URH_PlayerInfoSubsystem`
Subsystem used to track and request information about players.
Summary
Members | Descriptions |
---|---|
public virtual void Initialize () | Initialize the subsystem. |
public virtual void Deinitialize () | Safely tears down the subsystem. |
public inline const TMap< FGuid, URH_PlayerInfo * > & GetPlayerInfos () const | Gets a map of all the player infos. |
public virtual URH_PlayerInfo * GetOrCreatePlayerInfo (const FGuid & PlayerUuid) | Gets a Player Info object for a given Player Unique Id, creates if needed. |
public virtual URH_PlayerPlatformInfo * GetOrCreatePlayerPlatformInfo (const FRH_PlayerPlatformId & PlayerPlatformId) | Gets a Player Info object for a given Player Platform Id, creates if needed. |
public virtual URH_PlayerInfo * FindPlayerInfoByPlatformId (const FRH_PlayerPlatformId & PlayerPlatformId) const | Gets a Player Info object for a given Player Platform Id. |
public inline virtual URH_PlayerInfo * GetPlayerInfo (const FGuid & PlayerUuid) const | Gets a Player Info object for a given Unique Player Id. |
public inline virtual URH_PlayerPlatformInfo * GetPlayerPlatformInfo (const FRH_PlayerPlatformId & PlayerPlatformId) const | Gets the platform info object for a player by the Platform Id. |
public inline virtual void AddPlayerLink (const FRH_PlayerPlatformId & PlayerPlatformId,const FGuid & PlayerUuid) | Adds a platform mapping for a given player. |
public virtual void LookupPlayer (FString PlayerName,const FRH_PlayerInfoLookupPlayerBlock & Delegate) | Searchs for all players who use the given display name via API Call. |
public inline void BLUEPRINT_LookupPlayer (FString PlayerName,const FRH_PlayerInfoLookupPlayerDynamicDelegate & Delegate) | |
public virtual void LookupPlayerByPlatformUserId ( FRH_PlayerPlatformId PlayerPlatformId,const FRH_PlayerInfoLookupPlayerBlock & Delegate) | Searchs for players associated with the given platform and platform user id via API Call. |
public inline void BLUEPRINT_LookupPlayerByPlatformUserId ( FRH_PlayerPlatformId PlayerPlatformId,const FRH_PlayerInfoLookupPlayerDynamicDelegate & Delegate) | |
public virtual URH_PlayerInfo * RemovePlayerInfoFromCache (const FGuid & PlayerUuid) | Remove a specific Player Info from PlayerInfoSubsystem’s cache. |
public virtual void Tick (float DeltaTime) | Unreals basic Tick function. |
public inline virtual bool IsTickable () const | Gets if currently tickable. |
public inline virtual TStatId GetStatId () const | Gets the stat to use for the tick time. |
protected TSubclassOf< URH_PlayerInfo > PlayerInfoClassOverride | Override class for Player Info if extended. |
protected TMap< FGuid, URH_PlayerInfo * > PlayerInfos | Map of Player Infos to their player Uuids. |
protected TMap< FRH_PlayerPlatformId](Common.md#structFRH__PlayerPlatformId), [URH_PlayerPlatformInfo * > PlayerPlatformInfos | Map of Player Platform Infos to their Platform Ids. |
protected TMap< FRH_PlayerPlatformId , FGuid > PlayerPlatformIdToUuidMap | Map of Player Uuid to their Platform Ids. |
protected virtual void ClearPlayerInfoCache () | Clears the cached player infos. |
protected virtual void InitPropertiesWithDefaultValues () | Initializes the subsystem with defaults for its cached data. |
protected virtual void OnLookupPlayerResponse (const TLookupPlayer::Response & Response,const FRH_PlayerInfoLookupPlayerBlock Delegate) | Handles the response to a Lookup Player call. |
protected virtual void OnLookupPlayerByPlatformUserIdResponse (const TLookupPlayer::Response & Response,const FRH_PlayerInfoLookupPlayerBlock Delegate) | Handles the response to a Lookup Player By Platform User Id call. |
typedef TLookupPlayer |
Members
public virtual void
Initialize
()
Initialize the subsystem.
#### `public virtual void `[`Deinitialize`](#classURH__PlayerInfoSubsystem_1ac84840e29cafeb3dd61382c359dd93e8)`()`
Safely tears down the subsystem.
#### `public inline const TMap< FGuid, `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * > & `[`GetPlayerInfos`](#classURH__PlayerInfoSubsystem_1abc456ab4d8ed5e310f4069cd412b7015)`() const`
Gets a map of all the player infos.
Returns
Map of player infos by Player Unique Id
#### `public virtual `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * `[`GetOrCreatePlayerInfo`](#classURH__PlayerInfoSubsystem_1a86cbf48c7736df66c95719b2aa2e56df)`(const FGuid & PlayerUuid)`
Gets a Player Info object for a given Player Unique Id, creates if needed.
Parameters
PlayerUuid
Unique Player Id for the given player
Returns
Player Info for the player
#### `public virtual `[`URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * `[`GetOrCreatePlayerPlatformInfo`](#classURH__PlayerInfoSubsystem_1afe3412c3393e536a6bfa3df5c32b1d30)`(const `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` & PlayerPlatformId)`
Gets a Player Info object for a given Player Platform Id, creates if needed.
Parameters
PlayerPlatformId
Player Platform Id for the given player
Returns
Player Info for the player
#### `public virtual `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * `[`FindPlayerInfoByPlatformId`](#classURH__PlayerInfoSubsystem_1a0b93b7052abf97f65ac4e457585dd386)`(const `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` & PlayerPlatformId) const`
Gets a Player Info object for a given Player Platform Id.
Parameters
PlayerPlatformId
Player Platform Id for the given player
Returns
Player Info for the player if found
#### `public inline virtual `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * `[`GetPlayerInfo`](#classURH__PlayerInfoSubsystem_1a313afdb4e447c17e8bd9f44d789fd4c4)`(const FGuid & PlayerUuid) const`
Gets a Player Info object for a given Unique Player Id.
Parameters
PlayerUuid
Unique Player Id for the given player
Returns
Player Info for the player if found
#### `public inline virtual `[`URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * `[`GetPlayerPlatformInfo`](#classURH__PlayerInfoSubsystem_1a078ceecb56513631701ed82bfbfbcbf4)`(const `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` & PlayerPlatformId) const`
Gets the platform info object for a player by the Platform Id.
Parameters
PlayerPlatformId
Player Platform Id for the given player
Returns
Player Platform Info for the player if found
#### `public inline virtual void `[`AddPlayerLink`](#classURH__PlayerInfoSubsystem_1a4036500640f2d33632faee6aa5c09755)`(const `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` & PlayerPlatformId,const FGuid & PlayerUuid)`
Adds a platform mapping for a given player.
Parameters
-
PlayerUuid
Unique Player Id for the given player -
PlayerPlatformId
Player Platform Id for the given player
#### `public virtual void `[`LookupPlayer`](#classURH__PlayerInfoSubsystem_1a4440282ee5fee5dfee7e23cb905a87d7)`(FString PlayerName,const FRH_PlayerInfoLookupPlayerBlock & Delegate)`
Searchs for all players who use the given display name via API Call.
Parameters
-
PlayerName
The display name we want to search for -
Delegate
Callback with the all PlayerInfos that are found with that display name
#### `public inline void `[`BLUEPRINT_LookupPlayer`](#classURH__PlayerInfoSubsystem_1af49782e7e30900e743e026d08a5f991b)`(FString PlayerName,const FRH_PlayerInfoLookupPlayerDynamicDelegate & Delegate)`
#### `public virtual void `[`LookupPlayerByPlatformUserId`](#classURH__PlayerInfoSubsystem_1a9f0630cd321711484630ba48a75cdef2)`(`[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` PlayerPlatformId,const FRH_PlayerInfoLookupPlayerBlock & Delegate)`
Searchs for players associated with the given platform and platform user id via API Call.
Parameters
-
Platform
The platform used for the lookup -
PlatformUserId
The platform user id used for the lookup -
Delegate
Callback with the all PlayerInfos that are found with that display name
#### `public inline void `[`BLUEPRINT_LookupPlayerByPlatformUserId`](#classURH__PlayerInfoSubsystem_1acf620014114fa3f12ec521960f84d779)`(`[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` PlayerPlatformId,const FRH_PlayerInfoLookupPlayerDynamicDelegate & Delegate)`
#### `public virtual `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * `[`RemovePlayerInfoFromCache`](#classURH__PlayerInfoSubsystem_1ac2630ddd5570040bb68a69c94721d3a4)`(const FGuid & PlayerUuid)`
Remove a specific Player Info from PlayerInfoSubsystem’s cache.
Parameters
PlayerUuid
The UUID of the Player Info to be removed
Returns
The Player Info that got removed
#### `public virtual void `[`Tick`](#classURH__PlayerInfoSubsystem_1abf83de825c346653c1bc3cba1df75815)`(float DeltaTime)`
Unreals basic Tick function.
#### `public inline virtual bool `[`IsTickable`](#classURH__PlayerInfoSubsystem_1a49b75fe691775b67c9af6a818d2e4592)`() const`
Gets if currently tickable.
#### `public inline virtual TStatId `[`GetStatId`](#classURH__PlayerInfoSubsystem_1a159d3535c053aa721f87274f48742cfa)`() const`
Gets the stat to use for the tick time.
#### `protected TSubclassOf< `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` > `[`PlayerInfoClassOverride`](#classURH__PlayerInfoSubsystem_1a53d13eb27e48d9e00cd52986c5741fcf)
Override class for Player Info if extended.
#### `protected TMap< FGuid, `[`URH_PlayerInfo`](PlayerInfo.md#classURH__PlayerInfo)` * > `[`PlayerInfos`](#classURH__PlayerInfoSubsystem_1a616fa3bfe4df4b7f8edd78f2414a42d5)
Map of Player Infos to their player Uuids.
#### `protected TMap< `[`FRH_PlayerPlatformId](Common.md#structFRH__PlayerPlatformId), [URH_PlayerPlatformInfo`](PlayerInfo.md#classURH__PlayerPlatformInfo)` * > `[`PlayerPlatformInfos`](#classURH__PlayerInfoSubsystem_1a17e2ac363f59929e2c5be24746c03dbe)
Map of Player Platform Infos to their Platform Ids.
#### `protected TMap< `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)`, FGuid > `[`PlayerPlatformIdToUuidMap`](#classURH__PlayerInfoSubsystem_1a25ed5e4057d3929418e973228f9851a1)
Map of Player Uuid to their Platform Ids.
#### `protected virtual void `[`ClearPlayerInfoCache`](#classURH__PlayerInfoSubsystem_1a2ddbe40cfed50b7e76437aec24e4c054)`()`
Clears the cached player infos.
#### `protected virtual void `[`InitPropertiesWithDefaultValues`](#classURH__PlayerInfoSubsystem_1a5e14a7f60c320b9a2186e33726f7e5ee)`()`
Initializes the subsystem with defaults for its cached data.
#### `protected virtual void `[`OnLookupPlayerResponse`](#classURH__PlayerInfoSubsystem_1a5d178f65256eafbf0fccfc17e87bae62)`(const TLookupPlayer::Response & Response,const FRH_PlayerInfoLookupPlayerBlock Delegate)`
Handles the response to a Lookup Player call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes.
#### `protected virtual void `[`OnLookupPlayerByPlatformUserIdResponse`](#classURH__PlayerInfoSubsystem_1a0cd6b58da263387aead9c9d17729cb27)`(const TLookupPlayer::Response & Response,const FRH_PlayerInfoLookupPlayerBlock Delegate)`
Handles the response to a Lookup Player By Platform User Id call.
Parameters
-
Resp
Response given for the call -
Delegate
Delegate passed in for original call to respond to when call completes.
#### `typedef `[`TLookupPlayer`](#classURH__PlayerInfoSubsystem_1a221cacf49cc61a7df9b7e791befbb312)
## struct `FRH_PlayerSettingKeySetWrapper`
Wrapper to help with setting keys for player settings.
Summary
Members | Descriptions |
---|---|
public TSet< FString > SettingKeySet | Set of keys being set by the settings update. |
public inline FRH_PlayerSettingKeySetWrapper () | Default constructor. |
Members
public TSet< FString >
SettingKeySet
Set of keys being set by the settings update.
#### `public inline `[`FRH_PlayerSettingKeySetWrapper`](#structFRH__PlayerSettingKeySetWrapper_1a67aefafe77cd84f15942f74a220f93a8)`()`
Default constructor.
## struct `FRH_PlayerAndPlatformInfo`
Wrapper to pair a players Unique Player Id and their current logged in Platform Id.
Summary
Members | Descriptions |
---|---|
public FGuid PlayerUuid | The players Unique Player id. |
public FRH_PlayerPlatformId PlayerPlatformId | The players logged in Platform Id. |
public inline FRH_PlayerAndPlatformInfo () | Default Constructor. |
Members
public FGuid
PlayerUuid
The players Unique Player id.
#### `public `[`FRH_PlayerPlatformId`](Common.md#structFRH__PlayerPlatformId)` `[`PlayerPlatformId`](#structFRH__PlayerAndPlatformInfo_1a3e37b7de18225d02a405d03901b2f9a2)
The players logged in Platform Id.
#### `public inline `[`FRH_PlayerAndPlatformInfo`](#structFRH__PlayerAndPlatformInfo_1a06195fa8f09f200dba4da24a838bc58e)`()`
Default Constructor.