Skip to content

RHAPI_SessionPlayerUpdateResponse

Summary

MembersDescriptions
struct FRHAPI_SessionPlayerUpdateResponseResponse to a request to update a player in a session.

struct FRHAPI_SessionPlayerUpdateResponse

struct FRHAPI_SessionPlayerUpdateResponse
: public FRHAPI_Model

Response to a request to update a player in a session.

Summary

MembersDescriptions
public FGuid PlayerUuid_OptionalPlayer UUID of the player updated.
public bool PlayerUuid_IsSettrue if PlayerUuid_Optional has been set to a value
public ERHAPI_SessionPlayerStatus StatusStatus of the player after the request is completed.
public int32 TeamIdWhich team the player joined.
public TMap< FString, FString > CustomData_OptionalResulting custom data about the player.
public bool CustomData_IsSettrue 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) constWrites the data from this object into the specified JSON Writer stream.
public inline FGuid & GetPlayerUuid()Gets the value of PlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetPlayerUuid() constGets the value of PlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetPlayerUuid(const FGuid & DefaultValue) constGets the value of PlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayerUuid(FGuid & OutValue) constFills OutValue with the value of PlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetPlayerUuidOrNull()Returns a pointer to PlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetPlayerUuidOrNull() constReturns a pointer to PlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayerUuid(FGuid NewValue)Sets the value of PlayerUuid_Optional and also sets PlayerUuid_IsSet to true.
public inline void ClearPlayerUuid()Clears the value of PlayerUuid_Optional and sets PlayerUuid_IsSet to false.
public inline ERHAPI_SessionPlayerStatus & GetStatus()Gets the value of Status.
public inline const ERHAPI_SessionPlayerStatus & GetStatus() constGets the value of Status.
public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue)Sets the value of Status.
public inline int32 & GetTeamId()Gets the value of TeamId.
public inline const int32 & GetTeamId() constGets the value of TeamId.
public inline void SetTeamId(int32 NewValue)Sets the value of TeamId.
public inline bool IsTeamIdDefaultValue() constReturns 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() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills 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() constReturns 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 PlayerUuid_Optional

Player UUID of the player updated.

public bool PlayerUuid_IsSet

true if PlayerUuid_Optional has been set to a value

public ERHAPI_SessionPlayerStatus Status

Status of the player after the request is completed.

public int32 TeamId

Which team the player joined.

public TMap< FString, FString > CustomData_Optional

Resulting custom data about the player.

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 FGuid & GetPlayerUuid()

Gets the value of PlayerUuid_Optional, regardless of it having been set.

public inline const FGuid & GetPlayerUuid() const

Gets the value of PlayerUuid_Optional, regardless of it having been set.

public inline const FGuid & GetPlayerUuid(const FGuid & DefaultValue) const

Gets the value of PlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetPlayerUuid(FGuid & OutValue) const

Fills OutValue with the value of PlayerUuid_Optional and returns true if it has been set, otherwise returns false.

public inline FGuid * GetPlayerUuidOrNull()

Returns a pointer to PlayerUuid_Optional, if it has been set, otherwise returns nullptr.

public inline const FGuid * GetPlayerUuidOrNull() const

Returns a pointer to PlayerUuid_Optional, if it has been set, otherwise returns nullptr.

public inline void SetPlayerUuid(FGuid NewValue)

Sets the value of PlayerUuid_Optional and also sets PlayerUuid_IsSet to true.

public inline void ClearPlayerUuid()

Clears the value of PlayerUuid_Optional and sets PlayerUuid_IsSet to false.

public inline ERHAPI_SessionPlayerStatus & GetStatus()

Gets the value of Status.

public inline const ERHAPI_SessionPlayerStatus & GetStatus() const

Gets the value of Status.

public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue)

Sets the value of Status.

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.