Navigation
API > API/Plugins > API/Plugins/PlatformDLC
Main interface for Platform DLC note: API may be subject to change while this plugin is experimental
| Name | IPlatformDLC |
| Type | class |
| Header File | /Engine/Plugins/Experimental/PlatformDLC/Source/PlatformDLC/Public/PlatformDLC.h |
| Include Path | #include "PlatformDLC.h" |
Syntax
class IPlatformDLC
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPlatformDLC() |
PlatformDLC.h |
Enums
Public
| Name | Remarks |
|---|---|
| ENotification | |
| EState |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnDLCNotification | TMulticastDelegate_ThreeParams< void, FName, ENotification, bool > | PlatformDLC.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ConfigSectionName | const TCHAR * | Config section for Platform DLC settings | PlatformDLC.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Download
(
FName DLCName |
Start asynchronously downloading the given DLC. | PlatformDLC.h | |
TArray< FName > GetAllDLCNames() |
Returns the list of all known DLC (regardless of whether downloaded / mounted) | PlatformDLC.h | |
bool GetDownloadSize
(
FName DLCName, |
Determine the download size for the given DLC returns true if the download size is available | PlatformDLC.h | |
TArray< FName > GetMountedDLCNames() |
Returns the list of all DLC that is ready for use (entitled, downloaded & mounted) | PlatformDLC.h | |
FString GetRootDirectory
(
FName DLCName |
Returns the file system mount point for the given DLC | PlatformDLC.h | |
EState GetState
(
FName DLCName |
Returns the current state of the given DLC | PlatformDLC.h | |
FString GetStoreId
(
FName DLCName |
Get the store id for the DLC (should be convertible to FUniqueOfferId) | PlatformDLC.h | |
FPlatformUserId GetStoreUser() |
Returns the user who will be used to purchase any DLC, if any | PlatformDLC.h | |
bool HasEntitlement
(
FName DLCName |
Query if we have entitlement to download & mount the given DLC | PlatformDLC.h | |
bool InitializeAsync() |
Start initializing the platform DLC; subsequent calls after the first are ignored; returns true if initialization was started | PlatformDLC.h | |
bool IsAvailable () |
Returns true if DLC is supported in the current build configuration. | PlatformDLC.h | |
bool IsInitialized() |
Determines whether the platform DLC has finished initializing | PlatformDLC.h | |
bool Mount
(
FName DLCName |
Start asynchronously mounting the given DLC can also be used to attempt entitlement reacquisition after it has been lost returns true if the callback will be triggered, or false if the DLC is not known | PlatformDLC.h | |
FOnDLCNotification & OnNotification() |
Called when there is a notification about DLC, such as mounting completion | PlatformDLC.h | |
void RegisterInitializationCallback
(
TFunction< void()> Callback |
Register a callback for when initialization is complete; the callback will still occur if the DLC is already initialized | PlatformDLC.h | |
void SetStoreUser
(
FPlatformUserId PlatformUserId |
Set the user who will be used to purchase any DLC | PlatformDLC.h | |
void Shutdown() |
Shutdown the platform DLC and clean up resources | PlatformDLC.h | |
bool Uninstall
(
FName DLCName |
Start uninstalling the given DLC (may not work properly on all platforms. DLC must be unmounted first) returns true if the callback will be triggered, or false if the DLC is not known | PlatformDLC.h | |
bool Unmount
(
FName DLCName |
Start asynchronously unmounting the given DLC. | PlatformDLC.h |