RHAPI_Region
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_Region | Information about a specific region. |
struct FRHAPI_Region
struct FRHAPI_Region
: public FRHAPI_ModelInformation about a specific region.
Summary
| Members | Descriptions |
|---|---|
public FString RegionId | ID for this region. |
public int32 SortOrder | The sorting priority order for this region. |
public bool CustomOnly | Indicates if the region is for custom games only. |
public FString Description_Optional | Text description of the region. |
public bool Description_IsSet | true if Description_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 FString & GetRegionId() | Gets the value of RegionId. |
public inline const FString & GetRegionId() const | Gets the value of RegionId. |
public inline void SetRegionId(FString NewValue) | Sets the value of RegionId. |
public inline int32 & GetSortOrder() | Gets the value of SortOrder. |
public inline const int32 & GetSortOrder() const | Gets the value of SortOrder. |
public inline void SetSortOrder(int32 NewValue) | Sets the value of SortOrder. |
public inline bool IsSortOrderDefaultValue() const | Returns true if SortOrder matches the default value. |
public inline void SetSortOrderToDefault() | Sets the value of SortOrder to its default |
public inline bool & GetCustomOnly() | Gets the value of CustomOnly. |
public inline const bool & GetCustomOnly() const | Gets the value of CustomOnly. |
public inline void SetCustomOnly(bool NewValue) | Sets the value of CustomOnly. |
public inline bool IsCustomOnlyDefaultValue() const | Returns true if CustomOnly matches the default value. |
public inline void SetCustomOnlyToDefault() | Sets the value of CustomOnly to its default |
public inline FString & GetDescription() | Gets the value of Description_Optional, regardless of it having been set. |
public inline const FString & GetDescription() const | Gets the value of Description_Optional, regardless of it having been set. |
public inline const FString & GetDescription(const FString & DefaultValue) const | Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetDescription(FString & OutValue) const | Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetDescriptionOrNull() | Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetDescriptionOrNull() const | Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetDescription(FString NewValue) | Sets the value of Description_Optional and also sets Description_IsSet to true. |
public inline void ClearDescription() | Clears the value of Description_Optional and sets Description_IsSet to false. |
Members
public FString RegionId
ID for this region.
public int32 SortOrder
The sorting priority order for this region.
public bool CustomOnly
Indicates if the region is for custom games only.
public FString Description_Optional
Text description of the region.
public bool Description_IsSet
true if Description_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 FString & GetRegionId()
Gets the value of RegionId.
public inline const FString & GetRegionId() const
Gets the value of RegionId.
public inline void SetRegionId(FString NewValue)
Sets the value of RegionId.
public inline int32 & GetSortOrder()
Gets the value of SortOrder.
public inline const int32 & GetSortOrder() const
Gets the value of SortOrder.
public inline void SetSortOrder(int32 NewValue)
Sets the value of SortOrder.
public inline bool IsSortOrderDefaultValue() const
Returns true if SortOrder matches the default value.
public inline void SetSortOrderToDefault()
Sets the value of SortOrder to its default
public inline bool & GetCustomOnly()
Gets the value of CustomOnly.
public inline const bool & GetCustomOnly() const
Gets the value of CustomOnly.
public inline void SetCustomOnly(bool NewValue)
Sets the value of CustomOnly.
public inline bool IsCustomOnlyDefaultValue() const
Returns true if CustomOnly matches the default value.
public inline void SetCustomOnlyToDefault()
Sets the value of CustomOnly to its default
public inline FString & GetDescription()
Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription() const
Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription(const FString & DefaultValue) const
Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDescription(FString & OutValue) const
Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDescriptionOrNull()
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDescriptionOrNull() const
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDescription(FString NewValue)
Sets the value of Description_Optional and also sets Description_IsSet to true.
public inline void ClearDescription()
Clears the value of Description_Optional and sets Description_IsSet to false.