RHAPI_RankConfigV3

Summary

Members	Descriptions
struct FRHAPI_RankConfigV3	Configuration about a specific rank type.

struct FRHAPI_RankConfigV3

struct FRHAPI_RankConfigV3
  : public FRHAPI_Model

Configuration about a specific rank type.

Summary

Members	Descriptions
public FString Name_Optional	Human readable name for this rank.
public bool Name_IsSet	true if Name_Optional has been set to a value
public FString Description_Optional	Description of this rank.
public bool Description_IsSet	true if Description_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	Custom data about this rank.
public bool CustomData_IsSet	true if CustomData_Optional has been set to a value
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 variance 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 variance.
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 variance 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 FString RankId	ID for this rank type.
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 & GetName()	Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName() const	Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName(const FString & DefaultValue) const	Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetName(FString & OutValue) const	Fills OutValue with the value of Name_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetNameOrNull()	Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNameOrNull() const	Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline void SetName(FString NewValue)	Sets the value of Name_Optional and also sets Name_IsSet to true.
public inline void ClearName()	Clears the value of Name_Optional and sets Name_IsSet to false.
public inline FString & GetDescription()	Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription() const	Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription(const FString & DefaultValue) const	Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDescription(FString & OutValue) const	Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDescriptionOrNull()	Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDescriptionOrNull() const	Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDescription(FString NewValue)	Sets the value of Description_Optional and also sets Description_IsSet to true.
public inline void ClearDescription()	Clears the value of Description_Optional and sets Description_IsSet to false.
public inline TMap< FString, FString > & GetCustomData()	Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() const	Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const	Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const	Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()	Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const	Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()	Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline float & GetMaxMu()	Gets the value of MaxMu.
public inline const float & GetMaxMu() const	Gets the value of MaxMu.
public inline void SetMaxMu(float NewValue)	Sets the value of MaxMu.
public inline float & GetMinMu()	Gets the value of MinMu.
public inline const float & GetMinMu() const	Gets the value of MinMu.
public inline void SetMinMu(float NewValue)	Sets the value of MinMu.
public inline float & GetMinSigma()	Gets the value of MinSigma.
public inline const float & GetMinSigma() const	Gets the value of MinSigma.
public inline void SetMinSigma(float NewValue)	Sets the value of MinSigma.
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(float NewValue)	Sets the value of Beta_Optional and also sets Beta_IsSet to true.
public inline void ClearBeta()	Clears the value of Beta_Optional and sets Beta_IsSet to false.
public inline float & GetDefaultMu()	Gets the value of DefaultMu.
public inline const float & GetDefaultMu() const	Gets the value of DefaultMu.
public inline void SetDefaultMu(float NewValue)	Sets the value of DefaultMu.
public inline float & GetDefaultSigma()	Gets the value of DefaultSigma.
public inline const float & GetDefaultSigma() const	Gets the value of DefaultSigma.
public inline void SetDefaultSigma(float NewValue)	Sets the value of DefaultSigma.
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(float NewValue)	Sets the value of DrawProbability_Optional and also sets DrawProbability_IsSet to true.
public inline void ClearDrawProbability()	Clears the value of DrawProbability_Optional and sets DrawProbability_IsSet to false.
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(float NewValue)	Sets the value of Tau_Optional and also sets Tau_IsSet to true.
public inline void ClearTau()	Clears the value of Tau_Optional and sets Tau_IsSet to false.
public inline FString & GetRankId()	Gets the value of RankId.
public inline const FString & GetRankId() const	Gets the value of RankId.
public inline void SetRankId(FString NewValue)	Sets the value of RankId.

Members

public FString Name_Optional

Human readable name for this rank.

public bool Name_IsSet

true if Name_Optional has been set to a value

public FString Description_Optional

Description of this rank.

public bool Description_IsSet

true if Description_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

Custom data about this rank.

public bool CustomData_IsSet

true if CustomData_Optional has been set to a value

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 variance 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 variance.

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 variance 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 FString RankId

ID for this rank type.

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 FString & GetName()

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

public inline const FString & GetName() const

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

public inline const FString & GetName(const FString & DefaultValue) const

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

public inline bool GetName(FString & OutValue) const

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

public inline FString * GetNameOrNull()

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

public inline const FString * GetNameOrNull() const

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

public inline void SetName(FString NewValue)

Sets the value of Name_Optional and also sets Name_IsSet to true.

public inline void ClearName()

Clears the value of Name_Optional and sets Name_IsSet to false.

public inline FString & GetDescription()

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

public inline const FString & GetDescription() const

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

public inline const FString & GetDescription(const FString & DefaultValue) const

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

public inline bool GetDescription(FString & OutValue) const

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

public inline FString * GetDescriptionOrNull()

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

public inline const FString * GetDescriptionOrNull() const

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

public inline void SetDescription(FString NewValue)

Sets the value of Description_Optional and also sets Description_IsSet to true.

public inline void ClearDescription()

Clears the value of Description_Optional and sets Description_IsSet to false.

public inline TMap< FString, FString > & GetCustomData()

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

public inline const TMap< FString, FString > & GetCustomData() const

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

public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const

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

public inline bool GetCustomData(TMap< FString, FString > & OutValue) const

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

public inline TMap< FString, FString > * GetCustomDataOrNull()

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

public inline const TMap< FString, FString > * GetCustomDataOrNull() const

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

public inline void SetCustomData(TMap< FString, FString > NewValue)

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void ClearCustomData()

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline float & GetMaxMu()

Gets the value of MaxMu.

public inline const float & GetMaxMu() const

Gets the value of MaxMu.

public inline void SetMaxMu(float NewValue)

Sets the value of MaxMu.

public inline float & GetMinMu()

Gets the value of MinMu.

public inline const float & GetMinMu() const

Gets the value of MinMu.

public inline void SetMinMu(float NewValue)

Sets the value of MinMu.

public inline float & GetMinSigma()

Gets the value of MinSigma.

public inline const float & GetMinSigma() const

Gets the value of MinSigma.

public inline void SetMinSigma(float NewValue)

Sets the value of MinSigma.

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(float NewValue)

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

public inline void ClearBeta()

Clears the value of Beta_Optional and sets Beta_IsSet to false.

public inline float & GetDefaultMu()

Gets the value of DefaultMu.

public inline const float & GetDefaultMu() const

Gets the value of DefaultMu.

public inline void SetDefaultMu(float NewValue)

Sets the value of DefaultMu.

public inline float & GetDefaultSigma()

Gets the value of DefaultSigma.

public inline const float & GetDefaultSigma() const

Gets the value of DefaultSigma.

public inline void SetDefaultSigma(float NewValue)

Sets the value of DefaultSigma.

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(float NewValue)

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

public inline void ClearDrawProbability()

Clears the value of DrawProbability_Optional and sets DrawProbability_IsSet to false.

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(float NewValue)

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

public inline void ClearTau()

Clears the value of Tau_Optional and sets Tau_IsSet to false.

public inline FString & GetRankId()

Gets the value of RankId.

public inline const FString & GetRankId() const

Gets the value of RankId.

public inline void SetRankId(FString NewValue)

Sets the value of RankId.