Config

Summary

Members	Descriptions
class URH_ConfigSubsystem	Config Subsystem used for interfacing with configuration coming from the core servers.
struct FRH_ServerTimeCache	An object that caches information about server time and differences.

class URH_ConfigSubsystem

class URH_ConfigSubsystem
  : public URH_GameInstanceSubsystemPlugin

Config Subsystem used for interfacing with configuration coming from the core servers.

Summary

Members	Descriptions
public FAppSettingsUpdatedDelegate AppSettingsUpdatedDelegate	Delegate that can be listented to for whenever App Settings get updated from polling.
public FSettingsUpdatedDelegate OnSettingsUpdated	Delegate that can be listented to for whenever Settings get updated from polling.
public FSettingsUpdatedDynamicDelegate BLUEPRINT_OnSettingsUpdated	Delegate that can be listented to for whenever Settings get updated from polling.
public virtual void Initialize()	Initialize the subsystem.
public virtual void Deinitialize()	Safely tears down the subsystem.
public void FetchAppSettings(const FRH_GenericSuccessWithErrorBlock & Delegate)	Requests the server for the latest App Settings.
public inline FORCEINLINE void FetchAppSettings(const FRH_GenericSuccessDelegate & Delegate)
public void PollAppSettings(const FRH_PollCompleteFunc & Delegate)	Pulses a FetchAppSettings call for the polling of App Settings.
public inline const TMap< FString, FString > & GetAppSettings() const	Gets the map of all the App Settings and their values.
public inline bool GetAppSetting(const FString & Key,FString & Value) const	Gets the value of a specific App Setting.
public void TriggerHotfixProcessing()	If hotfix settings are set, this starts the process of applying them to unreal assets.
public void StartAppSettingsRefreshTimer()	Starts the polling for App Settings.
public void StopAppSettingsRefreshTimer()	Stops the polling for App Settings.
public void RefreshServerTimeCache(FRH_GenericSuccessWithErrorBlock Delegate)	Requests the server time cache to be updated.
public inline FORCEINLINE void RefreshServerTimeCache(FRH_GenericSuccessBlock Delegate)
public inline void BLUEPRINT_RefreshServerTimeCache(const FRH_GenericSuccessWithErrorDynamicDelegate & Delegate)
public inline const FRH_ServerTimeCache&GetServerTimeCache() const	Gets the server time cache object.
public inline bool GetServerTime(FDateTime & Time) const	Gets the approximate server time, if we have received one.
public inline bool GetServerTimeDrift(FTimespan & Timespan) const	Gets the approximate server time, if we have received one.
public inline bool GetHotfixTestValue() const	Gets if the hotfix system is enabled.
protected TMap< FString, FString > AppSettings	Map of app settings by name.
protected FString AppSettingsETag	ETag of last Get App Settings call response.
protected FRH_AutoPollerPtr AppSettingsPoller	Poller responsible for App Settings.
protected bool bAutomaticallyPollConfigurationData	If set, automatically start the poller for App Settings.
protected bool bAutomaticallyApplyHotfixData	If set, automatically use hotfix data in App Settings to modify local data.
protected bool bHotfixTestValue	debug value to test if the hotfix system is working properly.
protected FRH_ServerTimeCache ServerTimeCache	Cache data for storing time information from the API.
protected virtual void InitPropertiesWithDefaultValues()	Initializes the subsystem with defaults for its cached data.
protected virtual void OnFetchAppSettings(const RallyHereAPI::FResponse_GetAppSettingsClient & Resp)	Handles the response to a Fetch App Settings call.

Members

public FAppSettingsUpdatedDelegate AppSettingsUpdatedDelegate

Delegate that can be listented to for whenever App Settings get updated from polling.

public FSettingsUpdatedDelegate OnSettingsUpdated

Delegate that can be listented to for whenever Settings get updated from polling.

public FSettingsUpdatedDynamicDelegate BLUEPRINT_OnSettingsUpdated

Delegate that can be listented to for whenever Settings get updated from polling.

public virtual void Initialize()

Initialize the subsystem.

public virtual void Deinitialize()

Safely tears down the subsystem.

public void FetchAppSettings(const FRH_GenericSuccessWithErrorBlock & Delegate)

Requests the server for the latest App Settings.

Parameters

• Delegate Delegate to call when the request is complete.

public inline FORCEINLINE void FetchAppSettings(const FRH_GenericSuccessDelegate & Delegate)

public void PollAppSettings(const FRH_PollCompleteFunc & Delegate)

Pulses a FetchAppSettings call for the polling of App Settings.

Parameters

• Delegate Delegate to call when the request is complete.

public inline const TMap< FString, FString > & GetAppSettings() const

Gets the map of all the App Settings and their values.

Returns

Map of all the App Settings and their values

public inline bool GetAppSetting(const FString & Key,FString & Value) const

Gets the value of a specific App Setting.

Parameters

• Key Key of the App Setting to get the value of.

• Value Value of the App Setting.

Returns

if true, a Value was found for the Key.

public void TriggerHotfixProcessing()

If hotfix settings are set, this starts the process of applying them to unreal assets.

public void StartAppSettingsRefreshTimer()

Starts the polling for App Settings.

public void StopAppSettingsRefreshTimer()

Stops the polling for App Settings.

public void RefreshServerTimeCache(FRH_GenericSuccessWithErrorBlock Delegate)

Requests the server time cache to be updated.

public inline FORCEINLINE void RefreshServerTimeCache(FRH_GenericSuccessBlock Delegate)

public inline void BLUEPRINT_RefreshServerTimeCache(const FRH_GenericSuccessWithErrorDynamicDelegate & Delegate)

public inline const FRH_ServerTimeCache&GetServerTimeCache() const

Gets the server time cache object.

public inline bool GetServerTime(FDateTime & Time) const

Gets the approximate server time, if we have received one.

Parameters

• Time The approximate server time.

Returns

True if we have received a server time, false otherwise.

public inline bool GetServerTimeDrift(FTimespan & Timespan) const

Gets the approximate server time, if we have received one.

Parameters

• Timespan The approximate server time drift

Returns

True if we have received a server time, false otherwise.

public inline bool GetHotfixTestValue() const

Gets if the hotfix system is enabled.

Returns

Gets if enabled.

protected TMap< FString, FString > AppSettings

Map of app settings by name.

protected FString AppSettingsETag

ETag of last Get App Settings call response.

protected FRH_AutoPollerPtr AppSettingsPoller

Poller responsible for App Settings.

protected bool bAutomaticallyPollConfigurationData

If set, automatically start the poller for App Settings.

protected bool bAutomaticallyApplyHotfixData

If set, automatically use hotfix data in App Settings to modify local data.

protected bool bHotfixTestValue

debug value to test if the hotfix system is working properly.

protected FRH_ServerTimeCache ServerTimeCache

Cache data for storing time information from the API.

protected virtual void InitPropertiesWithDefaultValues()

Initializes the subsystem with defaults for its cached data.

protected virtual void OnFetchAppSettings(const RallyHereAPI::FResponse_GetAppSettingsClient & Resp)

Handles the response to a Fetch App Settings call.

Parameters

• Resp Response given for the call

• Delegate Delegate passed in for original call to respond to when call completes.

struct FRH_ServerTimeCache

An object that caches information about server time and differences.

Summary

Members	Descriptions
public FDateTime LastReceivedServerDateTime	The timestamp received during the most recent update from the server.
public FDateTime LastReceivedServerAtTime	The time we received the most recent update from the server.
public inline FRH_ServerTimeCache()	Constructor.
public inline FDateTime GetLocalTime() const	Gets the current local time.
public inline bool GetServerTime(FDateTime & Time) const	Gets the approximate server time, if we have received one.
public inline bool GetServerTimeDrift(FTimespan & Timespan) const	Gets the approximate server time, if we have received one.
public inline void ImportAPITime(const RallyHereAPI::FResponse_GetUtcTime & Time)	Imports data from the server response.

Members

public FDateTime LastReceivedServerDateTime

The timestamp received during the most recent update from the server.

public FDateTime LastReceivedServerAtTime

The time we received the most recent update from the server.

public inline FRH_ServerTimeCache()

Constructor.

public inline FDateTime GetLocalTime() const

Gets the current local time.

public inline bool GetServerTime(FDateTime & Time) const

Gets the approximate server time, if we have received one.

Parameters

• Time The approximate server time.

Returns

True if we have received a server time, false otherwise.

public inline bool GetServerTimeDrift(FTimespan & Timespan) const

Gets the approximate server time, if we have received one.

Parameters

• Timespan The approximate server time drift

Returns

True if we have received a server time, false otherwise.

public inline void ImportAPITime(const RallyHereAPI::FResponse_GetUtcTime & Time)

Imports data from the server response.

Parameters

• Time the time data to import