Skip to content
RallyHere Docs
GitHub

RHAPI_RankData

Summary

MembersDescriptions
struct FRHAPI_RankDataTrueskill oriented ranked data about a player’s skill and confidence levels.

struct FRHAPI_RankData

struct FRHAPI_RankData
  : public FRHAPI_Model

Trueskill oriented ranked data about a player’s skill and confidence levels.

Summary

MembersDescriptions
public float MuTrueskill mu. This is a measure of perceived skill in a player.
public float SigmaTrueskill sigma. This is a measure of how unconfident we are in the perceived skill (high sigma means less confident)
public TMap< FString, FString > CustomData_OptionalCustom key-value player rank data.
public bool CustomData_IsSettrue if CustomData_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 & GetMu()Gets the value of Mu.
public inline const float & GetMu() constGets the value of Mu.
public inline void SetMu(float NewValue)Sets the value of Mu.
public inline float & GetSigma()Gets the value of Sigma.
public inline const float & GetSigma() constGets the value of Sigma.
public inline void SetSigma(float NewValue)Sets the value of Sigma.
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() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills 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() constReturns 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.

Members

public float Mu

Trueskill mu. This is a measure of perceived skill in a player.

public float Sigma

Trueskill sigma. This is a measure of how unconfident we are in the perceived skill (high sigma means less confident)

public TMap< FString, FString > CustomData_Optional

Custom key-value player rank data.

public bool CustomData_IsSet

true if CustomData_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 & GetMu()

Gets the value of Mu.

public inline const float & GetMu() const

Gets the value of Mu.

public inline void SetMu(float NewValue)

Sets the value of Mu.

public inline float & GetSigma()

Gets the value of Sigma.

public inline const float & GetSigma() const

Gets the value of Sigma.

public inline void SetSigma(float NewValue)

Sets the value of Sigma.

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.