MatchmakingBrowser
Summary
Members | Descriptions |
---|---|
class URH_MatchmakingQueueInfo | Class to define a matchmaking queue. |
class URH_MatchmakingTemplateGroupInfo | Class to organize a matchmaking Templates information. |
class URH_MatchmakingProfileInfo | Class to organize a matchmaking Profiles information. |
class URH_InstanceRequestTemplate | Class to organize a Instance Request Templates information. |
class URH_MatchmakingBrowserCache | Simple container class to hold matchmaking data, does not have its own auth context, relies upon getting it from elsewhere during calls, so that it can be used to cache across multiple players. |
struct FRH_QueueSearchParams | Struct to define queue search parameters. |
struct FRH_QueueSearchResult | Struct to define queue search results. |
class URH_MatchmakingQueueInfo
class URH_MatchmakingQueueInfo : public UObject
Class to define a matchmaking queue.
Summary
Members | Descriptions |
---|---|
public inline const FRHAPI_QueueConfigV2 & GetQueueInfo () const | Gets the queue info. |
public inline const FString & GetETag () const | Gets the Etag for the queue info. |
public inline const FString & GetQueueId () const | The ID for the queue, should not be used for display purposes. |
public inline bool IsActive () const | Flag for whether or not the queue is active, and can be joined or sessions created from it. |
public inline void ImportAPIQueue (const FRHAPI_QueueConfigV2 & APIQueue,const FString & InETag) | Imports queue info from an API call. |
public inline FString GetDescription () const | Gets a description of the queue, display its id for debugging. |
Members
public inline const
FRHAPI_QueueConfigV2
&
GetQueueInfo
() const
Gets the queue info.
public inline const FString &
GetETag
() const
Gets the Etag for the queue info.
public inline const FString &
GetQueueId
() const
The ID for the queue, should not be used for display purposes.
public inline bool
IsActive
() const
Flag for whether or not the queue is active, and can be joined or sessions created from it.
public inline void
ImportAPIQueue
(const
FRHAPI_QueueConfigV2
& APIQueue,const FString & InETag)
Imports queue info from an API call.
Parameters
-
APIQueue
Queue info from API call. -
InETag
ETag from API call.
public inline FString
GetDescription
() const
Gets a description of the queue, display its id for debugging.
class URH_MatchmakingTemplateGroupInfo
class URH_MatchmakingTemplateGroupInfo : public UObject
Class to organize a matchmaking Templates information.
Summary
Members | Descriptions |
---|---|
public inline const FRHAPI_MatchMakingTemplateGroupV2 & GetInfo () const | Gets the template info. |
public inline const FString & GetETag () const | Gets the Etag for the template info. |
public inline const FGuid & GetTemplateGroupId () const | ID for this set of potential matchmaking templates. |
public inline TSet< int32 > GetRequiredItemIds () const | ** |
public inline const TArray< FGuid > GetPossibleInstanceRequestTemplateIds () const | ID for which instance launch template this queue will use. |
public inline void ImportAPITemplateGroup (const FRHAPI_MatchMakingTemplateGroupV2 & APITemplateGroup,const FString & InETag) | Imports template info from an API call. |
public inline FString GetDescription () const | Gets a description of the template, display its id for debugging. |
Members
public inline const
FRHAPI_MatchMakingTemplateGroupV2
&
GetInfo
() const
Gets the template info.
public inline const FString &
GetETag
() const
Gets the Etag for the template info.
public inline const FGuid &
GetTemplateGroupId
() const
ID for this set of potential matchmaking templates.
public inline TSet< int32 >
GetRequiredItemIds
() const
**
List of the different matchmaking templates that could be used. The config is chosen based on a set of rules in each MatchMakingTemplate object. If there are no rules, it’s the default template */
Set of all the item ids that are required to validate every rule contained in this template group
public inline const TArray< FGuid >
GetPossibleInstanceRequestTemplateIds
() const
ID for which instance launch template this queue will use.
public inline void
ImportAPITemplateGroup
(const
FRHAPI_MatchMakingTemplateGroupV2
& APITemplateGroup,const FString & InETag)
Imports template info from an API call.
Parameters
-
APITemplateGroup
Template info from API call. -
InETag
ETag from API call.
public inline FString
GetDescription
() const
Gets a description of the template, display its id for debugging.
class URH_MatchmakingProfileInfo
class URH_MatchmakingProfileInfo : public UObject
Class to organize a matchmaking Profiles information.
Summary
Members | Descriptions |
---|---|
public inline const FRHAPI_MatchMakingProfileV2 & GetProfile () const | Gets the template info. |
public inline const FString & GetETag () const | Gets the Etag for the template info. |
public inline const FString & GetProfileId () const | ID for this set of potential matchmaking templates. |
public inline void ImportAPIProfile (const FRHAPI_MatchMakingProfileV2 & APIProfile,const FString & InETag) | Imports profile info from an API call. |
public inline FString GetDescription () const | Gets a description of the template, display its id for debugging. |
Members
public inline const
FRHAPI_MatchMakingProfileV2
&
GetProfile
() const
Gets the template info.
public inline const FString &
GetETag
() const
Gets the Etag for the template info.
public inline const FString &
GetProfileId
() const
ID for this set of potential matchmaking templates.
public inline void
ImportAPIProfile
(const
FRHAPI_MatchMakingProfileV2
& APIProfile,const FString & InETag)
Imports profile info from an API call.
Parameters
-
APIProfile
Profile info from API call. -
InETag
ETag from API call.
public inline FString
GetDescription
() const
Gets a description of the template, display its id for debugging.
class URH_InstanceRequestTemplate
class URH_InstanceRequestTemplate : public UObject
Class to organize a Instance Request Templates information.
Summary
Members | Descriptions |
---|---|
public inline const FRHAPI_InstanceRequestTemplate & GetInfo () const | Gets the template info. |
public inline const FString & GetETag () const | Gets the Etag for the template info. |
public inline const FGuid & GetInstanceRequestTemplateId () const | ID to uniquely identify this instance launch template. |
public inline const TMap< FString, FString > & GetCustomData () const | Custom data that will be passed to the session during the instance launch request. |
public inline void ImportAPIInstanceLaunchTemplate (const FRHAPI_InstanceRequestTemplate & APITemplate,const FString & InETag) | Imports template info from an API call. |
public inline FString GetDescription () const | Gets a description of the template, display its id for debugging. |
Members
public inline const
FRHAPI_InstanceRequestTemplate
&
GetInfo
() const
Gets the template info.
public inline const FString &
GetETag
() const
Gets the Etag for the template info.
public inline const FGuid &
GetInstanceRequestTemplateId
() const
ID to uniquely identify this instance launch template.
public inline const TMap< FString, FString > &
GetCustomData
() const
Custom data that will be passed to the session during the instance launch request.
public inline void
ImportAPIInstanceLaunchTemplate
(const
FRHAPI_InstanceRequestTemplate
& APITemplate,const FString & InETag)
Imports template info from an API call.
Parameters
-
APITemplate
Template info from API call. -
InETag
ETag from API call.
public inline FString
GetDescription
() const
Gets a description of the template, display its id for debugging.
class URH_MatchmakingBrowserCache
class URH_MatchmakingBrowserCache : public URH_GameInstanceSubsystemPlugin
Simple container class to hold matchmaking data, does not have its own auth context, relies upon getting it from elsewhere during calls, so that it can be used to cache across multiple players.
Summary
Members | Descriptions |
---|---|
public FRegionSettingsUpdatedDelegate OnRegionsUpdatedNative | Delegate to listen for matchmaking regions updated. |
public FRegionSettingsUpdatedDynamicDelegate OnRegionsUpdated | |
public URH_MatchmakingBrowserCache () | Default constructor. |
public void SearchQueues (const FRH_QueueSearchParams & params,const FRH_OnQueueSearchCompleteDelegateBlock & Delegate) | Search for queues. |
public inline void BLUEPRINT_SearchQueues (const FRH_QueueSearchParams & params,const FRH_OnQueueSearchCompleteDynamicDelegate & Delegate) | |
public void SearchMatchmakingTemplateGroup (const FGuid & TemplateId,const FRH_OnGetMatchmakingTemplateGroupCompleteDelegateBlock & Delegate) | Search for a matchmaking template. |
public inline void BLUEPRINT_SearchMatchmakingTemplateGroup (const FGuid & TemplateId,const FRH_OnGetMatchmakingTemplateGroupCompleteDynamicDelegate & Delegate) | |
public void SearchMatchmakingProfile (const FString & ProfileId,const FRH_OnGetMatchmakingProfileCompleteDelegateBlock & Delegate) | Search for a matchmaking profiles. |
public inline void BLUEPRINT_SearchMatchmakingProfile (const FString & ProfileId,const FRH_OnGetMatchmakingProfileCompleteDynamicDelegate & Delegate) | |
public void SearchInstanceRequestTemplate (const FGuid & TemplateId,const FRH_OnGetInstanceRequestTemplateCompleteDelegateBlock & Delegate) | Search for an instance launch template. |
public inline void BLUEPRINT_SearchInstanceRequestTemplate (const FGuid & TemplateId,const FRH_OnGetInstanceRequestTemplateCompleteDynamicDelegate & Delegate) | |
public void SearchRegions (int32 Cursor,const FRH_OnRegionSearchCompleteDelegateBlock & Delegate) | Search for matchmaking regions. |
public inline void BLUEPRINT_SearchRegions (int32 Cursor,const FRH_OnRegionSearchCompleteDynamicDelegate & Delegate) | |
public inline URH_MatchmakingQueueInfo * GetQueue (const FString & QueueId) const | Get a cached queue by Queue Id. |
public inline URH_MatchmakingTemplateGroupInfo * GetMatchmakingTemplateGroup (const FGuid & TemplateGroupId) const | Get a cached matchmaking template by Template Id. |
public inline URH_MatchmakingProfileInfo * GetMatchmakingProfile (const FString & ProfileId) const | Get a cached matchmaking template by Template Id. |
public inline URH_InstanceRequestTemplate * GetInstanceRequestTemplate (const FGuid & InstanceRequestTemplateId) const | Get a cached instance request template by Template Id. |
public inline bool GetRegion (const FString & RegionId, FRHAPI_Region & OutRegion) const | Get a cached region by Region Id. |
public inline FORCEINLINE TArray< URH_MatchmakingQueueInfo * > GetAllQueues () const | Get all cached queues. |
public inline const TArray< URH_MatchmakingTemplateGroupInfo * > GetAllMatchmakingTemplateGroups () const | Get all cached matchmaking templates. |
public inline const TArray< URH_MatchmakingProfileInfo * > GetAllMatchmakingProfiles () const | Get all cached matchmaking profiles. |
public inline const TArray< URH_InstanceRequestTemplate * > GetAllInstanceRequestTemplates () const | Get all cached instance request templates. |
public inline TArray< FRHAPI_Region > GetAllRegions () const | Get all cached matchmaking regions. |
public inline void ClearCache () | Clears the cache of all queues and templates. |
public inline void ClearRegionsCache () | Clears the cache of regions. |
public void ImportAPIQueue (const FRHAPI_QueueConfigV2 & APIQueue,const FString & ETag) | Imports queue info from an API call. |
public void ImportAPIMatchmakingTemplateGroup (const FRHAPI_MatchMakingTemplateGroupV2 & APITemplateGroup,const FString & ETag) | Imports template info from an API call. |
public void ImportAPIMatchmakingProfile (const FRHAPI_MatchMakingProfileV2 & APIProfile,const FString & ETag) | Imports profile info from an API call. |
public void ImportAPIInstanceRequestTemplate (const FRHAPI_InstanceRequestTemplate & APITemplate,const FString & ETag) | Imports template info from an API call. |
public void ImportAPIRegion (const FRHAPI_Region & APIRegion) | Imports region info from an API call. |
protected TMap< FString, URH_MatchmakingQueueInfo * > QueueCache | Map of Queue Id to Queue Infos. |
protected TMap< FGuid, URH_MatchmakingTemplateGroupInfo * > MatchmakingTemplateGroupCache | Map of Template Id to Matchmaking Template Group Infos. |
protected TMap< FString, URH_MatchmakingProfileInfo * > MatchmakingProfileCache | Map of Matchmaking Profile Id to Profile Objects. |
protected TMap< FGuid, URH_InstanceRequestTemplate * > InstanceRequestTemplateCache | Map of Template Id to Instance Launch Template Infos. |
protected TMap< FString, FRHAPI_Region > RegionsCache | Array of Regions. |
protected int32 LastRegionCursor |
Members
public FRegionSettingsUpdatedDelegate
OnRegionsUpdatedNative
Delegate to listen for matchmaking regions updated.
public FRegionSettingsUpdatedDynamicDelegate
OnRegionsUpdated
public
URH_MatchmakingBrowserCache
()
Default constructor.
public void
SearchQueues
(const
FRH_QueueSearchParams
& params,const FRH_OnQueueSearchCompleteDelegateBlock & Delegate)
Search for queues.
Parameters
-
params
The search params to use for the given search. -
Delegate
Callback with the results of the search.
public inline void
BLUEPRINT_SearchQueues
(const
FRH_QueueSearchParams
& params,const FRH_OnQueueSearchCompleteDynamicDelegate & Delegate)
public void
SearchMatchmakingTemplateGroup
(const FGuid & TemplateId,const FRH_OnGetMatchmakingTemplateGroupCompleteDelegateBlock & Delegate)
Search for a matchmaking template.
Parameters
-
TemplateId
The matchmaking template to search for. -
Delegate
Callback with the results of the search.
public inline void
BLUEPRINT_SearchMatchmakingTemplateGroup
(const FGuid & TemplateId,const FRH_OnGetMatchmakingTemplateGroupCompleteDynamicDelegate & Delegate)
public void
SearchMatchmakingProfile
(const FString & ProfileId,const FRH_OnGetMatchmakingProfileCompleteDelegateBlock & Delegate)
Search for a matchmaking profiles.
Parameters
-
ProfileId
The matchmaking profile to search for. -
Delegate
Callback with the results of the search.
public inline void
BLUEPRINT_SearchMatchmakingProfile
(const FString & ProfileId,const FRH_OnGetMatchmakingProfileCompleteDynamicDelegate & Delegate)
public void
SearchInstanceRequestTemplate
(const FGuid & TemplateId,const FRH_OnGetInstanceRequestTemplateCompleteDelegateBlock & Delegate)
Search for an instance launch template.
Parameters
-
TemplateId
The matchmaking template to search for. -
Delegate
Callback with the results of the search.
public inline void
BLUEPRINT_SearchInstanceRequestTemplate
(const FGuid & TemplateId,const FRH_OnGetInstanceRequestTemplateCompleteDynamicDelegate & Delegate)
public void
SearchRegions
(int32 Cursor,const FRH_OnRegionSearchCompleteDelegateBlock & Delegate)
Search for matchmaking regions.
Parameters
Delegate
Callback with the results of the search.
public inline void
BLUEPRINT_SearchRegions
(int32 Cursor,const FRH_OnRegionSearchCompleteDynamicDelegate & Delegate)
public inline
URH_MatchmakingQueueInfo
*
GetQueue
(const FString & QueueId) const
Get a cached queue by Queue Id.
public inline
URH_MatchmakingTemplateGroupInfo
*
GetMatchmakingTemplateGroup
(const FGuid & TemplateGroupId) const
Get a cached matchmaking template by Template Id.
public inline
URH_MatchmakingProfileInfo
*
GetMatchmakingProfile
(const FString & ProfileId) const
Get a cached matchmaking template by Template Id.
public inline
URH_InstanceRequestTemplate
*
GetInstanceRequestTemplate
(const FGuid & InstanceRequestTemplateId) const
Get a cached instance request template by Template Id.
public inline bool
GetRegion
(const FString & RegionId,
FRHAPI_Region
& OutRegion) const
Get a cached region by Region Id.
public inline FORCEINLINE TArray<
URH_MatchmakingQueueInfo
* >
GetAllQueues
() const
Get all cached queues.
public inline const TArray<
URH_MatchmakingTemplateGroupInfo
* >
GetAllMatchmakingTemplateGroups
() const
Get all cached matchmaking templates.
public inline const TArray<
URH_MatchmakingProfileInfo
* >
GetAllMatchmakingProfiles
() const
Get all cached matchmaking profiles.
public inline const TArray<
URH_InstanceRequestTemplate
* >
GetAllInstanceRequestTemplates
() const
Get all cached instance request templates.
public inline TArray<
FRHAPI_Region
>
GetAllRegions
() const
Get all cached matchmaking regions.
public inline void
ClearCache
()
Clears the cache of all queues and templates.
public inline void
ClearRegionsCache
()
Clears the cache of regions.
public void
ImportAPIQueue
(const
FRHAPI_QueueConfigV2
& APIQueue,const FString & ETag)
Imports queue info from an API call.
Parameters
-
APIQueue
Queue info from API call. -
InETag
ETag from API call.
public void
ImportAPIMatchmakingTemplateGroup
(const
FRHAPI_MatchMakingTemplateGroupV2
& APITemplateGroup,const FString & ETag)
Imports template info from an API call.
Parameters
-
APITemplateGroup
Template info from API call. -
InETag
ETag from API call.
public void
ImportAPIMatchmakingProfile
(const
FRHAPI_MatchMakingProfileV2
& APIProfile,const FString & ETag)
Imports profile info from an API call.
Parameters
-
APIProfile
Profile info from API call. -
InETag
ETag from API call.
public void
ImportAPIInstanceRequestTemplate
(const
FRHAPI_InstanceRequestTemplate
& APITemplate,const FString & ETag)
Imports template info from an API call.
Parameters
-
APITemplate
Template info from API call. -
InETag
ETag from API call.
public void
ImportAPIRegion
(const
FRHAPI_Region
& APIRegion)
Imports region info from an API call.
Parameters
APIRegions
Region info from API call.
protected TMap< FString,
URH_MatchmakingQueueInfo
* >
QueueCache
Map of Queue Id to Queue Infos.
protected TMap< FGuid,
URH_MatchmakingTemplateGroupInfo
* >
MatchmakingTemplateGroupCache
Map of Template Id to Matchmaking Template Group Infos.
protected TMap< FString,
URH_MatchmakingProfileInfo
* >
MatchmakingProfileCache
Map of Matchmaking Profile Id to Profile Objects.
protected TMap< FGuid,
URH_InstanceRequestTemplate
* >
InstanceRequestTemplateCache
Map of Template Id to Instance Launch Template Infos.
protected TMap< FString,
FRHAPI_Region
>
RegionsCache
Array of Regions.
protected int32
LastRegionCursor
struct FRH_QueueSearchParams
Struct to define queue search parameters.
Summary
Members | Descriptions |
---|---|
public int32 Cursor | The Cursor location to start the search. |
public int32 PageSize | The size of page to return from the search. |
public inline FRH_QueueSearchParams () | Defautl constructor. |
public inline FString GetDescription () const | Gets a description of the search params for debugging. |
Members
public int32
Cursor
The Cursor location to start the search.
public int32
PageSize
The size of page to return from the search.
public inline
FRH_QueueSearchParams
()
Defautl constructor.
public inline FString
GetDescription
() const
Gets a description of the search params for debugging.
struct FRH_QueueSearchResult
Struct to define queue search results.
Summary
Members | Descriptions |
---|---|
public FRH_QueueSearchParams SearchParams | The params used to make the search request. |
public TArray< TWeakObjectPtr< URH_MatchmakingQueueInfo > > Queues | The queues returned by the search request. |
public inline FString GetDescription () const | Gets a description of the search result for debugging. |
Members
public
FRH_QueueSearchParams
SearchParams
The params used to make the search request.
public TArray< TWeakObjectPtr<
URH_MatchmakingQueueInfo
> >
Queues
The queues returned by the search request.
public inline FString
GetDescription
() const
Gets a description of the search result for debugging.