Skip to main content

RHAPI_Role

Summary​

MembersDescriptions
struct FRHAPI_RoleRole object that is used to define a role for a player.

struct FRHAPI_Role ​

struct FRHAPI_Role
  : public FRHAPI_Model

Role object that is used to define a role for a player.

Summary​

MembersDescriptions
public FString RoleIdUnique Role ID.
public int32 LegacyRoleId_OptionalLegacy role ID.
public bool LegacyRoleId_IsSettrue if LegacyRoleId_Optional has been set to a value
public FRHAPI_JsonObject CustomData_OptionalCustom data for the role.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public ERHAPI_RoleAuthBypass AuthBypass_OptionalLevel of auth bypass for limited/locked modes.
public bool AuthBypass_IsSettrue if AuthBypass_Optional has been set to a value
public TArray< FRHAPI_LoginLootReward>LoginLootRewards_OptionalList of loot ids that are fulfilled for the player when they begin a new inventory session.
public bool LoginLootRewards_IsSettrue if LoginLootRewards_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) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetRoleId()Gets the value of RoleId.
public inline const FString & GetRoleId() constGets the value of RoleId.
public inline void SetRoleId(const FString & NewValue)Sets the value of RoleId.
public inline void SetRoleId(FString && NewValue)Sets the value of RoleId using move semantics.
public inline int32 & GetLegacyRoleId()Gets the value of LegacyRoleId_Optional, regardless of it having been set.
public inline const int32 & GetLegacyRoleId() constGets the value of LegacyRoleId_Optional, regardless of it having been set.
public inline const int32 & GetLegacyRoleId(const int32 & DefaultValue) constGets the value of LegacyRoleId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLegacyRoleId(int32 & OutValue) constFills OutValue with the value of LegacyRoleId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetLegacyRoleIdOrNull()Returns a pointer to LegacyRoleId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetLegacyRoleIdOrNull() constReturns a pointer to LegacyRoleId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLegacyRoleId(const int32 & NewValue)Sets the value of LegacyRoleId_Optional and also sets LegacyRoleId_IsSet to true.
public inline void SetLegacyRoleId(int32 && NewValue)Sets the value of LegacyRoleId_Optional and also sets LegacyRoleId_IsSet to true using move semantics.
public inline void ClearLegacyRoleId()Clears the value of LegacyRoleId_Optional and sets LegacyRoleId_IsSet to false.
public inline bool IsLegacyRoleIdSet() constChecks whether LegacyRoleId_Optional has been set.
public inline bool IsLegacyRoleIdDefaultValue() constReturns true if LegacyRoleId_Optional is set and matches the default value.
public inline void SetLegacyRoleIdToDefault()Sets the value of LegacyRoleId_Optional to its default and also sets LegacyRoleId_IsSet to true.
public inline FRHAPI_JsonObject&GetCustomData()Gets the value of CustomData_Optional, regardless of it having been set.
public inline const FRHAPI_JsonObject&GetCustomData() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const FRHAPI_JsonObject&GetCustomData(const FRHAPI_JsonObject & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(FRHAPI_JsonObject & OutValue) constFills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_JsonObject*GetCustomDataOrNull()Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_JsonObject*GetCustomDataOrNull() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(const FRHAPI_JsonObject & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(FRHAPI_JsonObject && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.
public inline ERHAPI_RoleAuthBypass & GetAuthBypass()Gets the value of AuthBypass_Optional, regardless of it having been set.
public inline const ERHAPI_RoleAuthBypass & GetAuthBypass() constGets the value of AuthBypass_Optional, regardless of it having been set.
public inline const ERHAPI_RoleAuthBypass & GetAuthBypass(const ERHAPI_RoleAuthBypass & DefaultValue) constGets the value of AuthBypass_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAuthBypass(ERHAPI_RoleAuthBypass & OutValue) constFills OutValue with the value of AuthBypass_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_RoleAuthBypass * GetAuthBypassOrNull()Returns a pointer to AuthBypass_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_RoleAuthBypass * GetAuthBypassOrNull() constReturns a pointer to AuthBypass_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAuthBypass(const ERHAPI_RoleAuthBypass & NewValue)Sets the value of AuthBypass_Optional and also sets AuthBypass_IsSet to true.
public inline void SetAuthBypass(ERHAPI_RoleAuthBypass && NewValue)Sets the value of AuthBypass_Optional and also sets AuthBypass_IsSet to true using move semantics.
public inline void ClearAuthBypass()Clears the value of AuthBypass_Optional and sets AuthBypass_IsSet to false.
public inline bool IsAuthBypassSet() constChecks whether AuthBypass_Optional has been set.
public inline TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards()Gets the value of LoginLootRewards_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards() constGets the value of LoginLootRewards_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards(const TArray< FRHAPI_LoginLootReward > & DefaultValue) constGets the value of LoginLootRewards_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLoginLootRewards(TArray< FRHAPI_LoginLootReward > & OutValue) constFills OutValue with the value of LoginLootRewards_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_LoginLootReward> *GetLoginLootRewardsOrNull()Returns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_LoginLootReward> *GetLoginLootRewardsOrNull() constReturns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLoginLootRewards(const TArray< FRHAPI_LoginLootReward > & NewValue)Sets the value of LoginLootRewards_Optional and also sets LoginLootRewards_IsSet to true.
public inline void SetLoginLootRewards(TArray< FRHAPI_LoginLootReward > && NewValue)Sets the value of LoginLootRewards_Optional and also sets LoginLootRewards_IsSet to true using move semantics.
public inline void ClearLoginLootRewards()Clears the value of LoginLootRewards_Optional and sets LoginLootRewards_IsSet to false.
public inline bool IsLoginLootRewardsSet() constChecks whether LoginLootRewards_Optional has been set.

Members​

public FString RoleId ​

Unique Role ID.

public int32 LegacyRoleId_Optional ​

Legacy role ID.

public bool LegacyRoleId_IsSet ​

true if LegacyRoleId_Optional has been set to a value

public FRHAPI_JsonObject CustomData_Optional ​

Custom data for the role.

public bool CustomData_IsSet ​

true if CustomData_Optional has been set to a value

public ERHAPI_RoleAuthBypass AuthBypass_Optional ​

Level of auth bypass for limited/locked modes.

public bool AuthBypass_IsSet ​

true if AuthBypass_Optional has been set to a value

public TArray< FRHAPI_LoginLootReward>LoginLootRewards_Optional ​

List of loot ids that are fulfilled for the player when they begin a new inventory session.

public bool LoginLootRewards_IsSet ​

true if LoginLootRewards_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 FString & GetRoleId() ​

Gets the value of RoleId.

public inline const FString & GetRoleId() const ​

Gets the value of RoleId.

public inline void SetRoleId(const FString & NewValue) ​

Sets the value of RoleId.

public inline void SetRoleId(FString && NewValue) ​

Sets the value of RoleId using move semantics.

public inline int32 & GetLegacyRoleId() ​

Gets the value of LegacyRoleId_Optional, regardless of it having been set.

public inline const int32 & GetLegacyRoleId() const ​

Gets the value of LegacyRoleId_Optional, regardless of it having been set.

public inline const int32 & GetLegacyRoleId(const int32 & DefaultValue) const ​

Gets the value of LegacyRoleId_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetLegacyRoleId(int32 & OutValue) const ​

Fills OutValue with the value of LegacyRoleId_Optional and returns true if it has been set, otherwise returns false.

public inline int32 * GetLegacyRoleIdOrNull() ​

Returns a pointer to LegacyRoleId_Optional, if it has been set, otherwise returns nullptr.

public inline const int32 * GetLegacyRoleIdOrNull() const ​

Returns a pointer to LegacyRoleId_Optional, if it has been set, otherwise returns nullptr.

public inline void SetLegacyRoleId(const int32 & NewValue) ​

Sets the value of LegacyRoleId_Optional and also sets LegacyRoleId_IsSet to true.

public inline void SetLegacyRoleId(int32 && NewValue) ​

Sets the value of LegacyRoleId_Optional and also sets LegacyRoleId_IsSet to true using move semantics.

public inline void ClearLegacyRoleId() ​

Clears the value of LegacyRoleId_Optional and sets LegacyRoleId_IsSet to false.

public inline bool IsLegacyRoleIdSet() const ​

Checks whether LegacyRoleId_Optional has been set.

public inline bool IsLegacyRoleIdDefaultValue() const ​

Returns true if LegacyRoleId_Optional is set and matches the default value.

public inline void SetLegacyRoleIdToDefault() ​

Sets the value of LegacyRoleId_Optional to its default and also sets LegacyRoleId_IsSet to true.

public inline FRHAPI_JsonObject&GetCustomData() ​

Gets the value of CustomData_Optional, regardless of it having been set.

public inline const FRHAPI_JsonObject&GetCustomData() const ​

Gets the value of CustomData_Optional, regardless of it having been set.

public inline const FRHAPI_JsonObject&GetCustomData(const FRHAPI_JsonObject & DefaultValue) const ​

Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetCustomData(FRHAPI_JsonObject & OutValue) const ​

Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.

public inline FRHAPI_JsonObject*GetCustomDataOrNull() ​

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.

public inline const FRHAPI_JsonObject*GetCustomDataOrNull() const ​

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.

public inline void SetCustomData(const FRHAPI_JsonObject & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(FRHAPI_JsonObject && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.

public inline ERHAPI_RoleAuthBypass & GetAuthBypass() ​

Gets the value of AuthBypass_Optional, regardless of it having been set.

public inline const ERHAPI_RoleAuthBypass & GetAuthBypass() const ​

Gets the value of AuthBypass_Optional, regardless of it having been set.

public inline const ERHAPI_RoleAuthBypass & GetAuthBypass(const ERHAPI_RoleAuthBypass & DefaultValue) const ​

Gets the value of AuthBypass_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetAuthBypass(ERHAPI_RoleAuthBypass & OutValue) const ​

Fills OutValue with the value of AuthBypass_Optional and returns true if it has been set, otherwise returns false.

public inline ERHAPI_RoleAuthBypass * GetAuthBypassOrNull() ​

Returns a pointer to AuthBypass_Optional, if it has been set, otherwise returns nullptr.

public inline const ERHAPI_RoleAuthBypass * GetAuthBypassOrNull() const ​

Returns a pointer to AuthBypass_Optional, if it has been set, otherwise returns nullptr.

public inline void SetAuthBypass(const ERHAPI_RoleAuthBypass & NewValue) ​

Sets the value of AuthBypass_Optional and also sets AuthBypass_IsSet to true.

public inline void SetAuthBypass(ERHAPI_RoleAuthBypass && NewValue) ​

Sets the value of AuthBypass_Optional and also sets AuthBypass_IsSet to true using move semantics.

public inline void ClearAuthBypass() ​

Clears the value of AuthBypass_Optional and sets AuthBypass_IsSet to false.

public inline bool IsAuthBypassSet() const ​

Checks whether AuthBypass_Optional has been set.

public inline TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards() ​

Gets the value of LoginLootRewards_Optional, regardless of it having been set.

public inline const TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards() const ​

Gets the value of LoginLootRewards_Optional, regardless of it having been set.

public inline const TArray< FRHAPI_LoginLootReward> &GetLoginLootRewards(const TArray< FRHAPI_LoginLootReward > & DefaultValue) const ​

Gets the value of LoginLootRewards_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetLoginLootRewards(TArray< FRHAPI_LoginLootReward > & OutValue) const ​

Fills OutValue with the value of LoginLootRewards_Optional and returns true if it has been set, otherwise returns false.

public inline TArray< FRHAPI_LoginLootReward> *GetLoginLootRewardsOrNull() ​

Returns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.

public inline const TArray< FRHAPI_LoginLootReward> *GetLoginLootRewardsOrNull() const ​

Returns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.

public inline void SetLoginLootRewards(const TArray< FRHAPI_LoginLootReward > & NewValue) ​

Sets the value of LoginLootRewards_Optional and also sets LoginLootRewards_IsSet to true.

public inline void SetLoginLootRewards(TArray< FRHAPI_LoginLootReward > && NewValue) ​

Sets the value of LoginLootRewards_Optional and also sets LoginLootRewards_IsSet to true using move semantics.

public inline void ClearLoginLootRewards() ​

Clears the value of LoginLootRewards_Optional and sets LoginLootRewards_IsSet to false.

public inline bool IsLoginLootRewardsSet() const ​

Checks whether LoginLootRewards_Optional has been set.