RHAPI_MatchmakingInfo
Summary
Members | Descriptions |
---|---|
struct FRHAPI_MatchmakingInfo | Info about the matchmaking status in a session. |
struct FRHAPI_MatchmakingInfo
Info about the matchmaking status in a session.
Summary
Members | Descriptions |
---|---|
public FString TicketId | Unique ID for this attempt at matchmaking. |
public TMap< FString, FString > CustomData_Optional | session-defined custom data |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public FString QueueId_Optional | Unique ID for the joined queue. |
public bool QueueId_IsSet | true if QueueId_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 & GetTicketId () | Gets the value of TicketId. |
public inline const FString & GetTicketId () const | Gets the value of TicketId. |
public inline void SetTicketId (FString NewValue) | Sets the value of TicketId. |
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. |
public inline FString & GetQueueId () | Gets the value of QueueId_Optional, regardless of it having been set. |
public inline const FString & GetQueueId () const | Gets the value of QueueId_Optional, regardless of it having been set. |
public inline const FString & GetQueueId (const FString & DefaultValue) const | Gets the value of QueueId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetQueueId (FString & OutValue) const | Fills OutValue with the value of QueueId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetQueueIdOrNull () | Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetQueueIdOrNull () const | Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetQueueId (FString NewValue) | Sets the value of QueueId_Optional and also sets QueueId_IsSet to true. |
public inline void ClearQueueId () | Clears the value of QueueId_Optional and sets QueueId_IsSet to false. |
Members
public FString
TicketId
Unique ID for this attempt at matchmaking.
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__MatchmakingInfo_1a800627839cbce5194f89db4579d5d14c)
session-defined custom data
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__MatchmakingInfo_1a0aa90688b46adb96245d4b9960649e7a)
true if CustomData_Optional has been set to a value
#### `public FString `[`QueueId_Optional`](#structFRHAPI__MatchmakingInfo_1a1d92d2cd37bae15182fc54edd8819290)
Unique ID for the joined queue.
#### `public bool `[`QueueId_IsSet`](#structFRHAPI__MatchmakingInfo_1a4f44d8b53c898eb786f281742ac1c9e2)
true if QueueId_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__MatchmakingInfo_1ac42b8b638994aa4afa39c062c7ca8ca0)`(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__MatchmakingInfo_1a5caf4c240571f435a14cef04fdfb37ae)`(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 & `[`GetTicketId`](#structFRHAPI__MatchmakingInfo_1a9cf459b92d8b3628d076579e339b9b84)`()`
Gets the value of TicketId.
#### `public inline const FString & `[`GetTicketId`](#structFRHAPI__MatchmakingInfo_1a11c0e0ef0b753761420d761d85bc7f27)`() const`
Gets the value of TicketId.
#### `public inline void `[`SetTicketId`](#structFRHAPI__MatchmakingInfo_1ac79e24ca3917259b076f28af6af3d187)`(FString NewValue)`
Sets the value of TicketId.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MatchmakingInfo_1a8e9a6e7143b93b2ba742203077505998)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MatchmakingInfo_1a3b59a2ff99e941c029cb4e6e222d2d68)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MatchmakingInfo_1a98a2b2b116f635394928749c83b7936a)`(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`](#structFRHAPI__MatchmakingInfo_1a4047fab0d1d749ea20956a659778cb2a)`(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`](#structFRHAPI__MatchmakingInfo_1a5756aab5970cf6e2c3ccb84085d79758)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__MatchmakingInfo_1aace731bdf5e36da712c3419d502f98d0)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__MatchmakingInfo_1ae2a4e3aad5d613c1b88688ccf0eabcc5)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__MatchmakingInfo_1a1f532bfd3ea96a7ea315d0981e7842a2)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
#### `public inline FString & `[`GetQueueId`](#structFRHAPI__MatchmakingInfo_1a62b052cb201b479fe8c6c147d535e720)`()`
Gets the value of QueueId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetQueueId`](#structFRHAPI__MatchmakingInfo_1ab41a9abec2c0e11cc1406c85de0a9679)`() const`
Gets the value of QueueId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetQueueId`](#structFRHAPI__MatchmakingInfo_1a9f8f5de68231a75cd9dbfa26f673ca39)`(const FString & DefaultValue) const`
Gets the value of QueueId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetQueueId`](#structFRHAPI__MatchmakingInfo_1a584aab184a4bff60dcb6061373324dac)`(FString & OutValue) const`
Fills OutValue with the value of QueueId_Optional and returns true if it has been set, otherwise returns false.
#### `public inline FString * `[`GetQueueIdOrNull`](#structFRHAPI__MatchmakingInfo_1a87acb0888cbe32068e631925c53db155)`()`
Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetQueueIdOrNull`](#structFRHAPI__MatchmakingInfo_1a83d1d5daa3780b0b2bf8ce76c8dca6c2)`() const`
Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetQueueId`](#structFRHAPI__MatchmakingInfo_1a11debe1f627cb103447728a5bebafe57)`(FString NewValue)`
Sets the value of QueueId_Optional and also sets QueueId_IsSet to true.
#### `public inline void `[`ClearQueueId`](#structFRHAPI__MatchmakingInfo_1a21d733a35471ef1059b550b810e33b31)`()`
Clears the value of QueueId_Optional and sets QueueId_IsSet to false.