RHAPI_SessionPlayerUpdateRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_SessionPlayerUpdateRequest | A request body to update information about a player in a session. |
struct FRHAPI_SessionPlayerUpdateRequest
struct FRHAPI_SessionPlayerUpdateRequest : public FRHAPI_ModelA request body to update information about a player in a session.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_SessionPlayerStatus Status_Optional | Status that the player would like after the request is complete. Note that some join operations may promote the player from member to leader |
public bool Status_IsSet | true if Status_Optional has been set to a value |
public int32 TeamId | Which team the player should be on. |
public TMap< FString, FString > CustomData_Optional | player-defined custom data |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public ERHAPI_TeamOverflowAction OverflowAction_Optional | How we should handle too many players being invited to the chosen team. |
public bool OverflowAction_IsSet | true if OverflowAction_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 ERHAPI_SessionPlayerStatus & GetStatus() | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_SessionPlayerStatus & GetStatus() const | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_SessionPlayerStatus & GetStatus(const ERHAPI_SessionPlayerStatus & DefaultValue) const | Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStatus(ERHAPI_SessionPlayerStatus & OutValue) const | Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_SessionPlayerStatus * GetStatusOrNull() | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_SessionPlayerStatus * GetStatusOrNull() const | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue) | Sets the value of Status_Optional and also sets Status_IsSet to true. |
public inline void ClearStatus() | Clears the value of Status_Optional and sets Status_IsSet to false. |
public inline int32 & GetTeamId() | Gets the value of TeamId. |
public inline const int32 & GetTeamId() const | Gets the value of TeamId. |
public inline void SetTeamId(int32 NewValue) | Sets the value of TeamId. |
public inline bool IsTeamIdDefaultValue() const | Returns true if TeamId matches the default value. |
public inline void SetTeamIdToDefault() | Sets the value of TeamId to its default |
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 ERHAPI_TeamOverflowAction & GetOverflowAction() | Gets the value of OverflowAction_Optional, regardless of it having been set. |
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() const | Gets the value of OverflowAction_Optional, regardless of it having been set. |
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) const | Gets the value of OverflowAction_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) const | Fills OutValue with the value of OverflowAction_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() | Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() const | Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetOverflowAction(ERHAPI_TeamOverflowAction NewValue) | Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true. |
public inline void ClearOverflowAction() | Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false. |
Members
public ERHAPI_SessionPlayerStatus Status_Optional
Status that the player would like after the request is complete. Note that some join operations may promote the player from member to leader
public bool Status_IsSet
true if Status_Optional has been set to a value
public int32 TeamId
Which team the player should be on.
public TMap< FString, FString > CustomData_Optional
player-defined custom data
public bool CustomData_IsSet
true if CustomData_Optional has been set to a value
public ERHAPI_TeamOverflowAction OverflowAction_Optional
How we should handle too many players being invited to the chosen team.
public bool OverflowAction_IsSet
true if OverflowAction_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 ERHAPI_SessionPlayerStatus & GetStatus()
Gets the value of Status_Optional, regardless of it having been set.
public inline const ERHAPI_SessionPlayerStatus & GetStatus() const
Gets the value of Status_Optional, regardless of it having been set.
public inline const ERHAPI_SessionPlayerStatus & GetStatus(const ERHAPI_SessionPlayerStatus & DefaultValue) const
Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetStatus(ERHAPI_SessionPlayerStatus & OutValue) const
Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_SessionPlayerStatus * GetStatusOrNull()
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_SessionPlayerStatus * GetStatusOrNull() const
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue)
Sets the value of Status_Optional and also sets Status_IsSet to true.
public inline void ClearStatus()
Clears the value of Status_Optional and sets Status_IsSet to false.
public inline int32 & GetTeamId()
Gets the value of TeamId.
public inline const int32 & GetTeamId() const
Gets the value of TeamId.
public inline void SetTeamId(int32 NewValue)
Sets the value of TeamId.
public inline bool IsTeamIdDefaultValue() const
Returns true if TeamId matches the default value.
public inline void SetTeamIdToDefault()
Sets the value of TeamId to its default
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 ERHAPI_TeamOverflowAction & GetOverflowAction()
Gets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() const
Gets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) const
Gets the value of OverflowAction_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) const
Fills OutValue with the value of OverflowAction_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull()
Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() const
Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline void SetOverflowAction(ERHAPI_TeamOverflowAction NewValue)
Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true.
public inline void ClearOverflowAction()
Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false.