Skip to 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 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< int32 > LoginLootRewards_OptionalList of loot table item 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(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() 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(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 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(ERHAPI_RoleAuthBypass NewValue)Sets the value of AuthBypass_Optional and also sets AuthBypass_IsSet to true.
public inline void ClearAuthBypass()Clears the value of AuthBypass_Optional and sets AuthBypass_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() constGets the value of LoginLootRewards_Optional, regardless of it having been set.
public inline const TArray< int32 > & GetLoginLootRewards(const TArray< int32 > & DefaultValue) constGets the value of LoginLootRewards_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLoginLootRewards(TArray< int32 > & OutValue) constFills 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() constReturns 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`](undefined.md#structFRHAPI__JsonObject)` `[`CustomData_Optional`](#structFRHAPI__Role_1ab56bcc46d8e231e0c8970cf4b28806c4)

Custom data for the role.


#### `public bool `[`CustomData_IsSet`](#structFRHAPI__Role_1a7009c6fa9d36ddb72c54a9658b63e42d)

true if CustomData_Optional has been set to a value


#### `public ERHAPI_RoleAuthBypass `[`AuthBypass_Optional`](#structFRHAPI__Role_1a8e0230998648ffb297d56c4605a1332d)

Level of auth bypass for limited/locked modes.


#### `public bool `[`AuthBypass_IsSet`](#structFRHAPI__Role_1a950879446b1d18137f3af343f23fc8d1)

true if AuthBypass_Optional has been set to a value


#### `public TArray< int32 > `[`LoginLootRewards_Optional`](#structFRHAPI__Role_1a5085d5aa449f92dbb0cb0c236f476b86)

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


#### `public bool `[`LoginLootRewards_IsSet`](#structFRHAPI__Role_1a6e132dc93f9582659561567ad17f151c)

true if LoginLootRewards_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__Role_1a229641efe3ca109c0f3c7b53422b42ad)`(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`](#structFRHAPI__Role_1ae845c90d963aeb9ae58170a483d25275)`(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`](#structFRHAPI__Role_1a49452f02b34778848d259e045e851009)`()`

Gets the value of RoleId.


#### `public inline const FString & `[`GetRoleId`](#structFRHAPI__Role_1ac0647a02b144923a4cd8580a1dc2e57b)`() const`

Gets the value of RoleId.


#### `public inline void `[`SetRoleId`](#structFRHAPI__Role_1a9f7686e73ba330fc24da8745bd76ec5c)`(FString NewValue)`

Sets the value of RoleId.


#### `public inline `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & `[`GetCustomData`](#structFRHAPI__Role_1a6a89b0beabb5a58ef2732b747c52c3f5)`()`

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


#### `public inline const `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & `[`GetCustomData`](#structFRHAPI__Role_1a6f0ff8d950da4423d60febbad9613730)`() const`

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


#### `public inline const `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & `[`GetCustomData`](#structFRHAPI__Role_1a07133ecd6ca89b5c37506def2ef52e2a)`(const `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & DefaultValue) const`

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


#### `public inline bool `[`GetCustomData`](#structFRHAPI__Role_1abb29df8d12a7138ea24fb4eb2846eec8)`(`[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__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`](undefined.md#structFRHAPI__JsonObject)` * `[`GetCustomDataOrNull`](#structFRHAPI__Role_1a8bf58372a5ac17505435fffd2d03e1d3)`()`

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


#### `public inline const `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` * `[`GetCustomDataOrNull`](#structFRHAPI__Role_1ae8305c6970feae2fff88f38b4e4064bb)`() const`

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


#### `public inline void `[`SetCustomData`](#structFRHAPI__Role_1ab88a5bb3ecf915fd1576007efca37877)`(`[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` NewValue)`

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


#### `public inline void `[`ClearCustomData`](#structFRHAPI__Role_1ad396c9bca677e071fe8d14d0e7ec2c72)`()`

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.


#### `public inline ERHAPI_RoleAuthBypass & `[`GetAuthBypass`](#structFRHAPI__Role_1a96717a2f39eeab5e35efc25fc997d6fb)`()`

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


#### `public inline const ERHAPI_RoleAuthBypass & `[`GetAuthBypass`](#structFRHAPI__Role_1a176cc7996b1a51c4db7eb9342e4e1577)`() const`

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


#### `public inline const ERHAPI_RoleAuthBypass & `[`GetAuthBypass`](#structFRHAPI__Role_1a9a2f320042ee44649cfc88afcdefff58)`(const ERHAPI_RoleAuthBypass & DefaultValue) const`

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


#### `public inline bool `[`GetAuthBypass`](#structFRHAPI__Role_1a8c7e8e6738df06e4828df0fbde8ee0f1)`(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`](#structFRHAPI__Role_1a3c8cfc1bea5fb9275e3a34a0d442f6e3)`()`

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


#### `public inline const ERHAPI_RoleAuthBypass * `[`GetAuthBypassOrNull`](#structFRHAPI__Role_1a588ea5b537363e4def3ece41944e694c)`() const`

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


#### `public inline void `[`SetAuthBypass`](#structFRHAPI__Role_1af518f2a9a12392cde65e1b434914a3cf)`(ERHAPI_RoleAuthBypass NewValue)`

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


#### `public inline void `[`ClearAuthBypass`](#structFRHAPI__Role_1a9385618ce915da9fa5f1fea764d32026)`()`

Clears the value of AuthBypass_Optional and sets AuthBypass_IsSet to false.


#### `public inline TArray< int32 > & `[`GetLoginLootRewards`](#structFRHAPI__Role_1a85e8879b4b2fbd1984816123c7bd7c63)`()`

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


#### `public inline const TArray< int32 > & `[`GetLoginLootRewards`](#structFRHAPI__Role_1a00f845665922f1e86a648b164d1f4d4d)`() const`

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


#### `public inline const TArray< int32 > & `[`GetLoginLootRewards`](#structFRHAPI__Role_1af667b94f1457c4162846587ab1c81bd8)`(const TArray< int32 > & DefaultValue) const`

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


#### `public inline bool `[`GetLoginLootRewards`](#structFRHAPI__Role_1ac995d6d055b323f552a834e750652754)`(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`](#structFRHAPI__Role_1af16dec3e5e36570a7089df6038b2bfa3)`()`

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


#### `public inline const TArray< int32 > * `[`GetLoginLootRewardsOrNull`](#structFRHAPI__Role_1a59107e4c9555de012c1fdb8ebed12e2a)`() const`

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


#### `public inline void `[`SetLoginLootRewards`](#structFRHAPI__Role_1a420acb1ad3fd91c2a7d1f97d6e1e17d3)`(TArray< int32 > NewValue)`

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


#### `public inline void `[`ClearLoginLootRewards`](#structFRHAPI__Role_1aa842b6af31f9b729dc3d1783c58a143d)`()`

Clears the value of LoginLootRewards_Optional and sets LoginLootRewards_IsSet to false.