RHAPI_QueueConfigV2
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_QueueConfigV2 | V2 Configuration about a specific queue. |
struct FRHAPI_QueueConfigV2
struct FRHAPI_QueueConfigV2
: public FRHAPI_ModelV2 Configuration about a specific queue.
Summary
| Members | Descriptions |
|---|---|
public FString QueueId | ID to uniquely identify this queue. |
public bool Active | Flag for whether or not the queue is active, and can be joined or sessions created from it. |
public int32 MaxQueueGroupSize | The maximum size of a group that can join this queue. |
public FGuid MatchMakingTemplateGroupId | ID for which group of matchmaking templates/rules will be used when joining this queue. |
public TMap< FString, FString > LegacyConfig_Optional | Legacy config to help migrate clients. |
public bool LegacyConfig_IsSet | true if LegacyConfig_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 FString & GetQueueId() | Gets the value of QueueId. |
public inline const FString & GetQueueId() const | Gets the value of QueueId. |
public inline void SetQueueId(FString NewValue) | Sets the value of QueueId. |
public inline bool & GetActive() | Gets the value of Active. |
public inline const bool & GetActive() const | Gets the value of Active. |
public inline void SetActive(bool NewValue) | Sets the value of Active. |
public inline bool IsActiveDefaultValue() const | Returns true if Active matches the default value. |
public inline void SetActiveToDefault() | Sets the value of Active to its default |
public inline int32 & GetMaxQueueGroupSize() | Gets the value of MaxQueueGroupSize. |
public inline const int32 & GetMaxQueueGroupSize() const | Gets the value of MaxQueueGroupSize. |
public inline void SetMaxQueueGroupSize(int32 NewValue) | Sets the value of MaxQueueGroupSize. |
public inline bool IsMaxQueueGroupSizeDefaultValue() const | Returns true if MaxQueueGroupSize matches the default value. |
public inline void SetMaxQueueGroupSizeToDefault() | Sets the value of MaxQueueGroupSize to its default |
public inline FGuid & GetMatchMakingTemplateGroupId() | Gets the value of MatchMakingTemplateGroupId. |
public inline const FGuid & GetMatchMakingTemplateGroupId() const | Gets the value of MatchMakingTemplateGroupId. |
public inline void SetMatchMakingTemplateGroupId(FGuid NewValue) | Sets the value of MatchMakingTemplateGroupId. |
public inline TMap< FString, FString > & GetLegacyConfig() | Gets the value of LegacyConfig_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetLegacyConfig() const | Gets the value of LegacyConfig_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetLegacyConfig(const TMap< FString, FString > & DefaultValue) const | Gets the value of LegacyConfig_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLegacyConfig(TMap< FString, FString > & OutValue) const | Fills OutValue with the value of LegacyConfig_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetLegacyConfigOrNull() | Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetLegacyConfigOrNull() const | Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLegacyConfig(TMap< FString, FString > NewValue) | Sets the value of LegacyConfig_Optional and also sets LegacyConfig_IsSet to true. |
public inline void ClearLegacyConfig() | Clears the value of LegacyConfig_Optional and sets LegacyConfig_IsSet to false. |
Members
public FString QueueId
ID to uniquely identify this queue.
public bool Active
Flag for whether or not the queue is active, and can be joined or sessions created from it.
public int32 MaxQueueGroupSize
The maximum size of a group that can join this queue.
public FGuid MatchMakingTemplateGroupId
ID for which group of matchmaking templates/rules will be used when joining this queue.
public TMap< FString, FString > LegacyConfig_Optional
Legacy config to help migrate clients.
public bool LegacyConfig_IsSet
true if LegacyConfig_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 FString & GetQueueId()
Gets the value of QueueId.
public inline const FString & GetQueueId() const
Gets the value of QueueId.
public inline void SetQueueId(FString NewValue)
Sets the value of QueueId.
public inline bool & GetActive()
Gets the value of Active.
public inline const bool & GetActive() const
Gets the value of Active.
public inline void SetActive(bool NewValue)
Sets the value of Active.
public inline bool IsActiveDefaultValue() const
Returns true if Active matches the default value.
public inline void SetActiveToDefault()
Sets the value of Active to its default
public inline int32 & GetMaxQueueGroupSize()
Gets the value of MaxQueueGroupSize.
public inline const int32 & GetMaxQueueGroupSize() const
Gets the value of MaxQueueGroupSize.
public inline void SetMaxQueueGroupSize(int32 NewValue)
Sets the value of MaxQueueGroupSize.
public inline bool IsMaxQueueGroupSizeDefaultValue() const
Returns true if MaxQueueGroupSize matches the default value.
public inline void SetMaxQueueGroupSizeToDefault()
Sets the value of MaxQueueGroupSize to its default
public inline FGuid & GetMatchMakingTemplateGroupId()
Gets the value of MatchMakingTemplateGroupId.
public inline const FGuid & GetMatchMakingTemplateGroupId() const
Gets the value of MatchMakingTemplateGroupId.
public inline void SetMatchMakingTemplateGroupId(FGuid NewValue)
Sets the value of MatchMakingTemplateGroupId.
public inline TMap< FString, FString > & GetLegacyConfig()
Gets the value of LegacyConfig_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetLegacyConfig() const
Gets the value of LegacyConfig_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetLegacyConfig(const TMap< FString, FString > & DefaultValue) const
Gets the value of LegacyConfig_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLegacyConfig(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of LegacyConfig_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetLegacyConfigOrNull()
Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetLegacyConfigOrNull() const
Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLegacyConfig(TMap< FString, FString > NewValue)
Sets the value of LegacyConfig_Optional and also sets LegacyConfig_IsSet to true.
public inline void ClearLegacyConfig()
Clears the value of LegacyConfig_Optional and sets LegacyConfig_IsSet to false.