RHAPI_ClientSettings

Summary

Members	Descriptions
struct FRHAPI_ClientSettings	A player's platform and input settings.

struct FRHAPI_ClientSettings

struct FRHAPI_ClientSettings
  : public FRHAPI_Model

A player's platform and input settings.

Summary

Members	Descriptions
public ERHAPI_PlatformID PlatformId_Optional	DEPRECATED. Use 'platform' instead. Id for which platform this client is on. ID will be ignored if 'platform' is given. At least one of the two is required.
public bool PlatformId_IsSet	true if PlatformId_Optional has been set to a value
public ERHAPI_Platform Platform_Optional	Which platform this client is on. If one is not provided, will get the platform from the 'platform_id'. Platform is now read from client's authorization claims if available.
public bool Platform_IsSet	true if Platform_Optional has been set to a value
public ERHAPI_Input Input	Which input type this client is using.
public ERHAPI_DeviceType DeviceType_Optional	Platform verified device type for this client.
public bool DeviceType_IsSet	true if DeviceType_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_PlatformID & GetPlatformId()	Gets the value of PlatformId_Optional, regardless of it having been set.
public inline const ERHAPI_PlatformID & GetPlatformId() const	Gets the value of PlatformId_Optional, regardless of it having been set.
public inline const ERHAPI_PlatformID & GetPlatformId(const ERHAPI_PlatformID & DefaultValue) const	Gets the value of PlatformId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlatformId(ERHAPI_PlatformID & OutValue) const	Fills OutValue with the value of PlatformId_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_PlatformID * GetPlatformIdOrNull()	Returns a pointer to PlatformId_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_PlatformID * GetPlatformIdOrNull() const	Returns a pointer to PlatformId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlatformId(const ERHAPI_PlatformID & NewValue)	Sets the value of PlatformId_Optional and also sets PlatformId_IsSet to true.
public inline void SetPlatformId(ERHAPI_PlatformID && NewValue)	Sets the value of PlatformId_Optional and also sets PlatformId_IsSet to true using move semantics.
public inline void ClearPlatformId()	Clears the value of PlatformId_Optional and sets PlatformId_IsSet to false.
public inline bool IsPlatformIdSet() const	Checks whether PlatformId_Optional has been set.
public inline ERHAPI_Platform & GetPlatform()	Gets the value of Platform_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetPlatform() const	Gets the value of Platform_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetPlatform(const ERHAPI_Platform & DefaultValue) const	Gets the value of Platform_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlatform(ERHAPI_Platform & OutValue) const	Fills OutValue with the value of Platform_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Platform * GetPlatformOrNull()	Returns a pointer to Platform_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Platform * GetPlatformOrNull() const	Returns a pointer to Platform_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlatform(const ERHAPI_Platform & NewValue)	Sets the value of Platform_Optional and also sets Platform_IsSet to true.
public inline void SetPlatform(ERHAPI_Platform && NewValue)	Sets the value of Platform_Optional and also sets Platform_IsSet to true using move semantics.
public inline void ClearPlatform()	Clears the value of Platform_Optional and sets Platform_IsSet to false.
public inline bool IsPlatformSet() const	Checks whether Platform_Optional has been set.
public inline ERHAPI_Input & GetInput()	Gets the value of Input.
public inline const ERHAPI_Input & GetInput() const	Gets the value of Input.
public inline void SetInput(const ERHAPI_Input & NewValue)	Sets the value of Input.
public inline void SetInput(ERHAPI_Input && NewValue)	Sets the value of Input using move semantics.
public inline ERHAPI_DeviceType & GetDeviceType()	Gets the value of DeviceType_Optional, regardless of it having been set.
public inline const ERHAPI_DeviceType & GetDeviceType() const	Gets the value of DeviceType_Optional, regardless of it having been set.
public inline const ERHAPI_DeviceType & GetDeviceType(const ERHAPI_DeviceType & DefaultValue) const	Gets the value of DeviceType_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeviceType(ERHAPI_DeviceType & OutValue) const	Fills OutValue with the value of DeviceType_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_DeviceType * GetDeviceTypeOrNull()	Returns a pointer to DeviceType_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_DeviceType * GetDeviceTypeOrNull() const	Returns a pointer to DeviceType_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeviceType(const ERHAPI_DeviceType & NewValue)	Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true.
public inline void SetDeviceType(ERHAPI_DeviceType && NewValue)	Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true using move semantics.
public inline void ClearDeviceType()	Clears the value of DeviceType_Optional and sets DeviceType_IsSet to false.
public inline bool IsDeviceTypeSet() const	Checks whether DeviceType_Optional has been set.

Members

public ERHAPI_PlatformID PlatformId_Optional

DEPRECATED. Use 'platform' instead. Id for which platform this client is on. ID will be ignored if 'platform' is given. At least one of the two is required.

public bool PlatformId_IsSet

true if PlatformId_Optional has been set to a value

public ERHAPI_Platform Platform_Optional

Which platform this client is on. If one is not provided, will get the platform from the 'platform_id'. Platform is now read from client's authorization claims if available.

public bool Platform_IsSet

true if Platform_Optional has been set to a value

public ERHAPI_Input Input

Which input type this client is using.

public ERHAPI_DeviceType DeviceType_Optional

Platform verified device type for this client.

public bool DeviceType_IsSet

true if DeviceType_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 ERHAPI_PlatformID & GetPlatformId()

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

public inline const ERHAPI_PlatformID & GetPlatformId() const

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

public inline const ERHAPI_PlatformID & GetPlatformId(const ERHAPI_PlatformID & DefaultValue) const

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

public inline bool GetPlatformId(ERHAPI_PlatformID & OutValue) const

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

public inline ERHAPI_PlatformID * GetPlatformIdOrNull()

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

public inline const ERHAPI_PlatformID * GetPlatformIdOrNull() const

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

public inline void SetPlatformId(const ERHAPI_PlatformID & NewValue)

Sets the value of PlatformId_Optional and also sets PlatformId_IsSet to true.

public inline void SetPlatformId(ERHAPI_PlatformID && NewValue)

Sets the value of PlatformId_Optional and also sets PlatformId_IsSet to true using move semantics.

public inline void ClearPlatformId()

Clears the value of PlatformId_Optional and sets PlatformId_IsSet to false.

public inline bool IsPlatformIdSet() const

Checks whether PlatformId_Optional has been set.

public inline ERHAPI_Platform & GetPlatform()

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

public inline const ERHAPI_Platform & GetPlatform() const

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

public inline const ERHAPI_Platform & GetPlatform(const ERHAPI_Platform & DefaultValue) const

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

public inline bool GetPlatform(ERHAPI_Platform & OutValue) const

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

public inline ERHAPI_Platform * GetPlatformOrNull()

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

public inline const ERHAPI_Platform * GetPlatformOrNull() const

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

public inline void SetPlatform(const ERHAPI_Platform & NewValue)

Sets the value of Platform_Optional and also sets Platform_IsSet to true.

public inline void SetPlatform(ERHAPI_Platform && NewValue)

Sets the value of Platform_Optional and also sets Platform_IsSet to true using move semantics.

public inline void ClearPlatform()

Clears the value of Platform_Optional and sets Platform_IsSet to false.

public inline bool IsPlatformSet() const

Checks whether Platform_Optional has been set.

public inline ERHAPI_Input & GetInput()

Gets the value of Input.

public inline const ERHAPI_Input & GetInput() const

Gets the value of Input.

public inline void SetInput(const ERHAPI_Input & NewValue)

Sets the value of Input.

public inline void SetInput(ERHAPI_Input && NewValue)

Sets the value of Input using move semantics.

public inline ERHAPI_DeviceType & GetDeviceType()

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

public inline const ERHAPI_DeviceType & GetDeviceType() const

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

public inline const ERHAPI_DeviceType & GetDeviceType(const ERHAPI_DeviceType & DefaultValue) const

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

public inline bool GetDeviceType(ERHAPI_DeviceType & OutValue) const

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

public inline ERHAPI_DeviceType * GetDeviceTypeOrNull()

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

public inline const ERHAPI_DeviceType * GetDeviceTypeOrNull() const

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

public inline void SetDeviceType(const ERHAPI_DeviceType & NewValue)

Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true.

public inline void SetDeviceType(ERHAPI_DeviceType && NewValue)

Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true using move semantics.

public inline void ClearDeviceType()

Clears the value of DeviceType_Optional and sets DeviceType_IsSet to false.

public inline bool IsDeviceTypeSet() const

Checks whether DeviceType_Optional has been set.