RHAPI_InventorySession
RHAPI_InventorySession
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InventorySession | Inventory Session for a Player. |
struct FRHAPI_InventorySession
struct FRHAPI_InventorySession
: public FRHAPI_ModelInventory Session for a Player.
Summary
| Members | Descriptions |
|---|---|
public FString SessionId | Unique ID for this Inventory Session. |
public ERHAPI_Platform SessionPlatform_Optional | Platform for this Inventory Session. |
public bool SessionPlatform_IsSet | true if SessionPlatform_Optional has been set to a value |
public TArray< int32 > AppliedDurableLoot_Optional | Durable Loot that has been applied when this Inventory Session was created. |
public bool AppliedDurableLoot_IsSet | true if AppliedDurableLoot_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 & GetSessionId() | Gets the value of SessionId. |
public inline const FString & GetSessionId() const | Gets the value of SessionId. |
public inline void SetSessionId(FString NewValue) | Sets the value of SessionId. |
public inline ERHAPI_Platform & GetSessionPlatform() | Gets the value of SessionPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetSessionPlatform() const | Gets the value of SessionPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetSessionPlatform(const ERHAPI_Platform & DefaultValue) const | Gets the value of SessionPlatform_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSessionPlatform(ERHAPI_Platform & OutValue) const | Fills OutValue with the value of SessionPlatform_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_Platform * GetSessionPlatformOrNull() | Returns a pointer to SessionPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_Platform * GetSessionPlatformOrNull() const | Returns a pointer to SessionPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSessionPlatform(ERHAPI_Platform NewValue) | Sets the value of SessionPlatform_Optional and also sets SessionPlatform_IsSet to true. |
public inline void ClearSessionPlatform() | Clears the value of SessionPlatform_Optional and sets SessionPlatform_IsSet to false. |
public inline TArray< int32 > & GetAppliedDurableLoot() | Gets the value of AppliedDurableLoot_Optional, regardless of it having been set. |
public inline const TArray< int32 > & GetAppliedDurableLoot() const | Gets the value of AppliedDurableLoot_Optional, regardless of it having been set. |
public inline const TArray< int32 > & GetAppliedDurableLoot(const TArray< int32 > & DefaultValue) const | Gets the value of AppliedDurableLoot_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetAppliedDurableLoot(TArray< int32 > & OutValue) const | Fills OutValue with the value of AppliedDurableLoot_Optional and returns true if it has been set, otherwise returns false. |
public inline TArray< int32 > * GetAppliedDurableLootOrNull() | Returns a pointer to AppliedDurableLoot_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< int32 > * GetAppliedDurableLootOrNull() const | Returns a pointer to AppliedDurableLoot_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetAppliedDurableLoot(TArray< int32 > NewValue) | Sets the value of AppliedDurableLoot_Optional and also sets AppliedDurableLoot_IsSet to true. |
public inline void ClearAppliedDurableLoot() | Clears the value of AppliedDurableLoot_Optional and sets AppliedDurableLoot_IsSet to false. |
Members
public FString SessionId
Unique ID for this Inventory Session.
#### `public ERHAPI_Platform `[`SessionPlatform_Optional`](#structFRHAPI__InventorySession_1a4ecfb1a090ef3ecaee13168cdefd26cf)
Platform for this Inventory Session.
#### `public bool `[`SessionPlatform_IsSet`](#structFRHAPI__InventorySession_1a243f2da591a0898aecb05f911c3c8ad1)
true if SessionPlatform_Optional has been set to a value
#### `public TArray< int32 > `[`AppliedDurableLoot_Optional`](#structFRHAPI__InventorySession_1a030b2590e3b6f227f40108949604cfcf)
Durable Loot that has been applied when this Inventory Session was created.
#### `public bool `[`AppliedDurableLoot_IsSet`](#structFRHAPI__InventorySession_1a7b4edec20f92776ba5f623561cd07b5e)
true if AppliedDurableLoot_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__InventorySession_1a82dfe9a883929188d8e1992dbe621c33)`(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`](#structFRHAPI__InventorySession_1aaf67e592061638455c03f23e9b6e6af0)`(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 & `[`GetSessionId`](#structFRHAPI__InventorySession_1a10cb51533bbbc8244080e85e17c09a76)`()`
Gets the value of SessionId.
#### `public inline const FString & `[`GetSessionId`](#structFRHAPI__InventorySession_1a202175283db4a05dd154c881b985eff4)`() const`
Gets the value of SessionId.
#### `public inline void `[`SetSessionId`](#structFRHAPI__InventorySession_1a25f0ed07ef974fe3bb288b0fd36e3e01)`(FString NewValue)`
Sets the value of SessionId.
#### `public inline ERHAPI_Platform & `[`GetSessionPlatform`](#structFRHAPI__InventorySession_1a20a6232c95b09797a1510a1a2ac1fc7d)`()`
Gets the value of SessionPlatform_Optional, regardless of it having been set.
#### `public inline const ERHAPI_Platform & `[`GetSessionPlatform`](#structFRHAPI__InventorySession_1a5f3d3d0b80da74d07ee84faf95ee5431)`() const`
Gets the value of SessionPlatform_Optional, regardless of it having been set.
#### `public inline const ERHAPI_Platform & `[`GetSessionPlatform`](#structFRHAPI__InventorySession_1ad1311408a74721f8317b0ac9826d75df)`(const ERHAPI_Platform & DefaultValue) const`
Gets the value of SessionPlatform_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetSessionPlatform`](#structFRHAPI__InventorySession_1a6eac73db464ca0efa6942e7b247992f3)`(ERHAPI_Platform & OutValue) const`
Fills OutValue with the value of SessionPlatform_Optional and returns true if it has been set, otherwise returns false.
#### `public inline ERHAPI_Platform * `[`GetSessionPlatformOrNull`](#structFRHAPI__InventorySession_1a45eb5a36fa089ca350d0738ac1342e86)`()`
Returns a pointer to SessionPlatform_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const ERHAPI_Platform * `[`GetSessionPlatformOrNull`](#structFRHAPI__InventorySession_1a775b96b8deafb53540f45fb6e7e1d029)`() const`
Returns a pointer to SessionPlatform_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetSessionPlatform`](#structFRHAPI__InventorySession_1a32e0d1d6d90a177a8cd0d7d3bbc46d50)`(ERHAPI_Platform NewValue)`
Sets the value of SessionPlatform_Optional and also sets SessionPlatform_IsSet to true.
#### `public inline void `[`ClearSessionPlatform`](#structFRHAPI__InventorySession_1a6606ed602284d4255e6bfc613d7e0619)`()`
Clears the value of SessionPlatform_Optional and sets SessionPlatform_IsSet to false.
#### `public inline TArray< int32 > & `[`GetAppliedDurableLoot`](#structFRHAPI__InventorySession_1aaa3a59128de3317f5d52ecaee8e89914)`()`
Gets the value of AppliedDurableLoot_Optional, regardless of it having been set.
#### `public inline const TArray< int32 > & `[`GetAppliedDurableLoot`](#structFRHAPI__InventorySession_1ae08db78edf3f9de2bd870863608f01be)`() const`
Gets the value of AppliedDurableLoot_Optional, regardless of it having been set.
#### `public inline const TArray< int32 > & `[`GetAppliedDurableLoot`](#structFRHAPI__InventorySession_1ac5f83cdf5324dd27e3157bcf4ecae4e0)`(const TArray< int32 > & DefaultValue) const`
Gets the value of AppliedDurableLoot_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetAppliedDurableLoot`](#structFRHAPI__InventorySession_1a19b3b9f32380d4a9e1dd821fec1b0f4a)`(TArray< int32 > & OutValue) const`
Fills OutValue with the value of AppliedDurableLoot_Optional and returns true if it has been set, otherwise returns false.
#### `public inline TArray< int32 > * `[`GetAppliedDurableLootOrNull`](#structFRHAPI__InventorySession_1aec8ec744eab2b5905327d176125b57e1)`()`
Returns a pointer to AppliedDurableLoot_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TArray< int32 > * `[`GetAppliedDurableLootOrNull`](#structFRHAPI__InventorySession_1ab3d2bd70b737c587bff6d5060f528657)`() const`
Returns a pointer to AppliedDurableLoot_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetAppliedDurableLoot`](#structFRHAPI__InventorySession_1a41c013be7c6b2d5d17464c1acd20d72d)`(TArray< int32 > NewValue)`
Sets the value of AppliedDurableLoot_Optional and also sets AppliedDurableLoot_IsSet to true.
#### `public inline void `[`ClearAppliedDurableLoot`](#structFRHAPI__InventorySession_1a6b43aeccd15ffee5e76a5fde895610d5)`()`
Clears the value of AppliedDurableLoot_Optional and sets AppliedDurableLoot_IsSet to false.