Skip to main content

RHAPI_PlatformSessionPlayer

Summary​

MembersDescriptions
struct FRHAPI_PlatformSessionPlayerA platform player resource in a platform session.

struct FRHAPI_PlatformSessionPlayer ​

struct FRHAPI_PlatformSessionPlayer
  : public FRHAPI_Model

A platform player resource in a platform session.

Summary​

MembersDescriptions
public int32 PlayerId_OptionalPlayer ID representing the current player.
public bool PlayerId_IsSettrue if PlayerId_Optional has been set to a value
public FGuid PlayerUuidPlayer UUID representing the current player.
public bool Leader_OptionalIs this player the leader of the platform session? When setting up the parent session, if all players are from the same platform session, leadership is coordinated.
public bool Leader_IsSettrue if Leader_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 int32 & GetPlayerId()Gets the value of PlayerId_Optional, regardless of it having been set.
public inline const int32 & GetPlayerId() constGets the value of PlayerId_Optional, regardless of it having been set.
public inline const int32 & GetPlayerId(const int32 & DefaultValue) constGets the value of PlayerId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayerId(int32 & OutValue) constFills OutValue with the value of PlayerId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetPlayerIdOrNull()Returns a pointer to PlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetPlayerIdOrNull() constReturns a pointer to PlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayerId(const int32 & NewValue)Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true.
public inline void SetPlayerId(int32 && NewValue)Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true using move semantics.
public inline void ClearPlayerId()Clears the value of PlayerId_Optional and sets PlayerId_IsSet to false.
public inline bool IsPlayerIdSet() constChecks whether PlayerId_Optional has been set.
public inline bool IsPlayerIdDefaultValue() constReturns true if PlayerId_Optional is set and matches the default value.
public inline void SetPlayerIdToDefault()Sets the value of PlayerId_Optional to its default and also sets PlayerId_IsSet to true.
public inline FGuid & GetPlayerUuid()Gets the value of PlayerUuid.
public inline const FGuid & GetPlayerUuid() constGets the value of PlayerUuid.
public inline void SetPlayerUuid(const FGuid & NewValue)Sets the value of PlayerUuid.
public inline void SetPlayerUuid(FGuid && NewValue)Sets the value of PlayerUuid using move semantics.
public inline bool & GetLeader()Gets the value of Leader_Optional, regardless of it having been set.
public inline const bool & GetLeader() constGets the value of Leader_Optional, regardless of it having been set.
public inline const bool & GetLeader(const bool & DefaultValue) constGets the value of Leader_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLeader(bool & OutValue) constFills OutValue with the value of Leader_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetLeaderOrNull()Returns a pointer to Leader_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetLeaderOrNull() constReturns a pointer to Leader_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLeader(const bool & NewValue)Sets the value of Leader_Optional and also sets Leader_IsSet to true.
public inline void SetLeader(bool && NewValue)Sets the value of Leader_Optional and also sets Leader_IsSet to true using move semantics.
public inline void ClearLeader()Clears the value of Leader_Optional and sets Leader_IsSet to false.
public inline bool IsLeaderSet() constChecks whether Leader_Optional has been set.
public inline bool IsLeaderDefaultValue() constReturns true if Leader_Optional is set and matches the default value.
public inline void SetLeaderToDefault()Sets the value of Leader_Optional to its default and also sets Leader_IsSet to true.

Members​

public int32 PlayerId_Optional ​

Player ID representing the current player.

public bool PlayerId_IsSet ​

true if PlayerId_Optional has been set to a value

public FGuid PlayerUuid ​

Player UUID representing the current player.

public bool Leader_Optional ​

Is this player the leader of the platform session? When setting up the parent session, if all players are from the same platform session, leadership is coordinated.

public bool Leader_IsSet ​

true if Leader_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 int32 & GetPlayerId() ​

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

public inline const int32 & GetPlayerId() const ​

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

public inline const int32 & GetPlayerId(const int32 & DefaultValue) const ​

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

public inline bool GetPlayerId(int32 & OutValue) const ​

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

public inline int32 * GetPlayerIdOrNull() ​

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

public inline const int32 * GetPlayerIdOrNull() const ​

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

public inline void SetPlayerId(const int32 & NewValue) ​

Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true.

public inline void SetPlayerId(int32 && NewValue) ​

Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true using move semantics.

public inline void ClearPlayerId() ​

Clears the value of PlayerId_Optional and sets PlayerId_IsSet to false.

public inline bool IsPlayerIdSet() const ​

Checks whether PlayerId_Optional has been set.

public inline bool IsPlayerIdDefaultValue() const ​

Returns true if PlayerId_Optional is set and matches the default value.

public inline void SetPlayerIdToDefault() ​

Sets the value of PlayerId_Optional to its default and also sets PlayerId_IsSet to true.

public inline FGuid & GetPlayerUuid() ​

Gets the value of PlayerUuid.

public inline const FGuid & GetPlayerUuid() const ​

Gets the value of PlayerUuid.

public inline void SetPlayerUuid(const FGuid & NewValue) ​

Sets the value of PlayerUuid.

public inline void SetPlayerUuid(FGuid && NewValue) ​

Sets the value of PlayerUuid using move semantics.

public inline bool & GetLeader() ​

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

public inline const bool & GetLeader() const ​

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

public inline const bool & GetLeader(const bool & DefaultValue) const ​

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

public inline bool GetLeader(bool & OutValue) const ​

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

public inline bool * GetLeaderOrNull() ​

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

public inline const bool * GetLeaderOrNull() const ​

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

public inline void SetLeader(const bool & NewValue) ​

Sets the value of Leader_Optional and also sets Leader_IsSet to true.

public inline void SetLeader(bool && NewValue) ​

Sets the value of Leader_Optional and also sets Leader_IsSet to true using move semantics.

public inline void ClearLeader() ​

Clears the value of Leader_Optional and sets Leader_IsSet to false.

public inline bool IsLeaderSet() const ​

Checks whether Leader_Optional has been set.

public inline bool IsLeaderDefaultValue() const ​

Returns true if Leader_Optional is set and matches the default value.

public inline void SetLeaderToDefault() ​

Sets the value of Leader_Optional to its default and also sets Leader_IsSet to true.