RHAPI_MatchMakingProfile
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_MatchMakingProfile | DEPRECATED A profile that describes what pools of players a session will be a part of when matchmaking. |
struct FRHAPI_MatchMakingProfile
struct FRHAPI_MatchMakingProfile : public FRHAPI_ModelDEPRECATED A profile that describes what pools of players a session will be a part of when matchmaking.
Summary
| Members | Descriptions |
|---|---|
public FString ProfileId | ID of the matchmaking profile to join. |
public ERHAPI_ProfileJoinMode JoinMode_Optional | What mode to set on the matchmaking profile (normal, backfill etc) |
public bool JoinMode_IsSet | true if JoinMode_Optional has been set to a value |
public FGuid InstanceLaunchTemplateId | Which instance template to use when launching a match in this profile. |
public FString RankId_Optional | Which rank this profile should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example) |
public bool RankId_IsSet | true if RankId_Optional has been set to a value |
public int32 NumSides_Optional | The number of sides a game in this profile will have (2 in a 1v1 and 3 in a 1v1v1 for example. |
public bool NumSides_IsSet | true if NumSides_Optional has been set to a value |
public int32 MaxPlayersPerSide_Optional | The maximum number of players that can be on each team. |
public bool MaxPlayersPerSide_IsSet | true if MaxPlayersPerSide_Optional has been set to a value |
public int32 MinPlayersPerSide_Optional | The minimum number of players that can be on each team. |
public bool MinPlayersPerSide_IsSet | true if MinPlayersPerSide_Optional has been set to a value |
public TMap< FString, FString > LegacyConfig_Optional | Legacy config to help migrate clients. |
public bool LegacyConfig_IsSet | true if LegacyConfig_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 FString & GetProfileId() | Gets the value of ProfileId. |
public inline const FString & GetProfileId() const | Gets the value of ProfileId. |
public inline void SetProfileId(FString NewValue) | Sets the value of ProfileId. |
public inline ERHAPI_ProfileJoinMode & GetJoinMode() | Gets the value of JoinMode_Optional, regardless of it having been set. |
public inline const ERHAPI_ProfileJoinMode & GetJoinMode() const | Gets the value of JoinMode_Optional, regardless of it having been set. |
public inline const ERHAPI_ProfileJoinMode & GetJoinMode(const ERHAPI_ProfileJoinMode & DefaultValue) const | Gets the value of JoinMode_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetJoinMode(ERHAPI_ProfileJoinMode & OutValue) const | Fills OutValue with the value of JoinMode_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_ProfileJoinMode * GetJoinModeOrNull() | Returns a pointer to JoinMode_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_ProfileJoinMode * GetJoinModeOrNull() const | Returns a pointer to JoinMode_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetJoinMode(ERHAPI_ProfileJoinMode NewValue) | Sets the value of JoinMode_Optional and also sets JoinMode_IsSet to true. |
public inline void ClearJoinMode() | Clears the value of JoinMode_Optional and sets JoinMode_IsSet to false. |
public inline FGuid & GetInstanceLaunchTemplateId() | Gets the value of InstanceLaunchTemplateId. |
public inline const FGuid & GetInstanceLaunchTemplateId() const | Gets the value of InstanceLaunchTemplateId. |
public inline void SetInstanceLaunchTemplateId(FGuid NewValue) | Sets the value of InstanceLaunchTemplateId. |
public inline FString & GetRankId() | Gets the value of RankId_Optional, regardless of it having been set. |
public inline const FString & GetRankId() const | Gets the value of RankId_Optional, regardless of it having been set. |
public inline const FString & GetRankId(const FString & DefaultValue) const | Gets the value of RankId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetRankId(FString & OutValue) const | Fills OutValue with the value of RankId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetRankIdOrNull() | Returns a pointer to RankId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetRankIdOrNull() const | Returns a pointer to RankId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetRankId(FString NewValue) | Sets the value of RankId_Optional and also sets RankId_IsSet to true. |
public inline void ClearRankId() | Clears the value of RankId_Optional and sets RankId_IsSet to false. |
public inline int32 & GetNumSides() | Gets the value of NumSides_Optional, regardless of it having been set. |
public inline const int32 & GetNumSides() const | Gets the value of NumSides_Optional, regardless of it having been set. |
public inline const int32 & GetNumSides(const int32 & DefaultValue) const | Gets the value of NumSides_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetNumSides(int32 & OutValue) const | Fills OutValue with the value of NumSides_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetNumSidesOrNull() | Returns a pointer to NumSides_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetNumSidesOrNull() const | Returns a pointer to NumSides_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetNumSides(int32 NewValue) | Sets the value of NumSides_Optional and also sets NumSides_IsSet to true. |
public inline void ClearNumSides() | Clears the value of NumSides_Optional and sets NumSides_IsSet to false. |
public inline bool IsNumSidesDefaultValue() const | Returns true if NumSides_Optional is set and matches the default value. |
public inline void SetNumSidesToDefault() | Sets the value of NumSides_Optional to its default and also sets NumSides_IsSet to true. |
public inline int32 & GetMaxPlayersPerSide() | Gets the value of MaxPlayersPerSide_Optional, regardless of it having been set. |
public inline const int32 & GetMaxPlayersPerSide() const | Gets the value of MaxPlayersPerSide_Optional, regardless of it having been set. |
public inline const int32 & GetMaxPlayersPerSide(const int32 & DefaultValue) const | Gets the value of MaxPlayersPerSide_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMaxPlayersPerSide(int32 & OutValue) const | Fills OutValue with the value of MaxPlayersPerSide_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetMaxPlayersPerSideOrNull() | Returns a pointer to MaxPlayersPerSide_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetMaxPlayersPerSideOrNull() const | Returns a pointer to MaxPlayersPerSide_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMaxPlayersPerSide(int32 NewValue) | Sets the value of MaxPlayersPerSide_Optional and also sets MaxPlayersPerSide_IsSet to true. |
public inline void ClearMaxPlayersPerSide() | Clears the value of MaxPlayersPerSide_Optional and sets MaxPlayersPerSide_IsSet to false. |
public inline bool IsMaxPlayersPerSideDefaultValue() const | Returns true if MaxPlayersPerSide_Optional is set and matches the default value. |
public inline void SetMaxPlayersPerSideToDefault() | Sets the value of MaxPlayersPerSide_Optional to its default and also sets MaxPlayersPerSide_IsSet to true. |
public inline int32 & GetMinPlayersPerSide() | Gets the value of MinPlayersPerSide_Optional, regardless of it having been set. |
public inline const int32 & GetMinPlayersPerSide() const | Gets the value of MinPlayersPerSide_Optional, regardless of it having been set. |
public inline const int32 & GetMinPlayersPerSide(const int32 & DefaultValue) const | Gets the value of MinPlayersPerSide_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMinPlayersPerSide(int32 & OutValue) const | Fills OutValue with the value of MinPlayersPerSide_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetMinPlayersPerSideOrNull() | Returns a pointer to MinPlayersPerSide_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetMinPlayersPerSideOrNull() const | Returns a pointer to MinPlayersPerSide_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMinPlayersPerSide(int32 NewValue) | Sets the value of MinPlayersPerSide_Optional and also sets MinPlayersPerSide_IsSet to true. |
public inline void ClearMinPlayersPerSide() | Clears the value of MinPlayersPerSide_Optional and sets MinPlayersPerSide_IsSet to false. |
public inline bool IsMinPlayersPerSideDefaultValue() const | Returns true if MinPlayersPerSide_Optional is set and matches the default value. |
public inline void SetMinPlayersPerSideToDefault() | Sets the value of MinPlayersPerSide_Optional to its default and also sets MinPlayersPerSide_IsSet to true. |
public inline TMap< FString, FString > & GetLegacyConfig() | Gets the value of LegacyConfig_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetLegacyConfig() const | Gets the value of LegacyConfig_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetLegacyConfig(const TMap< FString, FString > & DefaultValue) const | Gets the value of LegacyConfig_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLegacyConfig(TMap< FString, FString > & OutValue) const | Fills OutValue with the value of LegacyConfig_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetLegacyConfigOrNull() | Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetLegacyConfigOrNull() const | Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLegacyConfig(TMap< FString, FString > NewValue) | Sets the value of LegacyConfig_Optional and also sets LegacyConfig_IsSet to true. |
public inline void ClearLegacyConfig() | Clears the value of LegacyConfig_Optional and sets LegacyConfig_IsSet to false. |
Members
public FString ProfileId
ID of the matchmaking profile to join.
public ERHAPI_ProfileJoinMode JoinMode_Optional
What mode to set on the matchmaking profile (normal, backfill etc)
public bool JoinMode_IsSet
true if JoinMode_Optional has been set to a value
public FGuid InstanceLaunchTemplateId
Which instance template to use when launching a match in this profile.
public FString RankId_Optional
Which rank this profile should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example)
public bool RankId_IsSet
true if RankId_Optional has been set to a value
public int32 NumSides_Optional
The number of sides a game in this profile will have (2 in a 1v1 and 3 in a 1v1v1 for example.
public bool NumSides_IsSet
true if NumSides_Optional has been set to a value
public int32 MaxPlayersPerSide_Optional
The maximum number of players that can be on each team.
public bool MaxPlayersPerSide_IsSet
true if MaxPlayersPerSide_Optional has been set to a value
public int32 MinPlayersPerSide_Optional
The minimum number of players that can be on each team.
public bool MinPlayersPerSide_IsSet
true if MinPlayersPerSide_Optional has been set to a value
public TMap< FString, FString > LegacyConfig_Optional
Legacy config to help migrate clients.
public bool LegacyConfig_IsSet
true if LegacyConfig_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 FString & GetProfileId()
Gets the value of ProfileId.
public inline const FString & GetProfileId() const
Gets the value of ProfileId.
public inline void SetProfileId(FString NewValue)
Sets the value of ProfileId.
public inline ERHAPI_ProfileJoinMode & GetJoinMode()
Gets the value of JoinMode_Optional, regardless of it having been set.
public inline const ERHAPI_ProfileJoinMode & GetJoinMode() const
Gets the value of JoinMode_Optional, regardless of it having been set.
public inline const ERHAPI_ProfileJoinMode & GetJoinMode(const ERHAPI_ProfileJoinMode & DefaultValue) const
Gets the value of JoinMode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoinMode(ERHAPI_ProfileJoinMode & OutValue) const
Fills OutValue with the value of JoinMode_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_ProfileJoinMode * GetJoinModeOrNull()
Returns a pointer to JoinMode_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_ProfileJoinMode * GetJoinModeOrNull() const
Returns a pointer to JoinMode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoinMode(ERHAPI_ProfileJoinMode NewValue)
Sets the value of JoinMode_Optional and also sets JoinMode_IsSet to true.
public inline void ClearJoinMode()
Clears the value of JoinMode_Optional and sets JoinMode_IsSet to false.
public inline FGuid & GetInstanceLaunchTemplateId()
Gets the value of InstanceLaunchTemplateId.
public inline const FGuid & GetInstanceLaunchTemplateId() const
Gets the value of InstanceLaunchTemplateId.
public inline void SetInstanceLaunchTemplateId(FGuid NewValue)
Sets the value of InstanceLaunchTemplateId.
public inline FString & GetRankId()
Gets the value of RankId_Optional, regardless of it having been set.
public inline const FString & GetRankId() const
Gets the value of RankId_Optional, regardless of it having been set.
public inline const FString & GetRankId(const FString & DefaultValue) const
Gets the value of RankId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRankId(FString & OutValue) const
Fills OutValue with the value of RankId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRankIdOrNull()
Returns a pointer to RankId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRankIdOrNull() const
Returns a pointer to RankId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRankId(FString NewValue)
Sets the value of RankId_Optional and also sets RankId_IsSet to true.
public inline void ClearRankId()
Clears the value of RankId_Optional and sets RankId_IsSet to false.
public inline int32 & GetNumSides()
Gets the value of NumSides_Optional, regardless of it having been set.
public inline const int32 & GetNumSides() const
Gets the value of NumSides_Optional, regardless of it having been set.
public inline const int32 & GetNumSides(const int32 & DefaultValue) const
Gets the value of NumSides_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNumSides(int32 & OutValue) const
Fills OutValue with the value of NumSides_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetNumSidesOrNull()
Returns a pointer to NumSides_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetNumSidesOrNull() const
Returns a pointer to NumSides_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNumSides(int32 NewValue)
Sets the value of NumSides_Optional and also sets NumSides_IsSet to true.
public inline void ClearNumSides()
Clears the value of NumSides_Optional and sets NumSides_IsSet to false.
public inline bool IsNumSidesDefaultValue() const
Returns true if NumSides_Optional is set and matches the default value.
public inline void SetNumSidesToDefault()
Sets the value of NumSides_Optional to its default and also sets NumSides_IsSet to true.
public inline int32 & GetMaxPlayersPerSide()
Gets the value of MaxPlayersPerSide_Optional, regardless of it having been set.
public inline const int32 & GetMaxPlayersPerSide() const
Gets the value of MaxPlayersPerSide_Optional, regardless of it having been set.
public inline const int32 & GetMaxPlayersPerSide(const int32 & DefaultValue) const
Gets the value of MaxPlayersPerSide_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMaxPlayersPerSide(int32 & OutValue) const
Fills OutValue with the value of MaxPlayersPerSide_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetMaxPlayersPerSideOrNull()
Returns a pointer to MaxPlayersPerSide_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetMaxPlayersPerSideOrNull() const
Returns a pointer to MaxPlayersPerSide_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMaxPlayersPerSide(int32 NewValue)
Sets the value of MaxPlayersPerSide_Optional and also sets MaxPlayersPerSide_IsSet to true.
public inline void ClearMaxPlayersPerSide()
Clears the value of MaxPlayersPerSide_Optional and sets MaxPlayersPerSide_IsSet to false.
public inline bool IsMaxPlayersPerSideDefaultValue() const
Returns true if MaxPlayersPerSide_Optional is set and matches the default value.
public inline void SetMaxPlayersPerSideToDefault()
Sets the value of MaxPlayersPerSide_Optional to its default and also sets MaxPlayersPerSide_IsSet to true.
public inline int32 & GetMinPlayersPerSide()
Gets the value of MinPlayersPerSide_Optional, regardless of it having been set.
public inline const int32 & GetMinPlayersPerSide() const
Gets the value of MinPlayersPerSide_Optional, regardless of it having been set.
public inline const int32 & GetMinPlayersPerSide(const int32 & DefaultValue) const
Gets the value of MinPlayersPerSide_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMinPlayersPerSide(int32 & OutValue) const
Fills OutValue with the value of MinPlayersPerSide_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetMinPlayersPerSideOrNull()
Returns a pointer to MinPlayersPerSide_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetMinPlayersPerSideOrNull() const
Returns a pointer to MinPlayersPerSide_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMinPlayersPerSide(int32 NewValue)
Sets the value of MinPlayersPerSide_Optional and also sets MinPlayersPerSide_IsSet to true.
public inline void ClearMinPlayersPerSide()
Clears the value of MinPlayersPerSide_Optional and sets MinPlayersPerSide_IsSet to false.
public inline bool IsMinPlayersPerSideDefaultValue() const
Returns true if MinPlayersPerSide_Optional is set and matches the default value.
public inline void SetMinPlayersPerSideToDefault()
Sets the value of MinPlayersPerSide_Optional to its default and also sets MinPlayersPerSide_IsSet to true.
public inline TMap< FString, FString > & GetLegacyConfig()
Gets the value of LegacyConfig_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetLegacyConfig() const
Gets the value of LegacyConfig_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetLegacyConfig(const TMap< FString, FString > & DefaultValue) const
Gets the value of LegacyConfig_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLegacyConfig(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of LegacyConfig_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetLegacyConfigOrNull()
Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetLegacyConfigOrNull() const
Returns a pointer to LegacyConfig_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLegacyConfig(TMap< FString, FString > NewValue)
Sets the value of LegacyConfig_Optional and also sets LegacyConfig_IsSet to true.
public inline void ClearLegacyConfig()
Clears the value of LegacyConfig_Optional and sets LegacyConfig_IsSet to false.