RHAPI_BrowserSessionInfo
Summary
Members | Descriptions |
---|---|
struct FRHAPI_BrowserSessionInfo | Information about a session listed in a browser. |
struct FRHAPI_BrowserSessionInfo
struct FRHAPI_BrowserSessionInfo : public FRHAPI_Model
Information about a session listed in a browser.
Summary
Members | Descriptions |
---|---|
public FString SessionId | ID for the session. |
public int32 PlayerCount_Optional | Number of players actively in this session. |
public bool PlayerCount_IsSet | true if PlayerCount_Optional has been set to a value |
public int32 MaxPlayerCount_Optional | Maximum number of players that can be in this session. |
public bool MaxPlayerCount_IsSet | true if MaxPlayerCount_Optional has been set to a value |
public TMap< FString, FString > CustomData_Optional | Custom data with the listing of the instance in the Session browser. |
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 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 int32 & GetPlayerCount () | Gets the value of PlayerCount_Optional, regardless of it having been set. |
public inline const int32 & GetPlayerCount () const | Gets the value of PlayerCount_Optional, regardless of it having been set. |
public inline const int32 & GetPlayerCount (const int32 & DefaultValue) const | Gets the value of PlayerCount_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetPlayerCount (int32 & OutValue) const | Fills OutValue with the value of PlayerCount_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetPlayerCountOrNull () | Returns a pointer to PlayerCount_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetPlayerCountOrNull () const | Returns a pointer to PlayerCount_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetPlayerCount (int32 NewValue) | Sets the value of PlayerCount_Optional and also sets PlayerCount_IsSet to true. |
public inline void ClearPlayerCount () | Clears the value of PlayerCount_Optional and sets PlayerCount_IsSet to false. |
public inline bool IsPlayerCountDefaultValue () const | Returns true if PlayerCount_Optional is set and matches the default value. |
public inline void SetPlayerCountToDefault () | Sets the value of PlayerCount_Optional to its default and also sets PlayerCount_IsSet to true. |
public inline int32 & GetMaxPlayerCount () | Gets the value of MaxPlayerCount_Optional, regardless of it having been set. |
public inline const int32 & GetMaxPlayerCount () const | Gets the value of MaxPlayerCount_Optional, regardless of it having been set. |
public inline const int32 & GetMaxPlayerCount (const int32 & DefaultValue) const | Gets the value of MaxPlayerCount_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMaxPlayerCount (int32 & OutValue) const | Fills OutValue with the value of MaxPlayerCount_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetMaxPlayerCountOrNull () | Returns a pointer to MaxPlayerCount_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetMaxPlayerCountOrNull () const | Returns a pointer to MaxPlayerCount_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMaxPlayerCount (int32 NewValue) | Sets the value of MaxPlayerCount_Optional and also sets MaxPlayerCount_IsSet to true. |
public inline void ClearMaxPlayerCount () | Clears the value of MaxPlayerCount_Optional and sets MaxPlayerCount_IsSet to false. |
public inline bool IsMaxPlayerCountDefaultValue () const | Returns true if MaxPlayerCount_Optional is set and matches the default value. |
public inline void SetMaxPlayerCountToDefault () | Sets the value of MaxPlayerCount_Optional to its default and also sets MaxPlayerCount_IsSet to true. |
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 FString
SessionId
ID for the session.
public int32
PlayerCount_Optional
Number of players actively in this session.
public bool
PlayerCount_IsSet
true if PlayerCount_Optional has been set to a value
public int32
MaxPlayerCount_Optional
Maximum number of players that can be in this session.
public bool
MaxPlayerCount_IsSet
true if MaxPlayerCount_Optional has been set to a value
public TMap< FString, FString >
CustomData_Optional
Custom data with the listing of the instance in the Session browser.
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
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 &
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 int32 &
GetPlayerCount
()
Gets the value of PlayerCount_Optional, regardless of it having been set.
public inline const int32 &
GetPlayerCount
() const
Gets the value of PlayerCount_Optional, regardless of it having been set.
public inline const int32 &
GetPlayerCount
(const int32 & DefaultValue) const
Gets the value of PlayerCount_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetPlayerCount
(int32 & OutValue) const
Fills OutValue with the value of PlayerCount_Optional and returns true if it has been set, otherwise returns false.
public inline int32 *
GetPlayerCountOrNull
()
Returns a pointer to PlayerCount_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 *
GetPlayerCountOrNull
() const
Returns a pointer to PlayerCount_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetPlayerCount
(int32 NewValue)
Sets the value of PlayerCount_Optional and also sets PlayerCount_IsSet to true.
public inline void
ClearPlayerCount
()
Clears the value of PlayerCount_Optional and sets PlayerCount_IsSet to false.
public inline bool
IsPlayerCountDefaultValue
() const
Returns true if PlayerCount_Optional is set and matches the default value.
public inline void
SetPlayerCountToDefault
()
Sets the value of PlayerCount_Optional to its default and also sets PlayerCount_IsSet to true.
public inline int32 &
GetMaxPlayerCount
()
Gets the value of MaxPlayerCount_Optional, regardless of it having been set.
public inline const int32 &
GetMaxPlayerCount
() const
Gets the value of MaxPlayerCount_Optional, regardless of it having been set.
public inline const int32 &
GetMaxPlayerCount
(const int32 & DefaultValue) const
Gets the value of MaxPlayerCount_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetMaxPlayerCount
(int32 & OutValue) const
Fills OutValue with the value of MaxPlayerCount_Optional and returns true if it has been set, otherwise returns false.
public inline int32 *
GetMaxPlayerCountOrNull
()
Returns a pointer to MaxPlayerCount_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 *
GetMaxPlayerCountOrNull
() const
Returns a pointer to MaxPlayerCount_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetMaxPlayerCount
(int32 NewValue)
Sets the value of MaxPlayerCount_Optional and also sets MaxPlayerCount_IsSet to true.
public inline void
ClearMaxPlayerCount
()
Clears the value of MaxPlayerCount_Optional and sets MaxPlayerCount_IsSet to false.
public inline bool
IsMaxPlayerCountDefaultValue
() const
Returns true if MaxPlayerCount_Optional is set and matches the default value.
public inline void
SetMaxPlayerCountToDefault
()
Sets the value of MaxPlayerCount_Optional to its default and also sets MaxPlayerCount_IsSet to true.
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.