Class DLCPlatformProfile

Namespace

DLCToolkit.Profile

Assembly

DLCToolkit.Profile.dll

Represents a DLC build profile for a specific build target platform.

[Serializable]
public class DLCPlatformProfile

Inheritance

object

DLCPlatformProfile

Derived

DLCPlatformProfileAndroid

Fields

friendlyPlatformNames

An array of supported platform names in an easily readable format.

public static readonly string[] friendlyPlatformNames

Field Value

string[]

Properties

DLCExtension

The file extension for this platform DLC.

public string DLCExtension { get; set; }

Property Value

string

DlcUniqueKey

The unique key for this platform DLC.

public string DlcUniqueKey { get; set; }

Property Value

string

Enabled

Is this platform enabled for build.

public bool Enabled { get; set; }

Property Value

bool

Platform

Get the build target for this platform.

public BuildTarget Platform { get; }

Property Value

BuildTarget

PlatformDefines

Get an array of define symbols specific to this platform when compiling scripts.

public string[] PlatformDefines { get; }

Property Value

string[]

PlatformFriendlyName

Get the easily readable platform name for this platform profile.

public string PlatformFriendlyName { get; }

Property Value

string

PlatformName

Get the name of this platform.

public string PlatformName { get; }

Property Value

string

PreloadSceneAssets

Should the DLC content preload scene assets at load time for this platform.

public bool PreloadSceneAssets { get; set; }

Property Value

bool

PreloadSharedAssets

Should the DLC content preload shared assets at load time for this platform.

public bool PreloadSharedAssets { get; set; }

Property Value

bool

RuntimePlatform

Get the runtime target for this platform.

public RuntimePlatform RuntimePlatform { get; }

Property Value

RuntimePlatform

ShipWithGame

Should the DLC content be included in the built game. Note that it is possible to include DLC that is not usable until the user has purchased via DRM.

public bool ShipWithGame { get; set; }

Property Value

bool

ShipWithGameDirectory

The directory relative where the DLC content should be placed.

public ShipWithGameDirectory ShipWithGameDirectory { get; set; }

Property Value

ShipWithGameDirectory

ShipWithGamePath

The path where the DLC content should be placed.

public string ShipWithGamePath { get; set; }

Property Value

string

StrictBuild

Should the DLC content be built in strict mode for this platform.

public bool StrictBuild { get; set; }

Property Value

bool

UseCompression

Should the DLC content be built with compression for this platform.

public bool UseCompression { get; set; }

Property Value

bool

Methods

GetFriendlyPlatformName(BuildTarget)

Get the platform friendly name from the specified build target.

public static string GetFriendlyPlatformName(BuildTarget platform)

Parameters

platform BuildTarget

The build target platform

Returns

string

The friendly string name for the build target

GetRuntimePlatform(BuildTarget)

Get the runtime platform from the specified build target.

public static RuntimePlatform GetRuntimePlatform(BuildTarget platform)

Parameters

platform BuildTarget

The build target platform

Returns

RuntimePlatform

The runtime platform for the build target

Exceptions

NotSupportedException

The build target is not supported

IsDLCBuildTargetAvailable(BuildTarget)

Check if build support for the target platform is installed.

public static bool IsDLCBuildTargetAvailable(BuildTarget buildTarget)

Parameters

buildTarget BuildTarget

The build target to check

Returns

bool

True if build support is available or false if not