Table of Contents

Namespace DLCToolkit

Classes

DLC

Main API for interacting with and loading DLC content from an external source. Also provides API's for retrieving DLC from various DRM (Digital Rights Management) services such as Steamworks, Google Play and more. DRM is used to ensure that the current user has access to or owns the requested DLC content if it is paid for or licensed in any way by the providing service.

DLCAsync

An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information. Used to wait until an async operation has been completed

DLCAsync<T>

An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information. Used to wait for an async operation to be completed with a result object.

DLCBatchAsync<T>

A batch async awaitable operation that contains multiple sub async operations. Can represent the progress and status of all operations combined and will wait until all operations have finished. Note that all sub operations will run in parallel in most cases, so a batch operation will only usually take as much time as the longest sub operation in most cases, plus some minor overhead for management.

DLCContent

Represents a DLC loaded in memory. Provides access to metadata, icons, plus API's for loading assets and scenes. Will remain in memory until Unload(bool), Dispose() or until the game exits.

DLCDirectory

A utility class for mounting a specific folder path as a designated DLC install folder. Contains useful helper methods to find and access the DLC contents included in the target folder. Note that only valid DLC files/information will be returned using this API (IsDLCFile(string) = true), even if the folder contains additional non-DLC files. There is also support for detecting when DLC files are added or removed from the target folder.

DLCNotAvailableException

An exception thrown when DLC is not available upon request.

DLCNotLoadedException

An exception thrown when DLC content is trying to be accessed but the DLC is not loaded.

DLCStreamProvider

Represents a data stream source containing DLC content.

Interfaces

IDLCAsyncProvider

A host that is able to manage the invocation of an async operation.

IDLCIconProvider

Provides access to various icon content that has been registered with the DLC content. Useful for displaying in UI's or splash screens to indicate that a certain DLC has been detected and activated.

IDLCMetadata

Access all metadata for a given DLC.

IDLCNameInfo

Access name information for a given DLC.

Enums

DLCContentFlags

The content flags that indicate which types of content are included in a given DLC.

DLCIconType

The built in icon size that we need to access.