Skip to main content

RHAPI_CalculateRankConfig

Summary​

MembersDescriptions
struct FRHAPI_CalculateRankConfigConfig about how to recalculate ranks.

struct FRHAPI_CalculateRankConfig ​

struct FRHAPI_CalculateRankConfig
  : public FRHAPI_Model

Config about how to recalculate ranks.

Summary​

MembersDescriptions
public float MaxMuThe maximum mu value achievable. Any attempts to update a rank value to be higher than this get clamped to the maximum.
public float MinMuThe minimum mu value achievable. Any attempts to update a rank value to be lower than this get clamped to the minimum.
public float MinSigmaThe minimum sigma allowed. Any attempts to update sigma to be lower than this get clamped to the minimum.
public float Beta_OptionalThe distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default sigma.
public bool Beta_IsSettrue if Beta_Optional has been set to a value
public float DefaultMuThe default mu value for this rank id. Will be used when players do not have any rank history.
public float DefaultSigmaThe default sigma for this rank id. Will be used when players do not have any rank history.
public float DrawProbability_OptionalThe percent probability of a draw occuring in the game. Must be in [0, 1)
public bool DrawProbability_IsSettrue if DrawProbability_Optional has been set to a value
public float Tau_OptionalFactor that determines how quickly a player's sigma is adjusted. A larger tau will result in more volatile in ranks. Recommended value is is (default_sigma * .01)
public bool Tau_IsSettrue if Tau_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 float & GetMaxMu()Gets the value of MaxMu.
public inline const float & GetMaxMu() constGets the value of MaxMu.
public inline void SetMaxMu(const float & NewValue)Sets the value of MaxMu.
public inline void SetMaxMu(float && NewValue)Sets the value of MaxMu using move semantics.
public inline float & GetMinMu()Gets the value of MinMu.
public inline const float & GetMinMu() constGets the value of MinMu.
public inline void SetMinMu(const float & NewValue)Sets the value of MinMu.
public inline void SetMinMu(float && NewValue)Sets the value of MinMu using move semantics.
public inline float & GetMinSigma()Gets the value of MinSigma.
public inline const float & GetMinSigma() constGets the value of MinSigma.
public inline void SetMinSigma(const float & NewValue)Sets the value of MinSigma.
public inline void SetMinSigma(float && NewValue)Sets the value of MinSigma using move semantics.
public inline float & GetBeta()Gets the value of Beta_Optional, regardless of it having been set.
public inline const float & GetBeta() constGets the value of Beta_Optional, regardless of it having been set.
public inline const float & GetBeta(const float & DefaultValue) constGets the value of Beta_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetBeta(float & OutValue) constFills OutValue with the value of Beta_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetBetaOrNull()Returns a pointer to Beta_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetBetaOrNull() constReturns a pointer to Beta_Optional, if it has been set, otherwise returns nullptr.
public inline void SetBeta(const float & NewValue)Sets the value of Beta_Optional and also sets Beta_IsSet to true.
public inline void SetBeta(float && NewValue)Sets the value of Beta_Optional and also sets Beta_IsSet to true using move semantics.
public inline void ClearBeta()Clears the value of Beta_Optional and sets Beta_IsSet to false.
public inline bool IsBetaSet() constChecks whether Beta_Optional has been set.
public inline float & GetDefaultMu()Gets the value of DefaultMu.
public inline const float & GetDefaultMu() constGets the value of DefaultMu.
public inline void SetDefaultMu(const float & NewValue)Sets the value of DefaultMu.
public inline void SetDefaultMu(float && NewValue)Sets the value of DefaultMu using move semantics.
public inline float & GetDefaultSigma()Gets the value of DefaultSigma.
public inline const float & GetDefaultSigma() constGets the value of DefaultSigma.
public inline void SetDefaultSigma(const float & NewValue)Sets the value of DefaultSigma.
public inline void SetDefaultSigma(float && NewValue)Sets the value of DefaultSigma using move semantics.
public inline float & GetDrawProbability()Gets the value of DrawProbability_Optional, regardless of it having been set.
public inline const float & GetDrawProbability() constGets the value of DrawProbability_Optional, regardless of it having been set.
public inline const float & GetDrawProbability(const float & DefaultValue) constGets the value of DrawProbability_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDrawProbability(float & OutValue) constFills OutValue with the value of DrawProbability_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetDrawProbabilityOrNull()Returns a pointer to DrawProbability_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetDrawProbabilityOrNull() constReturns a pointer to DrawProbability_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDrawProbability(const float & NewValue)Sets the value of DrawProbability_Optional and also sets DrawProbability_IsSet to true.
public inline void SetDrawProbability(float && NewValue)Sets the value of DrawProbability_Optional and also sets DrawProbability_IsSet to true using move semantics.
public inline void ClearDrawProbability()Clears the value of DrawProbability_Optional and sets DrawProbability_IsSet to false.
public inline bool IsDrawProbabilitySet() constChecks whether DrawProbability_Optional has been set.
public inline float & GetTau()Gets the value of Tau_Optional, regardless of it having been set.
public inline const float & GetTau() constGets the value of Tau_Optional, regardless of it having been set.
public inline const float & GetTau(const float & DefaultValue) constGets the value of Tau_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTau(float & OutValue) constFills OutValue with the value of Tau_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetTauOrNull()Returns a pointer to Tau_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetTauOrNull() constReturns a pointer to Tau_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTau(const float & NewValue)Sets the value of Tau_Optional and also sets Tau_IsSet to true.
public inline void SetTau(float && NewValue)Sets the value of Tau_Optional and also sets Tau_IsSet to true using move semantics.
public inline void ClearTau()Clears the value of Tau_Optional and sets Tau_IsSet to false.
public inline bool IsTauSet() constChecks whether Tau_Optional has been set.

Members​

public float MaxMu ​

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

public float MinMu ​

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

public float MinSigma ​

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

public float Beta_Optional ​

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

public bool Beta_IsSet ​

true if Beta_Optional has been set to a value

public float DefaultMu ​

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

public float DefaultSigma ​

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

public float DrawProbability_Optional ​

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

public bool DrawProbability_IsSet ​

true if DrawProbability_Optional has been set to a value

public float Tau_Optional ​

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

public bool Tau_IsSet ​

true if Tau_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​

  • JsonValue Data 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​

  • Writer JSON Writer stream to push .

public inline float & GetMaxMu() ​

Gets the value of MaxMu.

public inline const float & GetMaxMu() const ​

Gets the value of MaxMu.

public inline void SetMaxMu(const float & NewValue) ​

Sets the value of MaxMu.

public inline void SetMaxMu(float && NewValue) ​

Sets the value of MaxMu using move semantics.

public inline float & GetMinMu() ​

Gets the value of MinMu.

public inline const float & GetMinMu() const ​

Gets the value of MinMu.

public inline void SetMinMu(const float & NewValue) ​

Sets the value of MinMu.

public inline void SetMinMu(float && NewValue) ​

Sets the value of MinMu using move semantics.

public inline float & GetMinSigma() ​

Gets the value of MinSigma.

public inline const float & GetMinSigma() const ​

Gets the value of MinSigma.

public inline void SetMinSigma(const float & NewValue) ​

Sets the value of MinSigma.

public inline void SetMinSigma(float && NewValue) ​

Sets the value of MinSigma using move semantics.

public inline float & GetBeta() ​

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

public inline const float & GetBeta() const ​

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

public inline const float & GetBeta(const float & DefaultValue) const ​

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

public inline bool GetBeta(float & OutValue) const ​

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

public inline float * GetBetaOrNull() ​

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

public inline const float * GetBetaOrNull() const ​

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

public inline void SetBeta(const float & NewValue) ​

Sets the value of Beta_Optional and also sets Beta_IsSet to true.

public inline void SetBeta(float && NewValue) ​

Sets the value of Beta_Optional and also sets Beta_IsSet to true using move semantics.

public inline void ClearBeta() ​

Clears the value of Beta_Optional and sets Beta_IsSet to false.

public inline bool IsBetaSet() const ​

Checks whether Beta_Optional has been set.

public inline float & GetDefaultMu() ​

Gets the value of DefaultMu.

public inline const float & GetDefaultMu() const ​

Gets the value of DefaultMu.

public inline void SetDefaultMu(const float & NewValue) ​

Sets the value of DefaultMu.

public inline void SetDefaultMu(float && NewValue) ​

Sets the value of DefaultMu using move semantics.

public inline float & GetDefaultSigma() ​

Gets the value of DefaultSigma.

public inline const float & GetDefaultSigma() const ​

Gets the value of DefaultSigma.

public inline void SetDefaultSigma(const float & NewValue) ​

Sets the value of DefaultSigma.

public inline void SetDefaultSigma(float && NewValue) ​

Sets the value of DefaultSigma using move semantics.

public inline float & GetDrawProbability() ​

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

public inline const float & GetDrawProbability() const ​

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

public inline const float & GetDrawProbability(const float & DefaultValue) const ​

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

public inline bool GetDrawProbability(float & OutValue) const ​

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

public inline float * GetDrawProbabilityOrNull() ​

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

public inline const float * GetDrawProbabilityOrNull() const ​

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

public inline void SetDrawProbability(const float & NewValue) ​

Sets the value of DrawProbability_Optional and also sets DrawProbability_IsSet to true.

public inline void SetDrawProbability(float && NewValue) ​

Sets the value of DrawProbability_Optional and also sets DrawProbability_IsSet to true using move semantics.

public inline void ClearDrawProbability() ​

Clears the value of DrawProbability_Optional and sets DrawProbability_IsSet to false.

public inline bool IsDrawProbabilitySet() const ​

Checks whether DrawProbability_Optional has been set.

public inline float & GetTau() ​

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

public inline const float & GetTau() const ​

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

public inline const float & GetTau(const float & DefaultValue) const ​

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

public inline bool GetTau(float & OutValue) const ​

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

public inline float * GetTauOrNull() ​

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

public inline const float * GetTauOrNull() const ​

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

public inline void SetTau(const float & NewValue) ​

Sets the value of Tau_Optional and also sets Tau_IsSet to true.

public inline void SetTau(float && NewValue) ​

Sets the value of Tau_Optional and also sets Tau_IsSet to true using move semantics.

public inline void ClearTau() ​

Clears the value of Tau_Optional and sets Tau_IsSet to false.

public inline bool IsTauSet() const ​

Checks whether Tau_Optional has been set.