RHAPI_QueueConfig
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_QueueConfig | DEPRECATED - V1 Configuration about a specific queue. |
struct FRHAPI_QueueConfig
struct FRHAPI_QueueConfig
: public FRHAPI_ModelDEPRECATED - V1 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 RankingType | Which rank this queue should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example) |
public int32 NumSides | The number of sides a game in this queue will have (2 in a 1v1 and 3 in a 1v1v1 for example. |
public int32 MaxPlayersPerSide | The maximum number of players that can be on each team. |
public int32 MinPlayersPerSide | The minimum number of players that can be on each team. |
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 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 & GetRankingType() | Gets the value of RankingType. |
public inline const int32 & GetRankingType() const | Gets the value of RankingType. |
public inline void SetRankingType(int32 NewValue) | Sets the value of RankingType. |
public inline bool IsRankingTypeDefaultValue() const | Returns true if RankingType matches the default value. |
public inline void SetRankingTypeToDefault() | Sets the value of RankingType to its default |
public inline int32 & GetNumSides() | Gets the value of NumSides. |
public inline const int32 & GetNumSides() const | Gets the value of NumSides. |
public inline void SetNumSides(int32 NewValue) | Sets the value of NumSides. |
public inline bool IsNumSidesDefaultValue() const | Returns true if NumSides matches the default value. |
public inline void SetNumSidesToDefault() | Sets the value of NumSides to its default |
public inline int32 & GetMaxPlayersPerSide() | Gets the value of MaxPlayersPerSide. |
public inline const int32 & GetMaxPlayersPerSide() const | Gets the value of MaxPlayersPerSide. |
public inline void SetMaxPlayersPerSide(int32 NewValue) | Sets the value of MaxPlayersPerSide. |
public inline bool IsMaxPlayersPerSideDefaultValue() const | Returns true if MaxPlayersPerSide matches the default value. |
public inline void SetMaxPlayersPerSideToDefault() | Sets the value of MaxPlayersPerSide to its default |
public inline int32 & GetMinPlayersPerSide() | Gets the value of MinPlayersPerSide. |
public inline const int32 & GetMinPlayersPerSide() const | Gets the value of MinPlayersPerSide. |
public inline void SetMinPlayersPerSide(int32 NewValue) | Sets the value of MinPlayersPerSide. |
public inline bool IsMinPlayersPerSideDefaultValue() const | Returns true if MinPlayersPerSide matches the default value. |
public inline void SetMinPlayersPerSideToDefault() | Sets the value of MinPlayersPerSide 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. |
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 RankingType
Which rank this queue should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example)
public int32 NumSides
The number of sides a game in this queue will have (2 in a 1v1 and 3 in a 1v1v1 for example.
public int32 MaxPlayersPerSide
The maximum number of players that can be on each team.
public int32 MinPlayersPerSide
The minimum number of players that can be on each team.
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 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 & GetRankingType()
Gets the value of RankingType.
public inline const int32 & GetRankingType() const
Gets the value of RankingType.
public inline void SetRankingType(int32 NewValue)
Sets the value of RankingType.
public inline bool IsRankingTypeDefaultValue() const
Returns true if RankingType matches the default value.
public inline void SetRankingTypeToDefault()
Sets the value of RankingType to its default
public inline int32 & GetNumSides()
Gets the value of NumSides.
public inline const int32 & GetNumSides() const
Gets the value of NumSides.
public inline void SetNumSides(int32 NewValue)
Sets the value of NumSides.
public inline bool IsNumSidesDefaultValue() const
Returns true if NumSides matches the default value.
public inline void SetNumSidesToDefault()
Sets the value of NumSides to its default
public inline int32 & GetMaxPlayersPerSide()
Gets the value of MaxPlayersPerSide.
public inline const int32 & GetMaxPlayersPerSide() const
Gets the value of MaxPlayersPerSide.
public inline void SetMaxPlayersPerSide(int32 NewValue)
Sets the value of MaxPlayersPerSide.
public inline bool IsMaxPlayersPerSideDefaultValue() const
Returns true if MaxPlayersPerSide matches the default value.
public inline void SetMaxPlayersPerSideToDefault()
Sets the value of MaxPlayersPerSide to its default
public inline int32 & GetMinPlayersPerSide()
Gets the value of MinPlayersPerSide.
public inline const int32 & GetMinPlayersPerSide() const
Gets the value of MinPlayersPerSide.
public inline void SetMinPlayersPerSide(int32 NewValue)
Sets the value of MinPlayersPerSide.
public inline bool IsMinPlayersPerSideDefaultValue() const
Returns true if MinPlayersPerSide matches the default value.
public inline void SetMinPlayersPerSideToDefault()
Sets the value of MinPlayersPerSide 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.