RHAPI_Rule
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_Rule | A rule to determine which MatchMakingTemplate should be used on a session entering matchmaking. |
struct FRHAPI_Rule
struct FRHAPI_Rule : public FRHAPI_ModelA rule to determine which MatchMakingTemplate should be used on a session entering matchmaking.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_RuleType RuleType | What type of rule this is. |
public int32 ItemId_Optional | Id of the item we are comparing if this is an inventory rule. |
public bool ItemId_IsSet | true if ItemId_Optional has been set to a value |
public ERHAPI_Operation ComparisonOperation | Comparison operation to be performed. |
public int32 ComparisonValue | Value to compare to. |
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 ERHAPI_RuleType & GetRuleType() | Gets the value of RuleType. |
public inline const ERHAPI_RuleType & GetRuleType() const | Gets the value of RuleType. |
public inline void SetRuleType(ERHAPI_RuleType NewValue) | Sets the value of RuleType. |
public inline int32 & GetItemId() | Gets the value of ItemId_Optional, regardless of it having been set. |
public inline const int32 & GetItemId() const | Gets the value of ItemId_Optional, regardless of it having been set. |
public inline const int32 & GetItemId(const int32 & DefaultValue) const | Gets the value of ItemId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetItemId(int32 & OutValue) const | Fills OutValue with the value of ItemId_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetItemIdOrNull() | Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetItemIdOrNull() const | Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetItemId(int32 NewValue) | Sets the value of ItemId_Optional and also sets ItemId_IsSet to true. |
public inline void ClearItemId() | Clears the value of ItemId_Optional and sets ItemId_IsSet to false. |
public inline bool IsItemIdDefaultValue() const | Returns true if ItemId_Optional is set and matches the default value. |
public inline void SetItemIdToDefault() | Sets the value of ItemId_Optional to its default and also sets ItemId_IsSet to true. |
public inline ERHAPI_Operation & GetComparisonOperation() | Gets the value of ComparisonOperation. |
public inline const ERHAPI_Operation & GetComparisonOperation() const | Gets the value of ComparisonOperation. |
public inline void SetComparisonOperation(ERHAPI_Operation NewValue) | Sets the value of ComparisonOperation. |
public inline int32 & GetComparisonValue() | Gets the value of ComparisonValue. |
public inline const int32 & GetComparisonValue() const | Gets the value of ComparisonValue. |
public inline void SetComparisonValue(int32 NewValue) | Sets the value of ComparisonValue. |
public inline bool IsComparisonValueDefaultValue() const | Returns true if ComparisonValue matches the default value. |
public inline void SetComparisonValueToDefault() | Sets the value of ComparisonValue to its default |
Members
public ERHAPI_RuleType RuleType
What type of rule this is.
public int32 ItemId_Optional
Id of the item we are comparing if this is an inventory rule.
public bool ItemId_IsSet
true if ItemId_Optional has been set to a value
public ERHAPI_Operation ComparisonOperation
Comparison operation to be performed.
public int32 ComparisonValue
Value to compare to.
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 ERHAPI_RuleType & GetRuleType()
Gets the value of RuleType.
public inline const ERHAPI_RuleType & GetRuleType() const
Gets the value of RuleType.
public inline void SetRuleType(ERHAPI_RuleType NewValue)
Sets the value of RuleType.
public inline int32 & GetItemId()
Gets the value of ItemId_Optional, regardless of it having been set.
public inline const int32 & GetItemId() const
Gets the value of ItemId_Optional, regardless of it having been set.
public inline const int32 & GetItemId(const int32 & DefaultValue) const
Gets the value of ItemId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetItemId(int32 & OutValue) const
Fills OutValue with the value of ItemId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetItemIdOrNull()
Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetItemIdOrNull() const
Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetItemId(int32 NewValue)
Sets the value of ItemId_Optional and also sets ItemId_IsSet to true.
public inline void ClearItemId()
Clears the value of ItemId_Optional and sets ItemId_IsSet to false.
public inline bool IsItemIdDefaultValue() const
Returns true if ItemId_Optional is set and matches the default value.
public inline void SetItemIdToDefault()
Sets the value of ItemId_Optional to its default and also sets ItemId_IsSet to true.
public inline ERHAPI_Operation & GetComparisonOperation()
Gets the value of ComparisonOperation.
public inline const ERHAPI_Operation & GetComparisonOperation() const
Gets the value of ComparisonOperation.
public inline void SetComparisonOperation(ERHAPI_Operation NewValue)
Sets the value of ComparisonOperation.
public inline int32 & GetComparisonValue()
Gets the value of ComparisonValue.
public inline const int32 & GetComparisonValue() const
Gets the value of ComparisonValue.
public inline void SetComparisonValue(int32 NewValue)
Sets the value of ComparisonValue.
public inline bool IsComparisonValueDefaultValue() const
Returns true if ComparisonValue matches the default value.
public inline void SetComparisonValueToDefault()
Sets the value of ComparisonValue to its default