RHAPI_QueueConfig
Summary
Members | Descriptions |
---|---|
struct FRHAPI_QueueConfig | DEPRECATED - V1 Configuration about a specific queue. |
struct FRHAPI_QueueConfig
DEPRECATED - 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`](#structFRHAPI__QueueConfig_1aee82d6e680e6bf1dfefc37cd1f11859e)
Flag for whether or not the queue is active, and can be joined or sessions created from it.
#### `public int32 `[`RankingType`](#structFRHAPI__QueueConfig_1aacef7831b79c1f836a1e8ca2d7828e4c)
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`](#structFRHAPI__QueueConfig_1a23995dba128a09c4fd3fd5a5f938eab1)
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`](#structFRHAPI__QueueConfig_1a9adb4270b953ff71083bce03f44859f9)
The maximum number of players that can be on each team.
#### `public int32 `[`MinPlayersPerSide`](#structFRHAPI__QueueConfig_1a14bbcf2815246b9cdd65bca56301fb86)
The minimum number of players that can be on each team.
#### `public int32 `[`MaxQueueGroupSize`](#structFRHAPI__QueueConfig_1aaa59215391fb9cc4e64f60de6a63bfe4)
The maximum size of a group that can join this queue.
#### `public FGuid `[`MatchMakingTemplateGroupId`](#structFRHAPI__QueueConfig_1accaccf9098ad83a60810fd4579e6c9ad)
ID for which group of matchmaking templates/rules will be used when joining this queue.
#### `public virtual bool `[`FromJson`](#structFRHAPI__QueueConfig_1afa46d1b47a820d16fb78e603f8e97056)`(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__QueueConfig_1a6bfcc693d3b707e273c68ffced461c9f)`(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 FString & `[`GetQueueId`](#structFRHAPI__QueueConfig_1afbb7596094bb006f2709ede4d235583a)`()`
Gets the value of QueueId.
#### `public inline const FString & `[`GetQueueId`](#structFRHAPI__QueueConfig_1a7531a7aa89e0f4f15bab9d171395b721)`() const`
Gets the value of QueueId.
#### `public inline void `[`SetQueueId`](#structFRHAPI__QueueConfig_1ad98691951173499c6da05206f1819463)`(FString NewValue)`
Sets the value of QueueId.
#### `public inline bool & `[`GetActive`](#structFRHAPI__QueueConfig_1aa2f41600e5497f9f954f96778cbe90bd)`()`
Gets the value of Active.
#### `public inline const bool & `[`GetActive`](#structFRHAPI__QueueConfig_1aa77d550684015caf80bac335fbe5b691)`() const`
Gets the value of Active.
#### `public inline void `[`SetActive`](#structFRHAPI__QueueConfig_1a8d7d827d893ff75f7bc597ba259c854a)`(bool NewValue)`
Sets the value of Active.
#### `public inline bool `[`IsActiveDefaultValue`](#structFRHAPI__QueueConfig_1a1cf37082fbdcae269056c583c43ac884)`() const`
Returns true if Active matches the default value.
#### `public inline void `[`SetActiveToDefault`](#structFRHAPI__QueueConfig_1a10f6ccf4def627103f7f6805f4af2c1b)`()`
Sets the value of Active to its default
#### `public inline int32 & `[`GetRankingType`](#structFRHAPI__QueueConfig_1a86e0e4b34a8ec1ea88d6464548ee7ed5)`()`
Gets the value of RankingType.
#### `public inline const int32 & `[`GetRankingType`](#structFRHAPI__QueueConfig_1a3fa024ebcc799d27c37be9b291d51426)`() const`
Gets the value of RankingType.
#### `public inline void `[`SetRankingType`](#structFRHAPI__QueueConfig_1a70de6dc3f45bbc43b73d44d2cba6540f)`(int32 NewValue)`
Sets the value of RankingType.
#### `public inline bool `[`IsRankingTypeDefaultValue`](#structFRHAPI__QueueConfig_1a3ccc8262e40ba2f0e5704a71399304aa)`() const`
Returns true if RankingType matches the default value.
#### `public inline void `[`SetRankingTypeToDefault`](#structFRHAPI__QueueConfig_1a7b090f5d4ac4e8a648c77fde033751d1)`()`
Sets the value of RankingType to its default
#### `public inline int32 & `[`GetNumSides`](#structFRHAPI__QueueConfig_1a97000ec0ff3107b6ed9a178e01ac31c4)`()`
Gets the value of NumSides.
#### `public inline const int32 & `[`GetNumSides`](#structFRHAPI__QueueConfig_1ac7e6706e2ec1846709e75f396c3472f4)`() const`
Gets the value of NumSides.
#### `public inline void `[`SetNumSides`](#structFRHAPI__QueueConfig_1ac718e6d395cf89c575c1fe10d369af31)`(int32 NewValue)`
Sets the value of NumSides.
#### `public inline bool `[`IsNumSidesDefaultValue`](#structFRHAPI__QueueConfig_1aede076c88291f8381088e21b0b80f229)`() const`
Returns true if NumSides matches the default value.
#### `public inline void `[`SetNumSidesToDefault`](#structFRHAPI__QueueConfig_1a6572ad59ee9f3952109271c675fb11b0)`()`
Sets the value of NumSides to its default
#### `public inline int32 & `[`GetMaxPlayersPerSide`](#structFRHAPI__QueueConfig_1a6c6cf45bcc73d4e3bd29f88da124d9d5)`()`
Gets the value of MaxPlayersPerSide.
#### `public inline const int32 & `[`GetMaxPlayersPerSide`](#structFRHAPI__QueueConfig_1ab89a34440f9e9e7206a303267d9b3fdd)`() const`
Gets the value of MaxPlayersPerSide.
#### `public inline void `[`SetMaxPlayersPerSide`](#structFRHAPI__QueueConfig_1a8f5f1cc8fd9ae370a7b058a18f683e97)`(int32 NewValue)`
Sets the value of MaxPlayersPerSide.
#### `public inline bool `[`IsMaxPlayersPerSideDefaultValue`](#structFRHAPI__QueueConfig_1a09d2693ff64135cdb7e1123ecf4d091d)`() const`
Returns true if MaxPlayersPerSide matches the default value.
#### `public inline void `[`SetMaxPlayersPerSideToDefault`](#structFRHAPI__QueueConfig_1a4a883842fa1e6aef71553d510cc0a787)`()`
Sets the value of MaxPlayersPerSide to its default
#### `public inline int32 & `[`GetMinPlayersPerSide`](#structFRHAPI__QueueConfig_1a48329c418e000d978319bfe144d690be)`()`
Gets the value of MinPlayersPerSide.
#### `public inline const int32 & `[`GetMinPlayersPerSide`](#structFRHAPI__QueueConfig_1a60c1f52d98a85a00d15471b2b84b88e6)`() const`
Gets the value of MinPlayersPerSide.
#### `public inline void `[`SetMinPlayersPerSide`](#structFRHAPI__QueueConfig_1a2eb75c7505266544585d9879bd9175b5)`(int32 NewValue)`
Sets the value of MinPlayersPerSide.
#### `public inline bool `[`IsMinPlayersPerSideDefaultValue`](#structFRHAPI__QueueConfig_1a47b44d176fa5abb7489d797adb8efd65)`() const`
Returns true if MinPlayersPerSide matches the default value.
#### `public inline void `[`SetMinPlayersPerSideToDefault`](#structFRHAPI__QueueConfig_1a6237a800c6262bb4ed9a7701efadd93c)`()`
Sets the value of MinPlayersPerSide to its default
#### `public inline int32 & `[`GetMaxQueueGroupSize`](#structFRHAPI__QueueConfig_1a3a5701576906e50a1364ea01a61b8fe5)`()`
Gets the value of MaxQueueGroupSize.
#### `public inline const int32 & `[`GetMaxQueueGroupSize`](#structFRHAPI__QueueConfig_1a630f29c3dd01db55fc532ae31b4b59eb)`() const`
Gets the value of MaxQueueGroupSize.
#### `public inline void `[`SetMaxQueueGroupSize`](#structFRHAPI__QueueConfig_1a2aa70fb1002de69cecd824fc3dff9a3d)`(int32 NewValue)`
Sets the value of MaxQueueGroupSize.
#### `public inline bool `[`IsMaxQueueGroupSizeDefaultValue`](#structFRHAPI__QueueConfig_1a250bed73ccc2af55989c363cb355a1c1)`() const`
Returns true if MaxQueueGroupSize matches the default value.
#### `public inline void `[`SetMaxQueueGroupSizeToDefault`](#structFRHAPI__QueueConfig_1a2fbb47f7fe5ff059458787e1e907153e)`()`
Sets the value of MaxQueueGroupSize to its default
#### `public inline FGuid & `[`GetMatchMakingTemplateGroupId`](#structFRHAPI__QueueConfig_1abb31141c8116720d5103bea41c9ea63b)`()`
Gets the value of MatchMakingTemplateGroupId.
#### `public inline const FGuid & `[`GetMatchMakingTemplateGroupId`](#structFRHAPI__QueueConfig_1ac6f164a4fe9089bed47aa1833809a008)`() const`
Gets the value of MatchMakingTemplateGroupId.
#### `public inline void `[`SetMatchMakingTemplateGroupId`](#structFRHAPI__QueueConfig_1a80b6c3ed4b3759e23b6c8f7a319e58e6)`(FGuid NewValue)`
Sets the value of MatchMakingTemplateGroupId.