Skip to content

RHAPI_RankConfig

Summary

MembersDescriptions
struct FRHAPI_RankConfigDEPRECATED Configuration about a specific rank type.

struct FRHAPI_RankConfig

struct FRHAPI_RankConfig
: public FRHAPI_Model

DEPRECATED Configuration about a specific rank type.

Summary

MembersDescriptions
public int32 RankIdID for this rank type.
public float DefaultRankThe default rank value for this rank id. Will be used when players do not have any rank history.
public float DefaultVarianceThe default skill variance for this rank id. Will be used when players do not have any rank history.
public float MaxRankAllowedThe maximum rank value achievable. Any attempts to update a rank value to be higher than this get clamped to the maximum.
public float MinRankAllowedThe minimum rank value achievable. Any attempts to update a rank value to be lower than this get clamped to the minimum.
public float MinVarianceAllowedThe minimum skill variance allowed. Any attempts to update variance to be lower than this get clamped to the minimum.
public float TrueskillBeta_OptionalThe distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default variance.
public bool TrueskillBeta_IsSettrue if TrueskillBeta_Optional has been set to a value
public float TrueskillTau_OptionalFactor that determines how quickly a player’s variance is adjusted. A larger tau will result in more volatile in ranks. Recommended value is is (default_variance * .01)
public bool TrueskillTau_IsSettrue if TrueskillTau_Optional has been set to a value
public float TrueskillDrawProbability_OptionalThe percent probability of a draw occuring in the game. Must be in [0, 1)
public bool TrueskillDrawProbability_IsSettrue if TrueskillDrawProbability_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 int32 & GetRankId()Gets the value of RankId.
public inline const int32 & GetRankId() constGets the value of RankId.
public inline void SetRankId(int32 NewValue)Sets the value of RankId.
public inline bool IsRankIdDefaultValue() constReturns true if RankId matches the default value.
public inline void SetRankIdToDefault()Sets the value of RankId to its default
public inline float & GetDefaultRank()Gets the value of DefaultRank.
public inline const float & GetDefaultRank() constGets the value of DefaultRank.
public inline void SetDefaultRank(float NewValue)Sets the value of DefaultRank.
public inline float & GetDefaultVariance()Gets the value of DefaultVariance.
public inline const float & GetDefaultVariance() constGets the value of DefaultVariance.
public inline void SetDefaultVariance(float NewValue)Sets the value of DefaultVariance.
public inline float & GetMaxRankAllowed()Gets the value of MaxRankAllowed.
public inline const float & GetMaxRankAllowed() constGets the value of MaxRankAllowed.
public inline void SetMaxRankAllowed(float NewValue)Sets the value of MaxRankAllowed.
public inline float & GetMinRankAllowed()Gets the value of MinRankAllowed.
public inline const float & GetMinRankAllowed() constGets the value of MinRankAllowed.
public inline void SetMinRankAllowed(float NewValue)Sets the value of MinRankAllowed.
public inline float & GetMinVarianceAllowed()Gets the value of MinVarianceAllowed.
public inline const float & GetMinVarianceAllowed() constGets the value of MinVarianceAllowed.
public inline void SetMinVarianceAllowed(float NewValue)Sets the value of MinVarianceAllowed.
public inline float & GetTrueskillBeta()Gets the value of TrueskillBeta_Optional, regardless of it having been set.
public inline const float & GetTrueskillBeta() constGets the value of TrueskillBeta_Optional, regardless of it having been set.
public inline const float & GetTrueskillBeta(const float & DefaultValue) constGets the value of TrueskillBeta_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillBeta(float & OutValue) constFills OutValue with the value of TrueskillBeta_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetTrueskillBetaOrNull()Returns a pointer to TrueskillBeta_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillBetaOrNull() constReturns a pointer to TrueskillBeta_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTrueskillBeta(float NewValue)Sets the value of TrueskillBeta_Optional and also sets TrueskillBeta_IsSet to true.
public inline void ClearTrueskillBeta()Clears the value of TrueskillBeta_Optional and sets TrueskillBeta_IsSet to false.
public inline float & GetTrueskillTau()Gets the value of TrueskillTau_Optional, regardless of it having been set.
public inline const float & GetTrueskillTau() constGets the value of TrueskillTau_Optional, regardless of it having been set.
public inline const float & GetTrueskillTau(const float & DefaultValue) constGets the value of TrueskillTau_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillTau(float & OutValue) constFills OutValue with the value of TrueskillTau_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetTrueskillTauOrNull()Returns a pointer to TrueskillTau_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillTauOrNull() constReturns a pointer to TrueskillTau_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTrueskillTau(float NewValue)Sets the value of TrueskillTau_Optional and also sets TrueskillTau_IsSet to true.
public inline void ClearTrueskillTau()Clears the value of TrueskillTau_Optional and sets TrueskillTau_IsSet to false.
public inline float & GetTrueskillDrawProbability()Gets the value of TrueskillDrawProbability_Optional, regardless of it having been set.
public inline const float & GetTrueskillDrawProbability() constGets the value of TrueskillDrawProbability_Optional, regardless of it having been set.
public inline const float & GetTrueskillDrawProbability(const float & DefaultValue) constGets the value of TrueskillDrawProbability_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillDrawProbability(float & OutValue) constFills OutValue with the value of TrueskillDrawProbability_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetTrueskillDrawProbabilityOrNull()Returns a pointer to TrueskillDrawProbability_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillDrawProbabilityOrNull() constReturns a pointer to TrueskillDrawProbability_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTrueskillDrawProbability(float NewValue)Sets the value of TrueskillDrawProbability_Optional and also sets TrueskillDrawProbability_IsSet to true.
public inline void ClearTrueskillDrawProbability()Clears the value of TrueskillDrawProbability_Optional and sets TrueskillDrawProbability_IsSet to false.

Members

public int32 RankId

ID for this rank type.


#### `public float `[`DefaultRank`](#structFRHAPI__RankConfig_1a570d0708073bb8b7fc260b31e6393e7e)

The default rank value for this rank id. Will be used when players do not have any rank history.


#### `public float `[`DefaultVariance`](#structFRHAPI__RankConfig_1a23015f77bd5ebf13d8b619352123a154)

The default skill variance for this rank id. Will be used when players do not have any rank history.


#### `public float `[`MaxRankAllowed`](#structFRHAPI__RankConfig_1ae69b0a3c5e8e2bf082bdbecbd627bfd4)

The maximum rank value achievable. Any attempts to update a rank value to be higher than this get clamped to the maximum.


#### `public float `[`MinRankAllowed`](#structFRHAPI__RankConfig_1a3066610bbe1a9a01a69b3c60a7f51310)

The minimum rank value achievable. Any attempts to update a rank value to be lower than this get clamped to the minimum.


#### `public float `[`MinVarianceAllowed`](#structFRHAPI__RankConfig_1a156b1b648f115b8912bbfe0a407bf6f3)

The minimum skill variance allowed. Any attempts to update variance to be lower than this get clamped to the minimum.


#### `public float `[`TrueskillBeta_Optional`](#structFRHAPI__RankConfig_1a7b6cfd4661aace1eb22d9beec999ae3d)

The distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default variance.


#### `public bool `[`TrueskillBeta_IsSet`](#structFRHAPI__RankConfig_1a17627a7b7e79c031163c3ef6d94eef75)

true if TrueskillBeta_Optional has been set to a value


#### `public float `[`TrueskillTau_Optional`](#structFRHAPI__RankConfig_1a11bbf87c3c2a3f05c5cd68151567e76c)

Factor that determines how quickly a player’s variance is adjusted. A larger tau will result in more volatile in ranks. Recommended value is is (default_variance * .01)


#### `public bool `[`TrueskillTau_IsSet`](#structFRHAPI__RankConfig_1ab39e312a255d2c70350b92375f4373fa)

true if TrueskillTau_Optional has been set to a value


#### `public float `[`TrueskillDrawProbability_Optional`](#structFRHAPI__RankConfig_1a3bde7cd20fd2247786c36c72a917b8d5)

The percent probability of a draw occuring in the game. Must be in [0, 1)


#### `public bool `[`TrueskillDrawProbability_IsSet`](#structFRHAPI__RankConfig_1ad6aa6ffcec6b52b755056c3f504f0cf0)

true if TrueskillDrawProbability_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__RankConfig_1a5eeb6337adc9e525f4fe923e3793e857)`(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__RankConfig_1a618a68dc968bb1b200eb61be35e658f2)`(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 int32 & `[`GetRankId`](#structFRHAPI__RankConfig_1a66e760b397c5bcc2f500183878595b95)`()`

Gets the value of RankId.


#### `public inline const int32 & `[`GetRankId`](#structFRHAPI__RankConfig_1a0bed9ba67407f4dd48f60e07ba3925fb)`() const`

Gets the value of RankId.


#### `public inline void `[`SetRankId`](#structFRHAPI__RankConfig_1ad6bac2166b6c3d19da237641f25006fa)`(int32 NewValue)`

Sets the value of RankId.


#### `public inline bool `[`IsRankIdDefaultValue`](#structFRHAPI__RankConfig_1a04f0f5bcfe8d4f777e205c55b8c3ad47)`() const`

Returns true if RankId matches the default value.


#### `public inline void `[`SetRankIdToDefault`](#structFRHAPI__RankConfig_1ace9a1488b2bcd56f0c3cd45e2dd72ff2)`()`

Sets the value of RankId to its default


#### `public inline float & `[`GetDefaultRank`](#structFRHAPI__RankConfig_1a86c054035bff432932963d8227713085)`()`

Gets the value of DefaultRank.


#### `public inline const float & `[`GetDefaultRank`](#structFRHAPI__RankConfig_1a311cedcad58f159894c700ac467b945a)`() const`

Gets the value of DefaultRank.


#### `public inline void `[`SetDefaultRank`](#structFRHAPI__RankConfig_1ac69b90e6bf04aabe53e7cf7bd5f026d9)`(float NewValue)`

Sets the value of DefaultRank.


#### `public inline float & `[`GetDefaultVariance`](#structFRHAPI__RankConfig_1a882245963eacb486430fb09b5503d69d)`()`

Gets the value of DefaultVariance.


#### `public inline const float & `[`GetDefaultVariance`](#structFRHAPI__RankConfig_1a754957559a43ec153109c7a020f69087)`() const`

Gets the value of DefaultVariance.


#### `public inline void `[`SetDefaultVariance`](#structFRHAPI__RankConfig_1a65019b60abe5b9ce0dacbd271c9ec3c7)`(float NewValue)`

Sets the value of DefaultVariance.


#### `public inline float & `[`GetMaxRankAllowed`](#structFRHAPI__RankConfig_1a1264fa134be1f8cbc215da9718204438)`()`

Gets the value of MaxRankAllowed.


#### `public inline const float & `[`GetMaxRankAllowed`](#structFRHAPI__RankConfig_1a16820416c6f8e0604fd8a9567b34db5a)`() const`

Gets the value of MaxRankAllowed.


#### `public inline void `[`SetMaxRankAllowed`](#structFRHAPI__RankConfig_1ad2168d447fc145c0a4d08e47f8872639)`(float NewValue)`

Sets the value of MaxRankAllowed.


#### `public inline float & `[`GetMinRankAllowed`](#structFRHAPI__RankConfig_1a9b6f753f632176c52ed3db6d46671ab5)`()`

Gets the value of MinRankAllowed.


#### `public inline const float & `[`GetMinRankAllowed`](#structFRHAPI__RankConfig_1ae1f1add3f01d8be97eacb6162eadba9f)`() const`

Gets the value of MinRankAllowed.


#### `public inline void `[`SetMinRankAllowed`](#structFRHAPI__RankConfig_1adc06ad883b89d55b6f8c63f1149e5715)`(float NewValue)`

Sets the value of MinRankAllowed.


#### `public inline float & `[`GetMinVarianceAllowed`](#structFRHAPI__RankConfig_1a7913ae4db4909f1a4135aaa77d8d9633)`()`

Gets the value of MinVarianceAllowed.


#### `public inline const float & `[`GetMinVarianceAllowed`](#structFRHAPI__RankConfig_1a9f633c1a6701c7abe5e10a85f0cfa817)`() const`

Gets the value of MinVarianceAllowed.


#### `public inline void `[`SetMinVarianceAllowed`](#structFRHAPI__RankConfig_1a64dc67c01187c98b55f22853e1278d0a)`(float NewValue)`

Sets the value of MinVarianceAllowed.


#### `public inline float & `[`GetTrueskillBeta`](#structFRHAPI__RankConfig_1aac940d1331ba26a27087ff346d019778)`()`

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


#### `public inline const float & `[`GetTrueskillBeta`](#structFRHAPI__RankConfig_1a206201e611011abbb7e10c92d2ee5e75)`() const`

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


#### `public inline const float & `[`GetTrueskillBeta`](#structFRHAPI__RankConfig_1a8e3e29243afbcc3e1587e989109ecd20)`(const float & DefaultValue) const`

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


#### `public inline bool `[`GetTrueskillBeta`](#structFRHAPI__RankConfig_1abc9f4944067e7afa709dc6d5663ef46f)`(float & OutValue) const`

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


#### `public inline float * `[`GetTrueskillBetaOrNull`](#structFRHAPI__RankConfig_1a2b06b632cf54dc91074261ce9e442329)`()`

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


#### `public inline const float * `[`GetTrueskillBetaOrNull`](#structFRHAPI__RankConfig_1a00a65a31426e840a8a6972dd5ff95e4d)`() const`

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


#### `public inline void `[`SetTrueskillBeta`](#structFRHAPI__RankConfig_1ab213f91e60f32e0e0cf0503369a20607)`(float NewValue)`

Sets the value of TrueskillBeta_Optional and also sets TrueskillBeta_IsSet to true.


#### `public inline void `[`ClearTrueskillBeta`](#structFRHAPI__RankConfig_1a86aed2aa40decb5799ef1cea0e97d97e)`()`

Clears the value of TrueskillBeta_Optional and sets TrueskillBeta_IsSet to false.


#### `public inline float & `[`GetTrueskillTau`](#structFRHAPI__RankConfig_1aad4e25d66e0327976c7c73e89ad7fbb6)`()`

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


#### `public inline const float & `[`GetTrueskillTau`](#structFRHAPI__RankConfig_1ae8908e798445bda96b3a555d45d4d917)`() const`

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


#### `public inline const float & `[`GetTrueskillTau`](#structFRHAPI__RankConfig_1af01cef0e2bedde08ecc7ee5a066602f1)`(const float & DefaultValue) const`

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


#### `public inline bool `[`GetTrueskillTau`](#structFRHAPI__RankConfig_1a2faa7b28e35485fdf4699353a286d19f)`(float & OutValue) const`

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


#### `public inline float * `[`GetTrueskillTauOrNull`](#structFRHAPI__RankConfig_1aee4494bb073de7b602a28a8a96c0fce2)`()`

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


#### `public inline const float * `[`GetTrueskillTauOrNull`](#structFRHAPI__RankConfig_1a48d498dfe565ee706ddff0780b864379)`() const`

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


#### `public inline void `[`SetTrueskillTau`](#structFRHAPI__RankConfig_1a68331340f65e2bd48eaae0323c0080a7)`(float NewValue)`

Sets the value of TrueskillTau_Optional and also sets TrueskillTau_IsSet to true.


#### `public inline void `[`ClearTrueskillTau`](#structFRHAPI__RankConfig_1a1f6df6686b9aaf54d31134ef41378608)`()`

Clears the value of TrueskillTau_Optional and sets TrueskillTau_IsSet to false.


#### `public inline float & `[`GetTrueskillDrawProbability`](#structFRHAPI__RankConfig_1aae31464fb1721cd2c8589e79afc6e468)`()`

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


#### `public inline const float & `[`GetTrueskillDrawProbability`](#structFRHAPI__RankConfig_1a06f2bc044267a960724c9a25fceb3af1)`() const`

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


#### `public inline const float & `[`GetTrueskillDrawProbability`](#structFRHAPI__RankConfig_1a62717e36d73d555848220c9cd29a0aa9)`(const float & DefaultValue) const`

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


#### `public inline bool `[`GetTrueskillDrawProbability`](#structFRHAPI__RankConfig_1a44f49ebf6c944e3ec499678ceb1ffa9d)`(float & OutValue) const`

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


#### `public inline float * `[`GetTrueskillDrawProbabilityOrNull`](#structFRHAPI__RankConfig_1a25c456e48c6f3550849bcd1b346567d7)`()`

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


#### `public inline const float * `[`GetTrueskillDrawProbabilityOrNull`](#structFRHAPI__RankConfig_1ae5d71272c4dca53e97cf1da0a9b5819b)`() const`

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


#### `public inline void `[`SetTrueskillDrawProbability`](#structFRHAPI__RankConfig_1a1f1b8bc3ecb7fbc1afb3ea2de43beadc)`(float NewValue)`

Sets the value of TrueskillDrawProbability_Optional and also sets TrueskillDrawProbability_IsSet to true.


#### `public inline void `[`ClearTrueskillDrawProbability`](#structFRHAPI__RankConfig_1af25247567c675b7e7b00750864fe6f52)`()`

Clears the value of TrueskillDrawProbability_Optional and sets TrueskillDrawProbability_IsSet to false.