Match
Summary
Members | Descriptions |
---|---|
public DECLARE_DYNAMIC_DELEGATE_ThreeParams (FRH_OnMatchSearchCompleteDynamicDelegate,bool,bSuccess,const FRH_MatchSearchResult &,SearchResult,const FRH_ErrorInfo &,ErrorInfo) | |
public DECLARE_DELEGATE_ThreeParams (FRH_OnMatchSearchCompleteDelegate,bool,const FRH_MatchSearchResult &,const FRH_ErrorInfo &) | |
public DECLARE_RH_DELEGATE_BLOCK (FRH_OnMatchSearchCompleteDelegateBlock,FRH_OnMatchSearchCompleteDelegate,FRH_OnMatchSearchCompleteDynamicDelegate,bool,const FRH_MatchSearchResult &,const FRH_ErrorInfo &) | |
public DECLARE_DYNAMIC_DELEGATE_ThreeParams (FRH_OnMatchLookupCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers &,SearchResult,const FRH_ErrorInfo &,ErrorInfo) | |
public DECLARE_DELEGATE_ThreeParams (FRH_OnMatchLookupCompleteDelegate,bool,const FRHAPI_MatchWithPlayers &,const FRH_ErrorInfo &) | |
public DECLARE_RH_DELEGATE_BLOCK (FRH_OnMatchLookupCompleteDelegateBlock,FRH_OnMatchLookupCompleteDelegate,FRH_OnMatchLookupCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers &,const FRH_ErrorInfo &) | |
public DECLARE_DYNAMIC_DELEGATE_ThreeParams (FRH_OnMatchUpdateCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers &,Match,const FRH_ErrorInfo &,ErrorInfo) | |
public DECLARE_DELEGATE_ThreeParams (FRH_OnMatchUpdateCompleteDelegate,bool,const FRHAPI_MatchWithPlayers &,const FRH_ErrorInfo &) | |
public DECLARE_RH_DELEGATE_BLOCK (FRH_OnMatchUpdateCompleteDelegateBlock,FRH_OnMatchUpdateCompleteDelegate,FRH_OnMatchUpdateCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers &,const FRH_ErrorInfo &) | |
public DECLARE_DYNAMIC_DELEGATE_ThreeParams (FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchPlayerWithMatch &,Match,const FRH_ErrorInfo &,ErrorInfo) | |
public DECLARE_DELEGATE_ThreeParams (FRH_OnMatchPlayerUpdateCompleteDelegate,bool,const FRHAPI_MatchPlayerWithMatch &,const FRH_ErrorInfo &) | |
public DECLARE_RH_DELEGATE_BLOCK (FRH_OnMatchPlayerUpdateCompleteDelegateBlock,FRH_OnMatchPlayerUpdateCompleteDelegate,FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,const FRHAPI_MatchPlayerWithMatch &,const FRH_ErrorInfo &) | |
class URH_MatchSubsystem | Match Subsystem used for match API calls. |
struct FRH_MatchSearchParams | |
struct FRH_MatchSearchResult | Struct containint the results of a Session Browser search. |
Members
public
DECLARE_DYNAMIC_DELEGATE_ThreeParams
(FRH_OnMatchSearchCompleteDynamicDelegate,bool,bSuccess,const
FRH_MatchSearchResult
&,SearchResult,const
FRH_ErrorInfo
&,ErrorInfo)
public
DECLARE_DELEGATE_ThreeParams
(FRH_OnMatchSearchCompleteDelegate,bool,const
FRH_MatchSearchResult
&,const
FRH_ErrorInfo
&)
public
DECLARE_RH_DELEGATE_BLOCK
(FRH_OnMatchSearchCompleteDelegateBlock,FRH_OnMatchSearchCompleteDelegate,FRH_OnMatchSearchCompleteDynamicDelegate,bool,const
FRH_MatchSearchResult
&,const
FRH_ErrorInfo
&)
public
DECLARE_DYNAMIC_DELEGATE_ThreeParams
(FRH_OnMatchLookupCompleteDynamicDelegate,bool,bSuccess,const
FRHAPI_MatchWithPlayers
&,SearchResult,const
FRH_ErrorInfo
&,ErrorInfo)
public
DECLARE_DELEGATE_ThreeParams
(FRH_OnMatchLookupCompleteDelegate,bool,const
FRHAPI_MatchWithPlayers
&,const
FRH_ErrorInfo
&)
public
DECLARE_RH_DELEGATE_BLOCK
(FRH_OnMatchLookupCompleteDelegateBlock,FRH_OnMatchLookupCompleteDelegate,FRH_OnMatchLookupCompleteDynamicDelegate,bool,const
FRHAPI_MatchWithPlayers
&,const
FRH_ErrorInfo
&)
public
DECLARE_DYNAMIC_DELEGATE_ThreeParams
(FRH_OnMatchUpdateCompleteDynamicDelegate,bool,bSuccess,const
FRHAPI_MatchWithPlayers
&,Match,const
FRH_ErrorInfo
&,ErrorInfo)
public
DECLARE_DELEGATE_ThreeParams
(FRH_OnMatchUpdateCompleteDelegate,bool,const
FRHAPI_MatchWithPlayers
&,const
FRH_ErrorInfo
&)
public
DECLARE_RH_DELEGATE_BLOCK
(FRH_OnMatchUpdateCompleteDelegateBlock,FRH_OnMatchUpdateCompleteDelegate,FRH_OnMatchUpdateCompleteDynamicDelegate,bool,const
FRHAPI_MatchWithPlayers
&,const
FRH_ErrorInfo
&)
public
DECLARE_DYNAMIC_DELEGATE_ThreeParams
(FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,bSuccess,const
FRHAPI_MatchPlayerWithMatch
&,Match,const
FRH_ErrorInfo
&,ErrorInfo)
public
DECLARE_DELEGATE_ThreeParams
(FRH_OnMatchPlayerUpdateCompleteDelegate,bool,const
FRHAPI_MatchPlayerWithMatch
&,const
FRH_ErrorInfo
&)
public
DECLARE_RH_DELEGATE_BLOCK
(FRH_OnMatchPlayerUpdateCompleteDelegateBlock,FRH_OnMatchPlayerUpdateCompleteDelegate,FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,const
FRHAPI_MatchPlayerWithMatch
&,const
FRH_ErrorInfo
&)
class URH_MatchSubsystem
Match Subsystem used for match API calls.
Summary
Members | Descriptions |
---|---|
public bool bIgnoreCache | |
public bool const FRH_OnMatchLookupCompleteDynamicDelegate & Delegate | |
public virtual void Initialize () | Initialize the subsystem. |
public virtual void Deinitialize () | Safely tears down the subsystem. |
public virtual void SearchMatches (const FRH_MatchSearchParams & params,const FRH_OnMatchSearchCompleteDelegateBlock & Delegate) | Search for Matches. |
public inline void BLUEPRINT_SearchMatches (const FRH_MatchSearchParams & params,const FRH_OnMatchSearchCompleteDynamicDelegate & Delegate) | |
public virtual void GetMatchAsync (const FString & MatchId,bool bIgnoreCache,const FRH_OnMatchLookupCompleteDelegateBlock & Delegate) | Lookup a specific match. |
public UFUNCTION (BlueprintCallable,Category,meta) const | |
public inline bool GetMatch (const FString & MatchId, FRHAPI_MatchWithPlayers & OutMatch) | Lookup a specific match from the cache. |
public inline const TMap< FString, FRHAPI_MatchWithPlayers > & GetAllMatches () const | Get all matches from the cache. |
public inline void ClearMatchesCache () | Clear the match cache. |
public inline virtual const FString GetActiveMatchId () const | Get the active match ID. |
public inline virtual void SetActiveMatchId (const FString & MatchId) | Set the active match. |
public inline virtual bool HasActiveMatchId () const | Gets whether the active match exists. |
public inline virtual void ClearActiveMatchId () | Clears the active match. |
public virtual void CreateMatch (const FRHAPI_MatchRequest & Match,bool bSetActive,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate) | Create a match (POST) |
public inline void BLUEPRINT_CreateMatch (const FRHAPI_MatchRequest & Match,bool bSetActive,const FRH_OnMatchUpdateCompleteDynamicDelegate & Delegate) | |
public virtual void UpdateMatch (const FString & MatchId,const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate) | Update a match (PATCH) |
public inline void BLUEPRINT_UpdateMatch (const FString & MatchId,const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDynamicDelegate & Delegate) | |
public virtual void UpdateMatchPlayer (const FString & MatchId,const FGuid & PlayerId,const FRHAPI_MatchPlayerRequest & Player,const FRH_OnMatchPlayerUpdateCompleteDelegateBlock & Delegate) | Update a player in a match (PATCH w/ UPSERT) |
public inline void BLUEPRINT_UpdateMatchPlayer (const FString & MatchId,const FGuid & PlayerId,const FRHAPI_MatchPlayerRequest & Player,const FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate & Delegate) | |
protected TMap< FString, FRHAPI_MatchWithPlayers > MatchesCache | |
protected TOptional< FString > ActiveMatchId | The last match created with bSetActive = true, for ease of use. |
Members
public bool
bIgnoreCache
#### `public bool const FRH_OnMatchLookupCompleteDynamicDelegate & `[`Delegate`](#classURH__MatchSubsystem_1ad5da2a0291b9d3a8c6213f724938c587)
#### `public virtual void `[`Initialize`](#classURH__MatchSubsystem_1a6537937c7ca640348c2a564c1e17f3dc)`()`
Initialize the subsystem.
#### `public virtual void `[`Deinitialize`](#classURH__MatchSubsystem_1ab7136837d1d9bf468d9be59cc33463b7)`()`
Safely tears down the subsystem.
#### `public virtual void `[`SearchMatches`](#classURH__MatchSubsystem_1a23248c4305bc3aa2a6dfc4ef3aa93573)`(const `[`FRH_MatchSearchParams`](Match.md#structFRH__MatchSearchParams)` & params,const FRH_OnMatchSearchCompleteDelegateBlock & Delegate)`
Search for Matches.
Parameters
-
params
The search params to use for the given search. -
Delegate
Callback with the results of the search.
#### `public inline void `[`BLUEPRINT_SearchMatches`](#classURH__MatchSubsystem_1a3557ad010d1dc2a951c114699f4ab0a8)`(const `[`FRH_MatchSearchParams`](Match.md#structFRH__MatchSearchParams)` & params,const FRH_OnMatchSearchCompleteDynamicDelegate & Delegate)`
#### `public virtual void `[`GetMatchAsync`](#classURH__MatchSubsystem_1ac5d211f2d31af98c42373828fad8d86b)`(const FString & MatchId,bool bIgnoreCache,const FRH_OnMatchLookupCompleteDelegateBlock & Delegate)`
Lookup a specific match.
#### `public `[`UFUNCTION`](#classURH__MatchSubsystem_1ab0fddd0741eb99997cf1fb3948c7f815)`(BlueprintCallable,Category,meta) const`
#### `public inline bool `[`GetMatch`](#classURH__MatchSubsystem_1a893610997366c15dd53fa65e311ce1b8)`(const FString & MatchId,`[`FRHAPI_MatchWithPlayers`](models/RHAPI_MatchWithPlayers.md#structFRHAPI__MatchWithPlayers)` & OutMatch)`
Lookup a specific match from the cache.
#### `public inline const TMap< FString, `[`FRHAPI_MatchWithPlayers`](models/RHAPI_MatchWithPlayers.md#structFRHAPI__MatchWithPlayers)` > & `[`GetAllMatches`](#classURH__MatchSubsystem_1a051681ea68418192d99aaffe1264b258)`() const`
Get all matches from the cache.
#### `public inline void `[`ClearMatchesCache`](#classURH__MatchSubsystem_1abad303e288ec2208c57861a2c449b17b)`()`
Clear the match cache.
#### `public inline virtual const FString `[`GetActiveMatchId`](#classURH__MatchSubsystem_1ae1c52d179cfaab95d435d7e4c05b756c)`() const`
Get the active match ID.
#### `public inline virtual void `[`SetActiveMatchId`](#classURH__MatchSubsystem_1a763cfebaad6b8e6e884e8beda81b862e)`(const FString & MatchId)`
Set the active match.
#### `public inline virtual bool `[`HasActiveMatchId`](#classURH__MatchSubsystem_1ae991c30b43b4dec38b4ed4fd5421928a)`() const`
Gets whether the active match exists.
#### `public inline virtual void `[`ClearActiveMatchId`](#classURH__MatchSubsystem_1ae32c11a820e23c6048777b0c06435920)`()`
Clears the active match.
#### `public virtual void `[`CreateMatch`](#classURH__MatchSubsystem_1a88ae0bc379ecc672dff718686ca8887b)`(const `[`FRHAPI_MatchRequest`](models/RHAPI_MatchRequest.md#structFRHAPI__MatchRequest)` & Match,bool bSetActive,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate)`
Create a match (POST)
Parameters
-
Match
The match to create -
Players
The players to add to the match -
bSetActiveMatchId
Whether to set the match as the active match -
Delegate
Callback with the results of the match creation
#### `public inline void `[`BLUEPRINT_CreateMatch`](#classURH__MatchSubsystem_1ab410c3b3372a427d1ef2284d609c9fb8)`(const `[`FRHAPI_MatchRequest`](models/RHAPI_MatchRequest.md#structFRHAPI__MatchRequest)` & Match,bool bSetActive,const FRH_OnMatchUpdateCompleteDynamicDelegate & Delegate)`
#### `public virtual void `[`UpdateMatch`](#classURH__MatchSubsystem_1a3300d745ccd6c04a28a76895dfd7a6fd)`(const FString & MatchId,const `[`FRHAPI_MatchRequest`](models/RHAPI_MatchRequest.md#structFRHAPI__MatchRequest)` & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate)`
Update a match (PATCH)
Parameters
-
MatchId
The match to update -
Match
The match to update -
Delegate
Callback with the results of the match update
#### `public inline void `[`BLUEPRINT_UpdateMatch`](#classURH__MatchSubsystem_1ae8d39ccaca77e3cb780fcde4189caa10)`(const FString & MatchId,const `[`FRHAPI_MatchRequest`](models/RHAPI_MatchRequest.md#structFRHAPI__MatchRequest)` & Match,const FRH_OnMatchUpdateCompleteDynamicDelegate & Delegate)`
#### `public virtual void `[`UpdateMatchPlayer`](#classURH__MatchSubsystem_1a920e474a59dcdd94bc07bf58fc71f710)`(const FString & MatchId,const FGuid & PlayerId,const `[`FRHAPI_MatchPlayerRequest`](models/RHAPI_MatchPlayerRequest.md#structFRHAPI__MatchPlayerRequest)` & Player,const FRH_OnMatchPlayerUpdateCompleteDelegateBlock & Delegate)`
Update a player in a match (PATCH w/ UPSERT)
Parameters
-
MatchId
The match to update -
PlayerId
The player id to update -
Player
The player data request to update -
Delegate
Callback with the results of the player update
#### `public inline void `[`BLUEPRINT_UpdateMatchPlayer`](#classURH__MatchSubsystem_1a9fd3f47fb61af076c88c24e2402863ec)`(const FString & MatchId,const FGuid & PlayerId,const `[`FRHAPI_MatchPlayerRequest`](models/RHAPI_MatchPlayerRequest.md#structFRHAPI__MatchPlayerRequest)` & Player,const FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate & Delegate)`
#### `protected TMap< FString, `[`FRHAPI_MatchWithPlayers`](models/RHAPI_MatchWithPlayers.md#structFRHAPI__MatchWithPlayers)` > `[`MatchesCache`](#classURH__MatchSubsystem_1af6ae949b60bac5983489fe295a5b914a)
#### `protected TOptional< FString > `[`ActiveMatchId`](#classURH__MatchSubsystem_1aa6948be8c609b94e612435f7b0767e7b)
The last match created with bSetActive = true, for ease of use.
## struct `FRH_MatchSearchParams`
Summary
Members | Descriptions |
---|---|
public int32 PageSize | The maximum number of elements to be returned per call, ignored if 0. |
public FString InstanceId | The instance id to search on, ignored if empty. |
public FString AllocationId | The allocation id to search on, ignored if empty. |
public FString SessionId | The session id to search on, ignored if empty. |
public FString HostPlayerUuid | The host player id to search on, ignored if empty. |
public FString RegionId | The region id to search on, ignored if empty. |
public FString PlayerUuid | The participant player id to search on, ignored if empty. |
public FString Cursor | Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration. |
public inline FRH_MatchSearchParams () | |
public inline FString GetDescription () const | Returns summary of params for tooling/logging. |
public inline RallyHereAPI::FRequest_GetMatches ToAPIRequest (FAuthContextPtr AuthContext) const | Converts the search params to an API request. |
Members
public int32
PageSize
The maximum number of elements to be returned per call, ignored if 0.
#### `public FString `[`InstanceId`](#structFRH__MatchSearchParams_1a3b8290d856ba2e6a36a18803b17fa3d4)
The instance id to search on, ignored if empty.
#### `public FString `[`AllocationId`](#structFRH__MatchSearchParams_1afab9d86f6410284ea4ba2e83d58d1b6b)
The allocation id to search on, ignored if empty.
#### `public FString `[`SessionId`](#structFRH__MatchSearchParams_1a42a4fd664ccf349ebb36eaec862c9133)
The session id to search on, ignored if empty.
#### `public FString `[`HostPlayerUuid`](#structFRH__MatchSearchParams_1a067924a1c1a542270163b0ba5b9ca541)
The host player id to search on, ignored if empty.
#### `public FString `[`RegionId`](#structFRH__MatchSearchParams_1a8874651d0cadc4ed51898c0987be697a)
The region id to search on, ignored if empty.
#### `public FString `[`PlayerUuid`](#structFRH__MatchSearchParams_1a08a9351cd2ac8f2483e0e49c44b286f1)
The participant player id to search on, ignored if empty.
#### `public FString `[`Cursor`](#structFRH__MatchSearchParams_1a2b3af805c98580faddaa3495131c2eb6)
Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration.
#### `public inline `[`FRH_MatchSearchParams`](#structFRH__MatchSearchParams_1a703357c85c089fd0675e83eaa69ca12c)`()`
#### `public inline FString `[`GetDescription`](#structFRH__MatchSearchParams_1a682aada2005d21246404e340217c4229)`() const`
Returns summary of params for tooling/logging.
#### `public inline RallyHereAPI::FRequest_GetMatches `[`ToAPIRequest`](#structFRH__MatchSearchParams_1ad113cf34700d56985d289eebde6e4218)`(FAuthContextPtr AuthContext) const`
Converts the search params to an API request.
## struct `FRH_MatchSearchResult`
Struct containint the results of a Session Browser search.
Summary
Members | Descriptions |
---|---|
public FRH_MatchSearchParams SearchParams | The paramaters used to make the search. |
public TArray< FRHAPI_MatchWithPlayers > Matches | Array of match results found by the search. |
public FString NextPageCursor | Cursor to use to request the next page of data. |
public inline FString GetDescription () const | Returns summary of search results for tooling/logging. |
public inline FRH_MatchSearchResult () |
Members
public
FRH_MatchSearchParams
SearchParams
The paramaters used to make the search.
#### `public TArray< `[`FRHAPI_MatchWithPlayers`](models/RHAPI_MatchWithPlayers.md#structFRHAPI__MatchWithPlayers)` > `[`Matches`](#structFRH__MatchSearchResult_1a65d812c0001cff68673e346aa6a92668)
Array of match results found by the search.
#### `public FString `[`NextPageCursor`](#structFRH__MatchSearchResult_1a9af3fac4e20d12feb4851116cbfbc8f2)
Cursor to use to request the next page of data.
#### `public inline FString `[`GetDescription`](#structFRH__MatchSearchResult_1a3f3d4d70bda7f129f5d84ed5a695a309)`() const`
Returns summary of search results for tooling/logging.
#### `public inline `[`FRH_MatchSearchResult`](#structFRH__MatchSearchResult_1a44c964332575fef90c49b48a0cb0b6d1)`()`