RHAPI_CrossplayPreferences
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_CrossplayPreferences | A session’s or player’s preferences around crossplay platforms and inputs. Permitted platforms and inputs will be checked when new players attempt to join a session. |
struct FRHAPI_CrossplayPreferences
struct FRHAPI_CrossplayPreferences
: public FRHAPI_Model
A session’s or player’s preferences around crossplay platforms and inputs. Permitted platforms and inputs will be checked when new players attempt to join a session.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_CrossplayPlatform PermittedPlatform | The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.) |
public ERHAPI_CrossplayInput 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_CrossplayPlatform & GetPermittedPlatform() | Gets the value of PermittedPlatform. |
public inline const ERHAPI_CrossplayPlatform & GetPermittedPlatform() const | Gets the value of PermittedPlatform. |
public inline void SetPermittedPlatform(ERHAPI_CrossplayPlatform NewValue) | Sets the value of PermittedPlatform. |
public inline ERHAPI_CrossplayInput & GetPermittedInput() | Gets the value of PermittedInput. |
public inline const ERHAPI_CrossplayInput & GetPermittedInput() const | Gets the value of PermittedInput. |
public inline void SetPermittedInput(ERHAPI_CrossplayInput NewValue) | Sets the value of PermittedInput. |
Members
public ERHAPI_CrossplayPlatform PermittedPlatform
The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)
public ERHAPI_CrossplayInput 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
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_CrossplayPlatform & GetPermittedPlatform()
Gets the value of PermittedPlatform.
public inline const ERHAPI_CrossplayPlatform & GetPermittedPlatform() const
Gets the value of PermittedPlatform.
public inline void SetPermittedPlatform(ERHAPI_CrossplayPlatform NewValue)
Sets the value of PermittedPlatform.
public inline ERHAPI_CrossplayInput & GetPermittedInput()
Gets the value of PermittedInput.
public inline const ERHAPI_CrossplayInput & GetPermittedInput() const
Gets the value of PermittedInput.
public inline void SetPermittedInput(ERHAPI_CrossplayInput NewValue)
Sets the value of PermittedInput.