Skip to main content

RHAPI_SetSinglePlayerSettingRequest

Summary

MembersDescriptions
struct FRHAPI_SetSinglePlayerSettingRequestUpdatable contents of a setting document for a player.

struct FRHAPI_SetSinglePlayerSettingRequest

struct FRHAPI_SetSinglePlayerSettingRequest
: public FRHAPI_Model

Updatable contents of a setting document for a player.

Summary

MembersDescriptions
public int32 VSetting Type Version to update setting for. Must be a valid version for the setting type.
public FRHAPI_JsonValue ValueNew value document for the setting. Must conform to the jsonschema defined for the setting type+version.
public bool Value_IsNulltrue if Value has been explicitly set to null
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 int32 & GetV()Gets the value of V.
public inline const int32 & GetV() constGets the value of V.
public inline void SetV(const int32 & NewValue)Sets the value of V.
public inline void SetV(int32 && NewValue)Sets the value of V using move semantics.
public inline bool IsVDefaultValue() constReturns 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.
public inline const FRHAPI_JsonValue&GetValue() constGets the value of Value.
public inline void SetValue(const FRHAPI_JsonValue & NewValue)Sets the value of Value.
public inline void SetValue(FRHAPI_JsonValue && NewValue)Sets the value of Value using move semantics.
public inline void SetValueToNull()Sets the value explicitly to be treated as null.
public inline bool IsValueNull() constChecks whether Value is set to null.

Members

public int32 V

Setting Type Version to update setting for. Must be a valid version for the setting type.

public FRHAPI_JsonValue Value

New value document for the setting. Must conform to the jsonschema defined for the setting type+version.

public bool Value_IsNull

true if Value has been explicitly set to null

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(const int32 & NewValue)

Sets the value of V.

public inline void SetV(int32 && NewValue)

Sets the value of V using move semantics.

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.

public inline const FRHAPI_JsonValue&GetValue() const

Gets the value of Value.

public inline void SetValue(const FRHAPI_JsonValue & NewValue)

Sets the value of Value.

public inline void SetValue(FRHAPI_JsonValue && NewValue)

Sets the value of Value using move semantics.

public inline void SetValueToNull()

Sets the value explicitly to be treated as null.

public inline bool IsValueNull() const

Checks whether Value is set to null.