Skip to main content

RHAPI_MatchMakingRuleset

Summary

MembersDescriptions
struct FRHAPI_MatchMakingRulesetA collection of rules that are used to determine whether a MatchMakingTemplate should be used.

struct FRHAPI_MatchMakingRuleset

struct FRHAPI_MatchMakingRuleset
: public FRHAPI_Model

A collection of rules that are used to determine whether a MatchMakingTemplate should be used.

Summary

MembersDescriptions
public TArray< FRHAPI_Rule>Rules_OptionalA list of the rules to be checked for this ruleset.
public bool Rules_IsSettrue if Rules_Optional has been set to a value
public ERHAPI_Determiner Determiner_OptionalDeterminer of how many rules must be satisfied in this rulest (all, any, one, none)
public bool Determiner_IsSettrue if Determiner_Optional has been set to a value
public ERHAPI_PlayersToValidate PlayersToValidate_OptionalWhich members of a session must be validated to satisfy this ruleset.
public bool PlayersToValidate_IsSettrue if PlayersToValidate_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 TArray< FRHAPI_Rule> &GetRules()Gets the value of Rules_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_Rule> &GetRules() constGets the value of Rules_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_Rule> &GetRules(const TArray< FRHAPI_Rule > & DefaultValue) constGets the value of Rules_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRules(TArray< FRHAPI_Rule > & OutValue) constFills OutValue with the value of Rules_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_Rule> *GetRulesOrNull()Returns a pointer to Rules_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_Rule> *GetRulesOrNull() constReturns a pointer to Rules_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRules(const TArray< FRHAPI_Rule > & NewValue)Sets the value of Rules_Optional and also sets Rules_IsSet to true.
public inline void SetRules(TArray< FRHAPI_Rule > && NewValue)Sets the value of Rules_Optional and also sets Rules_IsSet to true using move semantics.
public inline void ClearRules()Clears the value of Rules_Optional and sets Rules_IsSet to false.
public inline bool IsRulesSet() constChecks whether Rules_Optional has been set.
public inline ERHAPI_Determiner & GetDeterminer()Gets the value of Determiner_Optional, regardless of it having been set.
public inline const ERHAPI_Determiner & GetDeterminer() constGets the value of Determiner_Optional, regardless of it having been set.
public inline const ERHAPI_Determiner & GetDeterminer(const ERHAPI_Determiner & DefaultValue) constGets the value of Determiner_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeterminer(ERHAPI_Determiner & OutValue) constFills OutValue with the value of Determiner_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Determiner * GetDeterminerOrNull()Returns a pointer to Determiner_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Determiner * GetDeterminerOrNull() constReturns a pointer to Determiner_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeterminer(const ERHAPI_Determiner & NewValue)Sets the value of Determiner_Optional and also sets Determiner_IsSet to true.
public inline void SetDeterminer(ERHAPI_Determiner && NewValue)Sets the value of Determiner_Optional and also sets Determiner_IsSet to true using move semantics.
public inline void ClearDeterminer()Clears the value of Determiner_Optional and sets Determiner_IsSet to false.
public inline bool IsDeterminerSet() constChecks whether Determiner_Optional has been set.
public inline ERHAPI_PlayersToValidate & GetPlayersToValidate()Gets the value of PlayersToValidate_Optional, regardless of it having been set.
public inline const ERHAPI_PlayersToValidate & GetPlayersToValidate() constGets the value of PlayersToValidate_Optional, regardless of it having been set.
public inline const ERHAPI_PlayersToValidate & GetPlayersToValidate(const ERHAPI_PlayersToValidate & DefaultValue) constGets the value of PlayersToValidate_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayersToValidate(ERHAPI_PlayersToValidate & OutValue) constFills OutValue with the value of PlayersToValidate_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_PlayersToValidate * GetPlayersToValidateOrNull()Returns a pointer to PlayersToValidate_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_PlayersToValidate * GetPlayersToValidateOrNull() constReturns a pointer to PlayersToValidate_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayersToValidate(const ERHAPI_PlayersToValidate & NewValue)Sets the value of PlayersToValidate_Optional and also sets PlayersToValidate_IsSet to true.
public inline void SetPlayersToValidate(ERHAPI_PlayersToValidate && NewValue)Sets the value of PlayersToValidate_Optional and also sets PlayersToValidate_IsSet to true using move semantics.
public inline void ClearPlayersToValidate()Clears the value of PlayersToValidate_Optional and sets PlayersToValidate_IsSet to false.
public inline bool IsPlayersToValidateSet() constChecks whether PlayersToValidate_Optional has been set.

Members

public TArray< FRHAPI_Rule>Rules_Optional

A list of the rules to be checked for this ruleset.

public bool Rules_IsSet

true if Rules_Optional has been set to a value

public ERHAPI_Determiner Determiner_Optional

Determiner of how many rules must be satisfied in this rulest (all, any, one, none)

public bool Determiner_IsSet

true if Determiner_Optional has been set to a value

public ERHAPI_PlayersToValidate PlayersToValidate_Optional

Which members of a session must be validated to satisfy this ruleset.

public bool PlayersToValidate_IsSet

true if PlayersToValidate_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 TArray< FRHAPI_Rule> &GetRules()

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

public inline const TArray< FRHAPI_Rule> &GetRules() const

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

public inline const TArray< FRHAPI_Rule> &GetRules(const TArray< FRHAPI_Rule > & DefaultValue) const

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

public inline bool GetRules(TArray< FRHAPI_Rule > & OutValue) const

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

public inline TArray< FRHAPI_Rule> *GetRulesOrNull()

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

public inline const TArray< FRHAPI_Rule> *GetRulesOrNull() const

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

public inline void SetRules(const TArray< FRHAPI_Rule > & NewValue)

Sets the value of Rules_Optional and also sets Rules_IsSet to true.

public inline void SetRules(TArray< FRHAPI_Rule > && NewValue)

Sets the value of Rules_Optional and also sets Rules_IsSet to true using move semantics.

public inline void ClearRules()

Clears the value of Rules_Optional and sets Rules_IsSet to false.

public inline bool IsRulesSet() const

Checks whether Rules_Optional has been set.

public inline ERHAPI_Determiner & GetDeterminer()

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

public inline const ERHAPI_Determiner & GetDeterminer() const

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

public inline const ERHAPI_Determiner & GetDeterminer(const ERHAPI_Determiner & DefaultValue) const

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

public inline bool GetDeterminer(ERHAPI_Determiner & OutValue) const

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

public inline ERHAPI_Determiner * GetDeterminerOrNull()

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

public inline const ERHAPI_Determiner * GetDeterminerOrNull() const

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

public inline void SetDeterminer(const ERHAPI_Determiner & NewValue)

Sets the value of Determiner_Optional and also sets Determiner_IsSet to true.

public inline void SetDeterminer(ERHAPI_Determiner && NewValue)

Sets the value of Determiner_Optional and also sets Determiner_IsSet to true using move semantics.

public inline void ClearDeterminer()

Clears the value of Determiner_Optional and sets Determiner_IsSet to false.

public inline bool IsDeterminerSet() const

Checks whether Determiner_Optional has been set.

public inline ERHAPI_PlayersToValidate & GetPlayersToValidate()

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

public inline const ERHAPI_PlayersToValidate & GetPlayersToValidate() const

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

public inline const ERHAPI_PlayersToValidate & GetPlayersToValidate(const ERHAPI_PlayersToValidate & DefaultValue) const

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

public inline bool GetPlayersToValidate(ERHAPI_PlayersToValidate & OutValue) const

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

public inline ERHAPI_PlayersToValidate * GetPlayersToValidateOrNull()

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

public inline const ERHAPI_PlayersToValidate * GetPlayersToValidateOrNull() const

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

public inline void SetPlayersToValidate(const ERHAPI_PlayersToValidate & NewValue)

Sets the value of PlayersToValidate_Optional and also sets PlayersToValidate_IsSet to true.

public inline void SetPlayersToValidate(ERHAPI_PlayersToValidate && NewValue)

Sets the value of PlayersToValidate_Optional and also sets PlayersToValidate_IsSet to true using move semantics.

public inline void ClearPlayersToValidate()

Clears the value of PlayersToValidate_Optional and sets PlayersToValidate_IsSet to false.

public inline bool IsPlayersToValidateSet() const

Checks whether PlayersToValidate_Optional has been set.