RHAPI_SiteSettings
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_SiteSettings | Contains information about a site/region. |
struct FRHAPI_SiteSettings
struct FRHAPI_SiteSettings
: public FRHAPI_ModelContains information about a site/region.
Summary
| Members | Descriptions |
|---|---|
public int32 SiteId | The site ID. |
public int32 SortOrder | The priority order of this site. |
public bool CustomOnly | Indicates if the site is a custom games only. |
public FString MessageName_Optional | The message associated with this site. |
public bool MessageName_IsSet | true if MessageName_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 & GetSiteId() | Gets the value of SiteId. |
public inline const int32 & GetSiteId() const | Gets the value of SiteId. |
public inline void SetSiteId(int32 NewValue) | Sets the value of SiteId. |
public inline bool IsSiteIdDefaultValue() const | Returns true if SiteId matches the default value. |
public inline void SetSiteIdToDefault() | Sets the value of SiteId to its default |
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 & GetMessageName() | Gets the value of MessageName_Optional, regardless of it having been set. |
public inline const FString & GetMessageName() const | Gets the value of MessageName_Optional, regardless of it having been set. |
public inline const FString & GetMessageName(const FString & DefaultValue) const | Gets the value of MessageName_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMessageName(FString & OutValue) const | Fills OutValue with the value of MessageName_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetMessageNameOrNull() | Returns a pointer to MessageName_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetMessageNameOrNull() const | Returns a pointer to MessageName_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMessageName(FString NewValue) | Sets the value of MessageName_Optional and also sets MessageName_IsSet to true. |
public inline void ClearMessageName() | Clears the value of MessageName_Optional and sets MessageName_IsSet to false. |
Members
public int32 SiteId
The site ID.
public int32 SortOrder
The priority order of this site.
public bool CustomOnly
Indicates if the site is a custom games only.
public FString MessageName_Optional
The message associated with this site.
public bool MessageName_IsSet
true if MessageName_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 int32 & GetSiteId()
Gets the value of SiteId.
public inline const int32 & GetSiteId() const
Gets the value of SiteId.
public inline void SetSiteId(int32 NewValue)
Sets the value of SiteId.
public inline bool IsSiteIdDefaultValue() const
Returns true if SiteId matches the default value.
public inline void SetSiteIdToDefault()
Sets the value of SiteId to its default
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 & GetMessageName()
Gets the value of MessageName_Optional, regardless of it having been set.
public inline const FString & GetMessageName() const
Gets the value of MessageName_Optional, regardless of it having been set.
public inline const FString & GetMessageName(const FString & DefaultValue) const
Gets the value of MessageName_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMessageName(FString & OutValue) const
Fills OutValue with the value of MessageName_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetMessageNameOrNull()
Returns a pointer to MessageName_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetMessageNameOrNull() const
Returns a pointer to MessageName_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMessageName(FString NewValue)
Sets the value of MessageName_Optional and also sets MessageName_IsSet to true.
public inline void ClearMessageName()
Clears the value of MessageName_Optional and sets MessageName_IsSet to false.