RHAPI_Cross-playPreferences
Summary
Members | Descriptions |
---|---|
struct FRHAPI_Cross-playPreferences | A session’s or player’s preferences around cross-play platforms and inputs. Permitted platforms and inputs will be checked when new players attempt to join a session. |
struct FRHAPI_Cross-playPreferences
struct FRHAPI_Cross-playPreferences
: public FRHAPI_Model
A session’s or player’s preferences around cross-play platforms and inputs. Permitted platforms and inputs will be checked when new players attempt to join a session.
Summary
Members | Descriptions |
---|---|
public ERHAPI_Cross-playPlatform PermittedPlatform | The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.) |
public ERHAPI_Cross-playInput PermittedInput | The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.) |
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_Cross-playPlatform & GetPermittedPlatform () | Gets the value of PermittedPlatform. |
public inline const ERHAPI_Cross-playPlatform & GetPermittedPlatform () const | Gets the value of PermittedPlatform. |
public inline void SetPermittedPlatform (ERHAPI_Cross-playPlatform NewValue) | Sets the value of PermittedPlatform. |
public inline ERHAPI_Cross-playInput & GetPermittedInput () | Gets the value of PermittedInput. |
public inline const ERHAPI_Cross-playInput & GetPermittedInput () const | Gets the value of PermittedInput. |
public inline void SetPermittedInput (ERHAPI_Cross-playInput NewValue) | Sets the value of PermittedInput. |
Members
public ERHAPI_Cross-playPlatform
PermittedPlatform
The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)
public ERHAPI_Cross-playInput
PermittedInput
The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)
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 ERHAPI_Cross-playPlatform &
GetPermittedPlatform
()
Gets the value of PermittedPlatform.
public inline const ERHAPI_Cross-playPlatform &
GetPermittedPlatform
() const
Gets the value of PermittedPlatform.
public inline void
SetPermittedPlatform
(ERHAPI_Cross-playPlatform NewValue)
Sets the value of PermittedPlatform.
public inline ERHAPI_Cross-playInput &
GetPermittedInput
()
Gets the value of PermittedInput.
public inline const ERHAPI_Cross-playInput &
GetPermittedInput
() const
Gets the value of PermittedInput.
public inline void
SetPermittedInput
(ERHAPI_Cross-playInput NewValue)
Sets the value of PermittedInput.