RHAPI_SettingData
Summary
Members | Descriptions |
---|---|
struct FRHAPI_SettingData | Setting version/value data from a specific setting type/key for a player. |
struct FRHAPI_SettingData
struct FRHAPI_SettingData
: public FRHAPI_Model
Setting version/value data from a specific setting type/key for a player.
Summary
Members | Descriptions |
---|---|
public int32 V | Setting Version. |
public FRHAPI_JsonValue Value_Optional | Setting Value document. |
public bool Value_IsSet | true if Value_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 int32 & GetV () | Gets the value of V. |
public inline const int32 & GetV () const | Gets the value of V. |
public inline void SetV (int32 NewValue) | Sets the value of V. |
public inline bool IsVDefaultValue () const | Returns true if V matches the default value. |
public inline void SetVToDefault () | Sets the value of V to its default |
public inline FRHAPI_JsonValue & GetValue () | Gets the value of Value_Optional, regardless of it having been set. |
public inline const FRHAPI_JsonValue & GetValue () const | Gets the value of Value_Optional, regardless of it having been set. |
public inline const FRHAPI_JsonValue & GetValue (const FRHAPI_JsonValue & DefaultValue) const | Gets the value of Value_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetValue ( FRHAPI_JsonValue & OutValue) const | Fills OutValue with the value of Value_Optional and returns true if it has been set, otherwise returns false. |
public inline FRHAPI_JsonValue * GetValueOrNull () | Returns a pointer to Value_Optional, if it has been set, otherwise returns nullptr. |
public inline const FRHAPI_JsonValue * GetValueOrNull () const | Returns a pointer to Value_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetValue ( FRHAPI_JsonValue NewValue) | Sets the value of Value_Optional and also sets Value_IsSet to true. |
public inline void ClearValue () | Clears the value of Value_Optional and sets Value_IsSet to false. |
Members
public int32
V
Setting Version.
public
FRHAPI_JsonValue
Value_Optional
Setting Value document.
public bool
Value_IsSet
true if Value_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 int32 &
GetV
()
Gets the value of V.
public inline const int32 &
GetV
() const
Gets the value of V.
public inline void
SetV
(int32 NewValue)
Sets the value of V.
public inline bool
IsVDefaultValue
() const
Returns true if V matches the default value.
public inline void
SetVToDefault
()
Sets the value of V to its default
public inline
FRHAPI_JsonValue
&
GetValue
()
Gets the value of Value_Optional, regardless of it having been set.
public inline const
FRHAPI_JsonValue
&
GetValue
() const
Gets the value of Value_Optional, regardless of it having been set.
public inline const
FRHAPI_JsonValue
&
GetValue
(const
FRHAPI_JsonValue
& DefaultValue) const
Gets the value of Value_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetValue
(
FRHAPI_JsonValue
& OutValue) const
Fills OutValue with the value of Value_Optional and returns true if it has been set, otherwise returns false.
public inline
FRHAPI_JsonValue
*
GetValueOrNull
()
Returns a pointer to Value_Optional, if it has been set, otherwise returns nullptr.
public inline const
FRHAPI_JsonValue
*
GetValueOrNull
() const
Returns a pointer to Value_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetValue
(
FRHAPI_JsonValue
NewValue)
Sets the value of Value_Optional and also sets Value_IsSet to true.
public inline void
ClearValue
()
Clears the value of Value_Optional and sets Value_IsSet to false.