RHAPI_RankConfig
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_RankConfig | Configuration about a specific rank type. |
struct FRHAPI_RankConfig
struct FRHAPI_RankConfig
: public FRHAPI_ModelConfiguration about a specific rank type.
Summary
| Members | Descriptions |
|---|---|
public int32 RankId | ID for this rank type. |
public float DefaultRank | The default rank value for this rank id. Will be used when players do not have any rank history. |
public float DefaultVariance | The default skill variance for this rank id. Will be used when players do not have any rank history. |
public float MaxRankAllowed | 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 | 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 | The minimum skill variance allowed. Any attempts to update variance to be lower than this get clamped to the minimum. |
public float TrueskillBeta_Optional | The distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default variance. |
public bool TrueskillBeta_IsSet | true if TrueskillBeta_Optional has been set to a value |
public float TrueskillTau_Optional | 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 | true if TrueskillTau_Optional has been set to a value |
public float TrueskillDrawProbability_Optional | The percent probability of a draw occuring in the game. Must be in [0, 1) |
public bool TrueskillDrawProbability_IsSet | true 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) const | Writes 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() const | Gets the value of RankId. |
public inline void SetRankId(int32 NewValue) | Sets the value of RankId. |
public inline bool IsRankIdDefaultValue() const | Returns 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() const | Gets 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() const | Gets 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() const | Gets 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() const | Gets 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() const | Gets 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() const | Gets the value of TrueskillBeta_Optional, regardless of it having been set. |
public inline const float & GetTrueskillBeta(const float & DefaultValue) const | Gets the value of TrueskillBeta_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetTrueskillBeta(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() | Returns a pointer to TrueskillBeta_Optional, if it has been set, otherwise returns nullptr. |
public inline const float * GetTrueskillBetaOrNull() const | Returns 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() const | Gets the value of TrueskillTau_Optional, regardless of it having been set. |
public inline const float & GetTrueskillTau(const float & DefaultValue) const | Gets the value of TrueskillTau_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetTrueskillTau(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() | Returns a pointer to TrueskillTau_Optional, if it has been set, otherwise returns nullptr. |
public inline const float * GetTrueskillTauOrNull() const | Returns 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() const | Gets the value of TrueskillDrawProbability_Optional, regardless of it having been set. |
public inline const float & GetTrueskillDrawProbability(const float & DefaultValue) const | Gets the value of TrueskillDrawProbability_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetTrueskillDrawProbability(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() | Returns a pointer to TrueskillDrawProbability_Optional, if it has been set, otherwise returns nullptr. |
public inline const float * GetTrueskillDrawProbabilityOrNull() const | Returns 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
The default rank value for this rank id. Will be used when players do not have any rank history.
public float DefaultVariance
The default skill variance for this rank id. Will be used when players do not have any rank history.
public float MaxRankAllowed
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
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
The minimum skill variance allowed. Any attempts to update variance to be lower than this get clamped to the minimum.
public float TrueskillBeta_Optional
The distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default variance.
public bool TrueskillBeta_IsSet
true if TrueskillBeta_Optional has been set to a value
public float TrueskillTau_Optional
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
true if TrueskillTau_Optional has been set to a value
public float TrueskillDrawProbability_Optional
The percent probability of a draw occuring in the game. Must be in [0, 1)
public bool TrueskillDrawProbability_IsSet
true 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.
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 int32 & GetRankId()
Gets the value of RankId.
public inline const int32 & GetRankId() const
Gets the value of RankId.
public inline void SetRankId(int32 NewValue)
Sets the value of RankId.
public inline bool IsRankIdDefaultValue() const
Returns 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() const
Gets 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() const
Gets 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() const
Gets 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() const
Gets 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() const
Gets 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() const
Gets the value of TrueskillBeta_Optional, regardless of it having been set.
public inline const float & GetTrueskillBeta(const float & DefaultValue) const
Gets the value of TrueskillBeta_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillBeta(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()
Returns a pointer to TrueskillBeta_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillBetaOrNull() const
Returns 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() const
Gets the value of TrueskillTau_Optional, regardless of it having been set.
public inline const float & GetTrueskillTau(const float & DefaultValue) const
Gets the value of TrueskillTau_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillTau(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()
Returns a pointer to TrueskillTau_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillTauOrNull() const
Returns 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() const
Gets the value of TrueskillDrawProbability_Optional, regardless of it having been set.
public inline const float & GetTrueskillDrawProbability(const float & DefaultValue) const
Gets the value of TrueskillDrawProbability_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTrueskillDrawProbability(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()
Returns a pointer to TrueskillDrawProbability_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTrueskillDrawProbabilityOrNull() const
Returns 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.