RHAPI_Role

Summary

Members	Descriptions
struct FRHAPI_Role	Role 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

Members	Descriptions
public FString RoleId	Unique Role ID.
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 TArray< int32 > LoginLootRewards_Optional	List of loot table item 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.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const	Writes 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() const	Gets the value of RoleId.
public inline void SetRoleId(FString NewValue)	Sets the value of RoleId.
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(FRHAPI_JsonObject 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.
public inline TArray< int32 > & GetLoginLootRewards()	Gets the value of LoginLootRewards_Optional, regardless of it having been set.
public inline const TArray< int32 > & GetLoginLootRewards() const	Gets the value of LoginLootRewards_Optional, regardless of it having been set.
public inline const TArray< int32 > & GetLoginLootRewards(const TArray< int32 > & DefaultValue) const	Gets the value of LoginLootRewards_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLoginLootRewards(TArray< int32 > & OutValue) const	Fills OutValue with the value of LoginLootRewards_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< int32 > * GetLoginLootRewardsOrNull()	Returns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< int32 > * GetLoginLootRewardsOrNull() const	Returns a pointer to LoginLootRewards_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLoginLootRewards(TArray< int32 > NewValue)	Sets the value of LoginLootRewards_Optional and also sets LoginLootRewards_IsSet to true.
public inline void ClearLoginLootRewards()	Clears the value of LoginLootRewards_Optional and sets LoginLootRewards_IsSet to false.

Members

public FString RoleId

Unique Role ID.

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 TArray< int32 > LoginLootRewards_Optional

List of loot table item 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(FString NewValue)

Sets the value of RoleId.

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(FRHAPI_JsonObject 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.

public inline TArray< int32 > & GetLoginLootRewards()

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

public inline const TArray< int32 > & GetLoginLootRewards() const

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

public inline const TArray< int32 > & GetLoginLootRewards(const TArray< int32 > & DefaultValue) const

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

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

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

public inline TArray< int32 > * GetLoginLootRewardsOrNull()

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

public inline const TArray< int32 > * GetLoginLootRewardsOrNull() const

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

public inline void SetLoginLootRewards(TArray< int32 > NewValue)

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

public inline void ClearLoginLootRewards()

Clears the value of LoginLootRewards_Optional and sets LoginLootRewards_IsSet to false.