Skip to content

RHAPI_MatchMakingTemplateGroupV2

Summary

MembersDescriptions
struct FRHAPI_MatchMakingTemplateGroupV2A collection of MatchMakingTemplates that may be used when a session enters a queue. The first template that satisfies the necessary rules will be used.

struct FRHAPI_MatchMakingTemplateGroupV2

struct FRHAPI_MatchMakingTemplateGroupV2
: public FRHAPI_Model

A collection of MatchMakingTemplates that may be used when a session enters a queue. The first template that satisfies the necessary rules will be used.

Summary

MembersDescriptions
public FGuid MatchMakingTemplateGroupIdID for this set of potential matchmaking templates.
public TArray< FRHAPI_MatchMakingTemplateV2>TemplateOptionsList 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.
public TSet< int32 > RequiredItemIds_OptionalSet of all the item ids that are required to validate every rule contained in this template group.
public bool RequiredItemIds_IsSettrue if RequiredItemIds_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FGuid & GetMatchMakingTemplateGroupId()Gets the value of MatchMakingTemplateGroupId.
public inline const FGuid & GetMatchMakingTemplateGroupId() constGets the value of MatchMakingTemplateGroupId.
public inline void SetMatchMakingTemplateGroupId(FGuid NewValue)Sets the value of MatchMakingTemplateGroupId.
public inline TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions()Gets the value of TemplateOptions.
public inline const TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions() constGets the value of TemplateOptions.
public inline void SetTemplateOptions(TArray< FRHAPI_MatchMakingTemplateV2 > NewValue)Sets the value of TemplateOptions.
public inline TSet< int32 > & GetRequiredItemIds()Gets the value of RequiredItemIds_Optional, regardless of it having been set.
public inline const TSet< int32 > & GetRequiredItemIds() constGets the value of RequiredItemIds_Optional, regardless of it having been set.
public inline const TSet< int32 > & GetRequiredItemIds(const TSet< int32 > & DefaultValue) constGets the value of RequiredItemIds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRequiredItemIds(TSet< int32 > & OutValue) constFills OutValue with the value of RequiredItemIds_Optional and returns true if it has been set, otherwise returns false.
public inline TSet< int32 > * GetRequiredItemIdsOrNull()Returns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr.
public inline const TSet< int32 > * GetRequiredItemIdsOrNull() constReturns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRequiredItemIds(TSet< int32 > NewValue)Sets the value of RequiredItemIds_Optional and also sets RequiredItemIds_IsSet to true.
public inline void ClearRequiredItemIds()Clears the value of RequiredItemIds_Optional and sets RequiredItemIds_IsSet to false.

Members

public FGuid MatchMakingTemplateGroupId

ID for this set of potential matchmaking templates.


#### `public TArray< `[`FRHAPI_MatchMakingTemplateV2`](RHAPI_MatchMakingTemplateV2.md#structFRHAPI__MatchMakingTemplateV2)` > `[`TemplateOptions`](#structFRHAPI__MatchMakingTemplateGroupV2_1a5f061f6b1728e5e91acbc50c8d0db1cb)

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.


#### `public TSet< int32 > `[`RequiredItemIds_Optional`](#structFRHAPI__MatchMakingTemplateGroupV2_1a679dffab35167122874604eb826703bd)

Set of all the item ids that are required to validate every rule contained in this template group.


#### `public bool `[`RequiredItemIds_IsSet`](#structFRHAPI__MatchMakingTemplateGroupV2_1acf8e308da6fcec42032dd998a15284c3)

true if RequiredItemIds_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__MatchMakingTemplateGroupV2_1aa82d7762c65e34e906c1fa2af0a15b80)`(const TSharedPtr< FJsonValue > & JsonValue)`

Fills this object with data from the passed in JSON.

Parameters

  • JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.


#### `public virtual void `[`WriteJson`](#structFRHAPI__MatchMakingTemplateGroupV2_1ae72915da0979e90493d2d2f47c565c9d)`(TSharedRef< TJsonWriter<>> & Writer) const`

Writes the data from this object into the specified JSON Writer stream.

Parameters

  • Writer JSON Writer stream to push .

#### `public inline FGuid & `[`GetMatchMakingTemplateGroupId`](#structFRHAPI__MatchMakingTemplateGroupV2_1a01e8f3d3b4d2a717e193aed171c0d40c)`()`

Gets the value of MatchMakingTemplateGroupId.


#### `public inline const FGuid & `[`GetMatchMakingTemplateGroupId`](#structFRHAPI__MatchMakingTemplateGroupV2_1aa0748064b7da8fe6a9be9e0d7c02c438)`() const`

Gets the value of MatchMakingTemplateGroupId.


#### `public inline void `[`SetMatchMakingTemplateGroupId`](#structFRHAPI__MatchMakingTemplateGroupV2_1a1c38f3b83697063e3fe3a93307e26543)`(FGuid NewValue)`

Sets the value of MatchMakingTemplateGroupId.


#### `public inline TArray< `[`FRHAPI_MatchMakingTemplateV2`](RHAPI_MatchMakingTemplateV2.md#structFRHAPI__MatchMakingTemplateV2)` > & `[`GetTemplateOptions`](#structFRHAPI__MatchMakingTemplateGroupV2_1ae7ac396d71d72df8dfd497619e5b5e16)`()`

Gets the value of TemplateOptions.


#### `public inline const TArray< `[`FRHAPI_MatchMakingTemplateV2`](RHAPI_MatchMakingTemplateV2.md#structFRHAPI__MatchMakingTemplateV2)` > & `[`GetTemplateOptions`](#structFRHAPI__MatchMakingTemplateGroupV2_1a78820cdf045398fec485c4ac12d50316)`() const`

Gets the value of TemplateOptions.


#### `public inline void `[`SetTemplateOptions`](#structFRHAPI__MatchMakingTemplateGroupV2_1acdfe22412b41577fa5e2761d489693fd)`(TArray< `[`FRHAPI_MatchMakingTemplateV2`](RHAPI_MatchMakingTemplateV2.md#structFRHAPI__MatchMakingTemplateV2)` > NewValue)`

Sets the value of TemplateOptions.


#### `public inline TSet< int32 > & `[`GetRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1aae74151bbae2476c5dd9e69b5c8619c2)`()`

Gets the value of RequiredItemIds_Optional, regardless of it having been set.


#### `public inline const TSet< int32 > & `[`GetRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1ad7c46a9636d5fd68fae7f62341db2731)`() const`

Gets the value of RequiredItemIds_Optional, regardless of it having been set.


#### `public inline const TSet< int32 > & `[`GetRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1a29b9c106297cec5cc94f9bf5d4b8c7cd)`(const TSet< int32 > & DefaultValue) const`

Gets the value of RequiredItemIds_Optional, if it has been set, otherwise it returns DefaultValue.


#### `public inline bool `[`GetRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1a2502c85366c9867bc828b58e75b4771b)`(TSet< int32 > & OutValue) const`

Fills OutValue with the value of RequiredItemIds_Optional and returns true if it has been set, otherwise returns false.


#### `public inline TSet< int32 > * `[`GetRequiredItemIdsOrNull`](#structFRHAPI__MatchMakingTemplateGroupV2_1a2cc6f2377ab9ba029a272d88bb50b483)`()`

Returns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr.


#### `public inline const TSet< int32 > * `[`GetRequiredItemIdsOrNull`](#structFRHAPI__MatchMakingTemplateGroupV2_1a12ee516297ac458faf9eda375bf3e138)`() const`

Returns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr.


#### `public inline void `[`SetRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1a1619a5f41fcd839b5ca83adedae56979)`(TSet< int32 > NewValue)`

Sets the value of RequiredItemIds_Optional and also sets RequiredItemIds_IsSet to true.


#### `public inline void `[`ClearRequiredItemIds`](#structFRHAPI__MatchMakingTemplateGroupV2_1a2cfe134d15ff3ce519d7be4a1a681055)`()`

Clears the value of RequiredItemIds_Optional and sets RequiredItemIds_IsSet to false.