RHAPI_MatchMakingTemplateGroupV2
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_MatchMakingTemplateGroupV2 | 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. |
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
| Members | Descriptions |
|---|---|
public FGuid TemplateGroupId | ID for this set of potential matchmaking templates. |
public TArray< FRHAPI_MatchMakingTemplateV2>TemplateOptions | 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 | Set of all the item ids that are required to validate every rule contained in this template group. |
public bool RequiredItemIds_IsSet | true 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) const | Writes the data from this object into the specified JSON Writer stream. |
public inline FGuid & GetTemplateGroupId() | Gets the value of TemplateGroupId. |
public inline const FGuid & GetTemplateGroupId() const | Gets the value of TemplateGroupId. |
public inline void SetTemplateGroupId(FGuid NewValue) | Sets the value of TemplateGroupId. |
public inline TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions() | Gets the value of TemplateOptions. |
public inline const TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions() const | Gets 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() const | Gets the value of RequiredItemIds_Optional, regardless of it having been set. |
public inline const TSet< int32 > & GetRequiredItemIds(const TSet< int32 > & DefaultValue) const | Gets the value of RequiredItemIds_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetRequiredItemIds(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() | Returns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr. |
public inline const TSet< int32 > * GetRequiredItemIdsOrNull() const | Returns 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 TemplateGroupId
ID for this set of potential matchmaking templates.
public TArray< FRHAPI_MatchMakingTemplateV2>TemplateOptions
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
Set of all the item ids that are required to validate every rule contained in this template group.
public bool RequiredItemIds_IsSet
true 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.
Parameters
JsonValueData from the API call.
Returns
true if parsing of the JSON data was successful.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
public inline FGuid & GetTemplateGroupId()
Gets the value of TemplateGroupId.
public inline const FGuid & GetTemplateGroupId() const
Gets the value of TemplateGroupId.
public inline void SetTemplateGroupId(FGuid NewValue)
Sets the value of TemplateGroupId.
public inline TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions()
Gets the value of TemplateOptions.
public inline const TArray< FRHAPI_MatchMakingTemplateV2> &GetTemplateOptions() const
Gets 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() const
Gets the value of RequiredItemIds_Optional, regardless of it having been set.
public inline const TSet< int32 > & GetRequiredItemIds(const TSet< int32 > & DefaultValue) const
Gets the value of RequiredItemIds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRequiredItemIds(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()
Returns a pointer to RequiredItemIds_Optional, if it has been set, otherwise returns nullptr.
public inline const TSet< int32 > * GetRequiredItemIdsOrNull() const
Returns 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.