RHAPI_SettingTypeVersion
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_SettingTypeVersion |
struct FRHAPI_SettingTypeVersion
struct FRHAPI_SettingTypeVersion : public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
public bool AllowUpdate_Optional | Are players allowed to set/update keys to this version of the setting type? Does not affect getting or deleting existing settings. |
public bool AllowUpdate_IsSet | true if AllowUpdate_Optional has been set to a value |
public FString KeyRegex_Optional | Regex that is used to verify keys at assignment time. |
public bool KeyRegex_IsSet | true if KeyRegex_Optional has been set to a value |
public FRHAPI_JsonObject ValueJsonschema | jsonschema that is used to verify values at assignment time |
public TMap< FString, FString > CustomData_Optional | Custom data that was provided when the setting type was created. |
public bool CustomData_IsSet | true if CustomData_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 bool & GetAllowUpdate() | Gets the value of AllowUpdate_Optional, regardless of it having been set. |
public inline const bool & GetAllowUpdate() const | Gets the value of AllowUpdate_Optional, regardless of it having been set. |
public inline const bool & GetAllowUpdate(const bool & DefaultValue) const | Gets the value of AllowUpdate_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetAllowUpdate(bool & OutValue) const | Fills OutValue with the value of AllowUpdate_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetAllowUpdateOrNull() | Returns a pointer to AllowUpdate_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetAllowUpdateOrNull() const | Returns a pointer to AllowUpdate_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetAllowUpdate(bool NewValue) | Sets the value of AllowUpdate_Optional and also sets AllowUpdate_IsSet to true. |
public inline void ClearAllowUpdate() | Clears the value of AllowUpdate_Optional and sets AllowUpdate_IsSet to false. |
public inline bool IsAllowUpdateDefaultValue() const | Returns true if AllowUpdate_Optional is set and matches the default value. |
public inline void SetAllowUpdateToDefault() | Sets the value of AllowUpdate_Optional to its default and also sets AllowUpdate_IsSet to true. |
public inline FString & GetKeyRegex() | Gets the value of KeyRegex_Optional, regardless of it having been set. |
public inline const FString & GetKeyRegex() const | Gets the value of KeyRegex_Optional, regardless of it having been set. |
public inline const FString & GetKeyRegex(const FString & DefaultValue) const | Gets the value of KeyRegex_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetKeyRegex(FString & OutValue) const | Fills OutValue with the value of KeyRegex_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetKeyRegexOrNull() | Returns a pointer to KeyRegex_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetKeyRegexOrNull() const | Returns a pointer to KeyRegex_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetKeyRegex(FString NewValue) | Sets the value of KeyRegex_Optional and also sets KeyRegex_IsSet to true. |
public inline void ClearKeyRegex() | Clears the value of KeyRegex_Optional and sets KeyRegex_IsSet to false. |
public inline bool IsKeyRegexDefaultValue() const | Returns true if KeyRegex_Optional is set and matches the default value. |
public inline void SetKeyRegexToDefault() | Sets the value of KeyRegex_Optional to its default and also sets KeyRegex_IsSet to true. |
public inline FRHAPI_JsonObject&GetValueJsonschema() | Gets the value of ValueJsonschema. |
public inline const FRHAPI_JsonObject&GetValueJsonschema() const | Gets the value of ValueJsonschema. |
public inline void SetValueJsonschema(FRHAPI_JsonObject NewValue) | Sets the value of ValueJsonschema. |
public inline TMap< FString, FString > & GetCustomData() | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData() const | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const | Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const | Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetCustomDataOrNull() | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetCustomDataOrNull() const | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCustomData(TMap< FString, FString > NewValue) | Sets the value of CustomData_Optional and also sets CustomData_IsSet to true. |
public inline void ClearCustomData() | Clears the value of CustomData_Optional and sets CustomData_IsSet to false. |
Members
public bool AllowUpdate_Optional
Are players allowed to set/update keys to this version of the setting type? Does not affect getting or deleting existing settings.
public bool AllowUpdate_IsSet
true if AllowUpdate_Optional has been set to a value
public FString KeyRegex_Optional
Regex that is used to verify keys at assignment time.
public bool KeyRegex_IsSet
true if KeyRegex_Optional has been set to a value
public FRHAPI_JsonObject ValueJsonschema
jsonschema that is used to verify values at assignment time
public TMap< FString, FString > CustomData_Optional
Custom data that was provided when the setting type was created.
public bool CustomData_IsSet
true if CustomData_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 bool & GetAllowUpdate()
Gets the value of AllowUpdate_Optional, regardless of it having been set.
public inline const bool & GetAllowUpdate() const
Gets the value of AllowUpdate_Optional, regardless of it having been set.
public inline const bool & GetAllowUpdate(const bool & DefaultValue) const
Gets the value of AllowUpdate_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAllowUpdate(bool & OutValue) const
Fills OutValue with the value of AllowUpdate_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetAllowUpdateOrNull()
Returns a pointer to AllowUpdate_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetAllowUpdateOrNull() const
Returns a pointer to AllowUpdate_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAllowUpdate(bool NewValue)
Sets the value of AllowUpdate_Optional and also sets AllowUpdate_IsSet to true.
public inline void ClearAllowUpdate()
Clears the value of AllowUpdate_Optional and sets AllowUpdate_IsSet to false.
public inline bool IsAllowUpdateDefaultValue() const
Returns true if AllowUpdate_Optional is set and matches the default value.
public inline void SetAllowUpdateToDefault()
Sets the value of AllowUpdate_Optional to its default and also sets AllowUpdate_IsSet to true.
public inline FString & GetKeyRegex()
Gets the value of KeyRegex_Optional, regardless of it having been set.
public inline const FString & GetKeyRegex() const
Gets the value of KeyRegex_Optional, regardless of it having been set.
public inline const FString & GetKeyRegex(const FString & DefaultValue) const
Gets the value of KeyRegex_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetKeyRegex(FString & OutValue) const
Fills OutValue with the value of KeyRegex_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetKeyRegexOrNull()
Returns a pointer to KeyRegex_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetKeyRegexOrNull() const
Returns a pointer to KeyRegex_Optional, if it has been set, otherwise returns nullptr.
public inline void SetKeyRegex(FString NewValue)
Sets the value of KeyRegex_Optional and also sets KeyRegex_IsSet to true.
public inline void ClearKeyRegex()
Clears the value of KeyRegex_Optional and sets KeyRegex_IsSet to false.
public inline bool IsKeyRegexDefaultValue() const
Returns true if KeyRegex_Optional is set and matches the default value.
public inline void SetKeyRegexToDefault()
Sets the value of KeyRegex_Optional to its default and also sets KeyRegex_IsSet to true.
public inline FRHAPI_JsonObject&GetValueJsonschema()
Gets the value of ValueJsonschema.
public inline const FRHAPI_JsonObject&GetValueJsonschema() const
Gets the value of ValueJsonschema.
public inline void SetValueJsonschema(FRHAPI_JsonObject NewValue)
Sets the value of ValueJsonschema.
public inline TMap< FString, FString > & GetCustomData()
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() const
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const
Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > NewValue)
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.