RHAPI_InventoryRecord
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InventoryRecord | Inventory Record for a Player. |
struct FRHAPI_InventoryRecord
struct FRHAPI_InventoryRecord
: public FRHAPI_ModelInventory Record for a Player.
Summary
| Members | Descriptions |
|---|---|
public FGuid InventoryId | Unique ID for this Inventory Record. |
public ERHAPI_InventoryType Type | Type of Inventory Record. |
public int64 LegacyInventoryId_Optional | Legacy Inventory ID. |
public bool LegacyInventoryId_IsSet | true if LegacyInventoryId_Optional has been set to a value |
public ERHAPI_InventoryBucket Bucket_Optional | Bucket for this Inventory Record. |
public bool Bucket_IsSet | true if Bucket_Optional has been set to a value |
public int32 Count | Instance count for this Inventory Record. |
public FDateTime Acquired | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public FDateTime Expires_Optional | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public bool Expires_IsSet | true if Expires_Optional has been set to a value |
public TMap< FString, FString > CustomData_Optional | Arbitrary map of data for this Inventory Record. |
public bool CustomData_IsSet | true if CustomData_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 FGuid & GetInventoryId() | Gets the value of InventoryId. |
public inline const FGuid & GetInventoryId() const | Gets the value of InventoryId. |
public inline void SetInventoryId(FGuid NewValue) | Sets the value of InventoryId. |
public inline ERHAPI_InventoryType & GetType() | Gets the value of Type. |
public inline const ERHAPI_InventoryType & GetType() const | Gets the value of Type. |
public inline void SetType(ERHAPI_InventoryType NewValue) | Sets the value of Type. |
public inline int64 & GetLegacyInventoryId() | Gets the value of LegacyInventoryId_Optional, regardless of it having been set. |
public inline const int64 & GetLegacyInventoryId() const | Gets the value of LegacyInventoryId_Optional, regardless of it having been set. |
public inline const int64 & GetLegacyInventoryId(const int64 & DefaultValue) const | Gets the value of LegacyInventoryId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLegacyInventoryId(int64 & OutValue) const | Fills OutValue with the value of LegacyInventoryId_Optional and returns true if it has been set, otherwise returns false. |
public inline int64 * GetLegacyInventoryIdOrNull() | Returns a pointer to LegacyInventoryId_Optional, if it has been set, otherwise returns nullptr. |
public inline const int64 * GetLegacyInventoryIdOrNull() const | Returns a pointer to LegacyInventoryId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLegacyInventoryId(int64 NewValue) | Sets the value of LegacyInventoryId_Optional and also sets LegacyInventoryId_IsSet to true. |
public inline void ClearLegacyInventoryId() | Clears the value of LegacyInventoryId_Optional and sets LegacyInventoryId_IsSet to false. |
public inline bool IsLegacyInventoryIdDefaultValue() const | Returns true if LegacyInventoryId_Optional is set and matches the default value. |
public inline void SetLegacyInventoryIdToDefault() | Sets the value of LegacyInventoryId_Optional to its default and also sets LegacyInventoryId_IsSet to true. |
public inline ERHAPI_InventoryBucket & GetBucket() | Gets the value of Bucket_Optional, regardless of it having been set. |
public inline const ERHAPI_InventoryBucket & GetBucket() const | Gets the value of Bucket_Optional, regardless of it having been set. |
public inline const ERHAPI_InventoryBucket & GetBucket(const ERHAPI_InventoryBucket & DefaultValue) const | Gets the value of Bucket_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetBucket(ERHAPI_InventoryBucket & OutValue) const | Fills OutValue with the value of Bucket_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_InventoryBucket * GetBucketOrNull() | Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_InventoryBucket * GetBucketOrNull() const | Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetBucket(ERHAPI_InventoryBucket NewValue) | Sets the value of Bucket_Optional and also sets Bucket_IsSet to true. |
public inline void ClearBucket() | Clears the value of Bucket_Optional and sets Bucket_IsSet to false. |
public inline int32 & GetCount() | Gets the value of Count. |
public inline const int32 & GetCount() const | Gets the value of Count. |
public inline void SetCount(int32 NewValue) | Sets the value of Count. |
public inline bool IsCountDefaultValue() const | Returns true if Count matches the default value. |
public inline void SetCountToDefault() | Sets the value of Count to its default |
public inline FDateTime & GetAcquired() | Gets the value of Acquired. |
public inline const FDateTime & GetAcquired() const | Gets the value of Acquired. |
public inline void SetAcquired(FDateTime NewValue) | Sets the value of Acquired. |
public inline FDateTime & GetExpires() | Gets the value of Expires_Optional, regardless of it having been set. |
public inline const FDateTime & GetExpires() const | Gets the value of Expires_Optional, regardless of it having been set. |
public inline const FDateTime & GetExpires(const FDateTime & DefaultValue) const | Gets the value of Expires_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetExpires(FDateTime & OutValue) const | Fills OutValue with the value of Expires_Optional and returns true if it has been set, otherwise returns false. |
public inline FDateTime * GetExpiresOrNull() | Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr. |
public inline const FDateTime * GetExpiresOrNull() const | Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetExpires(FDateTime NewValue) | Sets the value of Expires_Optional and also sets Expires_IsSet to true. |
public inline void ClearExpires() | Clears the value of Expires_Optional and sets Expires_IsSet to false. |
public inline TMap< FString, FString > & GetCustomData() | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData() const | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const | Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const | Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetCustomDataOrNull() | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetCustomDataOrNull() const | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCustomData(TMap< FString, FString > 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. |
Members
public FGuid InventoryId
Unique ID for this Inventory Record.
public ERHAPI_InventoryType Type
Type of Inventory Record.
public int64 LegacyInventoryId_Optional
Legacy Inventory ID.
public bool LegacyInventoryId_IsSet
true if LegacyInventoryId_Optional has been set to a value
public ERHAPI_InventoryBucket Bucket_Optional
Bucket for this Inventory Record.
public bool Bucket_IsSet
true if Bucket_Optional has been set to a value
public int32 Count
Instance count for this Inventory Record.
public FDateTime Acquired
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public FDateTime Expires_Optional
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool Expires_IsSet
true if Expires_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional
Arbitrary map of data for this Inventory Record.
public bool CustomData_IsSet
true if CustomData_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 FGuid & GetInventoryId()
Gets the value of InventoryId.
public inline const FGuid & GetInventoryId() const
Gets the value of InventoryId.
public inline void SetInventoryId(FGuid NewValue)
Sets the value of InventoryId.
public inline ERHAPI_InventoryType & GetType()
Gets the value of Type.
public inline const ERHAPI_InventoryType & GetType() const
Gets the value of Type.
public inline void SetType(ERHAPI_InventoryType NewValue)
Sets the value of Type.
public inline int64 & GetLegacyInventoryId()
Gets the value of LegacyInventoryId_Optional, regardless of it having been set.
public inline const int64 & GetLegacyInventoryId() const
Gets the value of LegacyInventoryId_Optional, regardless of it having been set.
public inline const int64 & GetLegacyInventoryId(const int64 & DefaultValue) const
Gets the value of LegacyInventoryId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLegacyInventoryId(int64 & OutValue) const
Fills OutValue with the value of LegacyInventoryId_Optional and returns true if it has been set, otherwise returns false.
public inline int64 * GetLegacyInventoryIdOrNull()
Returns a pointer to LegacyInventoryId_Optional, if it has been set, otherwise returns nullptr.
public inline const int64 * GetLegacyInventoryIdOrNull() const
Returns a pointer to LegacyInventoryId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLegacyInventoryId(int64 NewValue)
Sets the value of LegacyInventoryId_Optional and also sets LegacyInventoryId_IsSet to true.
public inline void ClearLegacyInventoryId()
Clears the value of LegacyInventoryId_Optional and sets LegacyInventoryId_IsSet to false.
public inline bool IsLegacyInventoryIdDefaultValue() const
Returns true if LegacyInventoryId_Optional is set and matches the default value.
public inline void SetLegacyInventoryIdToDefault()
Sets the value of LegacyInventoryId_Optional to its default and also sets LegacyInventoryId_IsSet to true.
public inline ERHAPI_InventoryBucket & GetBucket()
Gets the value of Bucket_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryBucket & GetBucket() const
Gets the value of Bucket_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryBucket & GetBucket(const ERHAPI_InventoryBucket & DefaultValue) const
Gets the value of Bucket_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetBucket(ERHAPI_InventoryBucket & OutValue) const
Fills OutValue with the value of Bucket_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_InventoryBucket * GetBucketOrNull()
Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_InventoryBucket * GetBucketOrNull() const
Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr.
public inline void SetBucket(ERHAPI_InventoryBucket NewValue)
Sets the value of Bucket_Optional and also sets Bucket_IsSet to true.
public inline void ClearBucket()
Clears the value of Bucket_Optional and sets Bucket_IsSet to false.
public inline int32 & GetCount()
Gets the value of Count.
public inline const int32 & GetCount() const
Gets the value of Count.
public inline void SetCount(int32 NewValue)
Sets the value of Count.
public inline bool IsCountDefaultValue() const
Returns true if Count matches the default value.
public inline void SetCountToDefault()
Sets the value of Count to its default
public inline FDateTime & GetAcquired()
Gets the value of Acquired.
public inline const FDateTime & GetAcquired() const
Gets the value of Acquired.
public inline void SetAcquired(FDateTime NewValue)
Sets the value of Acquired.
public inline FDateTime & GetExpires()
Gets the value of Expires_Optional, regardless of it having been set.
public inline const FDateTime & GetExpires() const
Gets the value of Expires_Optional, regardless of it having been set.
public inline const FDateTime & GetExpires(const FDateTime & DefaultValue) const
Gets the value of Expires_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExpires(FDateTime & OutValue) const
Fills OutValue with the value of Expires_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetExpiresOrNull()
Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetExpiresOrNull() const
Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExpires(FDateTime NewValue)
Sets the value of Expires_Optional and also sets Expires_IsSet to true.
public inline void ClearExpires()
Clears the value of Expires_Optional and sets Expires_IsSet to false.
public inline TMap< FString, FString > & GetCustomData()
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() const
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const
Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > 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.