Handles getting and setting any configuration variables for the OnlineSubsystem. All variables minus arrays allow for overriding on the command line. Any portion of OSS code that requires accessing configuration is recommended to directly grab the config instance from the subsystem, and directly get the value from one of the getters. This will allow for on the fly changes of config values to take effect, such as for testing purposes. More...
#include <OnlineSubsystemAccelByteConfig.h>
Public Member Functions | |
| void | Reload () |
| Loads all configuration entries from their respective sources. | |
| void | Reset () |
| Reset all configuration entries to their default values. | |
| void | Dump () |
| Dumps out state for each configuration entry to the log. | |
| bool | IsInitialized () const |
| Gets whether this config instance has already been initialized. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoConnectLobbyAfterLoginSuccess () |
| Get configuration entry for lobby websocket auto connect on log in success. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoConnectChatAfterLoginSuccess () |
| Get configuration entry for chat websocket auto connect on log in success. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualNativePlatformTokenRefresh () |
| Get configuration entry for requiring manual refresh of native platform tokens. | |
| TOnlineSubsystemAccelByteConfigEntry< EAccelBytePlatformType > & | GetDisplayNameSource () |
| Get configuration entry for source of user's display name. | |
| TOnlineSubsystemAccelByteConfigEntry< FName > & | GetNativePlatformName () |
| Get configuration entry for name of native platform. | |
| TOnlineSubsystemAccelByteConfigEntry< FName > & | GetSecondaryPlatformName () |
| Get configuration entry for name of secondary platform. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetEOSRefreshIntervalMilliseconds () |
| Get configuration entry for EOS refresh token interval in milliseconds. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableAuthHandlerEncryption () |
| Get configuration entry controlling whether encryption is enabled in the auth handler component. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoCheckMaximumChatMessageLimit () |
| Get configuration entry controlling whether maximum chat message limit should be automatically queried before connection. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableMatchTicketPolling () |
| Get configuration entry controlling whether polling for match ticket information after a initial delay at an interval should be enabled. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetMatchTicketPollStartDelaySeconds () |
| Get configuration entry controlling the initial delay time in seconds before match ticket polling starts. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetMatchTicketPollIntervalSeconds () |
| Get configuration entry controlling the interval time in seconds for match ticket polling. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableServerInfoPolling () |
| Get configuration entry controlling whether polling for server information after a initial delay at an interval should be enabled. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetServerInfoPollStartDelaySeconds () |
| Get configuration entry controlling the initial delay time in seconds before server information polling starts. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetServerInfoPollIntervalSeconds () |
| Get configuration entry controlling the interval time in seconds for server information polling. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableSessionInvitePolling () |
| Get configuration entry controlling whether polling for matchmaking session invites after a initial delay at an interval should be enabled. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSessionInvitePollStartDelaySeconds () |
| Get configuration entry controlling the initial delay time in seconds before matchmaking session invite polling starts. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSessionInvitePollIntervalSeconds () |
| Get configuration entry controlling the interval time in seconds for matchmaking session invite polling. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualServerRegistration () |
| Get configuration entry controlling whether server registration should be manually initiated by game code. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableStalenessChecking () |
| Get configuration entry controlling whether staleness checks on cached user data is enabled. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetTimeUntilStaleSeconds () |
| Get configuration entry controlling how long cached user data can be held before it is considered stale. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableEntitlementGateCheck () |
| Get configuration entry controlling whether lobby connection should be gated by an entitlement check. | |
| TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckSkus () |
| Get configuration entry controlling entitlement SKUs that are checked for entitlement gating. | |
| TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckItemIds () |
| Get configuration entry controlling entitlement item IDs that are checked for entitlement gating. | |
| TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckAppIds () |
| Get configuration entry controlling entitlement app IDs that are checked for entitlement gating. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSendTelemetryEventIntervalSeconds () |
| Get configuration entry controlling the amount of time in seconds between sending telemetry event batches. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetVoiceEnabled () |
| Get configuration entry controlling whether voice chat is enabled. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetLoginQueuePresentationThresholdSeconds () |
| Get configuration entry controlling threshold in seconds until log in is presented as queued. | |
| TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualLoginQueueClaim () |
| Get configuration entry controlling whether log in queue ticket will require manual claim through game code. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetGameStandardEventSendIntervalSeconds () |
| Get configuration entry controlling interval at which events from the game standard event API get sent. | |
| TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetPredefinedEventSendIntervalSeconds () |
| Get configuration entry controlling interval at which events from the predefined event API get sent. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoConnectLobbyAfterLoginSuccess () const |
| Get configuration entry for lobby websocket auto connect on log in success. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoConnectChatAfterLoginSuccess () const |
| Get configuration entry for chat websocket auto connect on log in success. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualNativePlatformTokenRefresh () const |
| Get configuration entry for requiring manual refresh of native platform tokens. | |
| const TOnlineSubsystemAccelByteConfigEntry< EAccelBytePlatformType > & | GetDisplayNameSource () const |
| Get configuration entry for source of user's display name. | |
| const TOnlineSubsystemAccelByteConfigEntry< FName > & | GetNativePlatformName () const |
| Get configuration entry for name of native platform. | |
| const TOnlineSubsystemAccelByteConfigEntry< FName > & | GetSecondaryPlatformName () const |
| Get configuration entry for name of secondary platform. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetEOSRefreshIntervalMilliseconds () const |
| Get configuration entry for EOS refresh token interval in milliseconds. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableAuthHandlerEncryption () const |
| Get configuration entry controlling whether encryption is enabled in the auth handler component. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetAutoCheckMaximumChatMessageLimit () const |
| Get configuration entry controlling whether maximum chat message limit should be automatically queried before connection. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableMatchTicketPolling () const |
| Get configuration entry controlling whether polling for match ticket information after a initial delay at an interval should be enabled. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetMatchTicketPollStartDelaySeconds () const |
| Get configuration entry controlling the initial delay time in seconds before match ticket polling starts. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetMatchTicketPollIntervalSeconds () const |
| Get configuration entry controlling the interval time in seconds for match ticket polling. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableServerInfoPolling () const |
| Get configuration entry controlling whether polling for server information after a initial delay at an interval should be enabled. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetServerInfoPollStartDelaySeconds () const |
| Get configuration entry controlling the initial delay time in seconds before server information polling starts. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetServerInfoPollIntervalSeconds () const |
| Get configuration entry controlling the interval time in seconds for server information polling. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableSessionInvitePolling () const |
| Get configuration entry controlling whether polling for matchmaking session invites after a initial delay at an interval should be enabled. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSessionInvitePollStartDelaySeconds () const |
| Get configuration entry controlling the initial delay time in seconds before matchmaking session invite polling starts. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSessionInvitePollIntervalSeconds () const |
| Get configuration entry controlling the interval time in seconds for matchmaking session invite polling. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualServerRegistration () const |
| Get configuration entry controlling whether server registration should be manually initiated by game code. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableStalenessChecking () const |
| Get configuration entry controlling whether staleness checks on cached user data is enabled. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetTimeUntilStaleSeconds () const |
| Get configuration entry controlling how long cached user data can be held before it is considered stale. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableEntitlementGateCheck () const |
| Get configuration entry controlling whether lobby connection should be gated by an entitlement check. | |
| const TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckSkus () const |
| Get configuration entry controlling entitlement SKUs that are checked for entitlement gating. | |
| const TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckItemIds () const |
| Get configuration entry controlling entitlement item IDs that are checked for entitlement gating. | |
| const TOnlineSubsystemAccelByteConfigEntry< TArray< FString > > & | GetEntitlementGateCheckAppIds () const |
| Get configuration entry controlling entitlement app IDs that are checked for entitlement gating. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetSendTelemetryEventIntervalSeconds () const |
| Get configuration entry controlling the amount of time in seconds between sending telemetry event batches. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetVoiceEnabled () const |
| Get configuration entry controlling whether voice chat is enabled. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetLoginQueuePresentationThresholdSeconds () const |
| Get configuration entry controlling threshold in seconds until log in is presented as queued. | |
| const TOnlineSubsystemAccelByteConfigEntry< bool > & | GetEnableManualLoginQueueClaim () const |
| Get configuration entry controlling whether log in queue ticket will require manual claim through game code. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetGameStandardEventSendIntervalSeconds () const |
| Get configuration entry controlling interval at which events from the game standard event API get sent. | |
| const TOnlineSubsystemAccelByteConfigEntry< int64 > & | GetPredefinedEventSendIntervalSeconds () const |
| Get configuration entry controlling interval at which events from the predefined event API get sent. | |
| FOnlineSubsystemAccelByteConfig (const FOnlineSubsystemAccelByteConfig &)=delete | |
| FOnlineSubsystemAccelByteConfig (FOnlineSubsystemAccelByteConfig &&)=delete | |
| FOnlineSubsystemAccelByteConfig & | operator= (const FOnlineSubsystemAccelByteConfig &)=delete |
| FOnlineSubsystemAccelByteConfig & | operator= (FOnlineSubsystemAccelByteConfig &&)=delete |
Public Attributes | |
| PACKAGE_SCOPE | : void Init() |
Handles getting and setting any configuration variables for the OnlineSubsystem. All variables minus arrays allow for overriding on the command line. Any portion of OSS code that requires accessing configuration is recommended to directly grab the config instance from the subsystem, and directly get the value from one of the getters. This will allow for on the fly changes of config values to take effect, such as for testing purposes.
When adding a new config entry, these steps must be taken: