Navigation
API > API/Plugins > API/Plugins/OnlineFrameworkCommon
| Name | FCommonConfig |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFrameworkCommon/Source/OnlineFrameworkCommon/Public/OnlineFramework/CommonConfig.h |
| Include Path | #include "OnlineFramework/CommonConfig.h" |
Syntax
class FCommonConfig
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| OnlineFramework/CommonConfig.h | |||
FCommonConfig
(
const UObject* ContextObject |
Constructor to determine the context from a UObject. | OnlineFramework/CommonConfig.h | |
FCommonConfig
(
FName InWorldContextName, |
Constructor to explicitly set fields | OnlineFramework/CommonConfig.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ContextType | ECommonConfigContextType | Context type | OnlineFramework/CommonConfig.h | |
| WorldContextName | FName | World context name. | OnlineFramework/CommonConfig.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ECommonConfigContextType GetContextType() |
Get the context type for this online config instance. | OnlineFramework/CommonConfig.h | |
TOptional< FCommonConfigInstance > GetFrameworkInstanceConfig
(
FName FrameworkInstance |
Get the config for a framework instance | OnlineFramework/CommonConfig.h | |
TSharedPtr< UE::Online::IOnlineServices > GetServices
(
FName FrameworkInstance |
Get the online services configured for a framework instance | OnlineFramework/CommonConfig.h | |
FName GetWorldContextName() |
Get the world context for this online config instance. | OnlineFramework/CommonConfig.h |