Class DLCBuildPipeline

Namespace

DLCToolkit.BuildTools

Assembly

DLCToolkit.BuildTools.dll

Main API for building DLC content from script.

[InitializeOnLoad]
public static class DLCBuildPipeline

Inheritance

object

DLCBuildPipeline

Methods

BuildAllDLCContent(string, BuildTarget[], DLCBuildOptions)

Build all DLCProfile in the project with the specified options.

public static DLCBuildResult BuildAllDLCContent(string outputFolder = null, BuildTarget[] platforms = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

platforms BuildTarget[]

An optional array of platforms to build for or null if all platforms should be built

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

BuildAllDLCShipWithGameContent(BuildTarget, bool, string, string, DLCBuildOptions)

Build all DLCProfile in the project for the target platform that are marked to be shipped with the game.

public static DLCBuildResult BuildAllDLCShipWithGameContent(BuildTarget platformTarget, bool install = true, string buildOutputFolder = null, string outputFolder = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

platformTarget BuildTarget

The platform that the DLC should be built for

install bool

Should the built DLC content be installed in the shipped game output folder

buildOutputFolder string

The output folder where the shipped game will be built

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

BuildDLCContent(DLCProfile, string, BuildTarget[], DLCBuildOptions)

Build the specified DLC content in the project for the provided DLCProfile. Only the profile provided will be build and all other profiles in the project will be ignored.

public static DLCBuildResult BuildDLCContent(DLCProfile profile, string outputFolder = null, BuildTarget[] platforms = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

profile DLCProfile

The DLC profile to build

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

platforms BuildTarget[]

An optional array of platforms to build for or null if all platforms should be built

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

Exceptions

ArgumentNullException

profile is null

BuildDLCContent(DLCProfile[], string, BuildTarget[], DLCBuildOptions)

Build all DLC content in the project for only the specified array of DLCProfile. Only the profiles provided will be built and other profiles in the project will be ignored.

public static DLCBuildResult BuildDLCContent(DLCProfile[] profiles, string outputFolder = null, BuildTarget[] platforms = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

profiles DLCProfile[]

An array of DLC profiles to build in this batch

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

platforms BuildTarget[]

An optional array of platforms to build for or null if all platforms should be built

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

Exceptions

ArgumentNullException

profiles is null

BuildDLCShipWithGameContent(DLCProfile, BuildTarget, bool, string, string, DLCBuildOptions)

Build the provided DLCProfile for the target platform that are marked to be shipped with the game.

public static DLCBuildResult BuildDLCShipWithGameContent(DLCProfile profile, BuildTarget platformTarget, bool install = true, string buildOutputFolder = null, string outputFolder = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

profile DLCProfile

The DLC profile to build

platformTarget BuildTarget

The platform that the DLC should be built for

install bool

Should the built DLC content be installed in the shipped game output folder

buildOutputFolder string

The output folder where the shipped game will be built

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

BuildDLCShipWithGameContent(DLCProfile[], BuildTarget, bool, string, string, DLCBuildOptions)

Build all DLCProfile provided for the target platform that are marked to be shipped with the game.

public static DLCBuildResult BuildDLCShipWithGameContent(DLCProfile[] profiles, BuildTarget platformTarget, bool install = true, string buildOutputFolder = null, string outputFolder = null, DLCBuildOptions buildOptions = DLCBuildOptions.Default)

Parameters

profiles DLCProfile[]

A collection of DLC profiles that should be built

platformTarget BuildTarget

The platform that the DLC should be built for

install bool

Should the built DLC content be installed in the shipped game output folder

buildOutputFolder string

The output folder where the shipped game will be built

outputFolder string

The optional output folder where the DLC content will be built. Use null for the default output folder of 'DLC Content/'

buildOptions DLCBuildOptions

Build option flags to define various build settings

Returns

DLCBuildResult

GetAllDLCProfiles(BuildTarget[], bool)

Get an array of all DLCProfile in the project which is enabled for the specified platforms and is enabled unless includeDisabledDlc is disabled. Platforms can be null if you want to get all DLC for all platforms.

public static DLCProfile[] GetAllDLCProfiles(BuildTarget[] platforms = null, bool includeDisabledDlc = false)

Parameters

platforms BuildTarget[]

An optional array of platforms that should be found or null for all platforms

includeDisabledDlc bool

Should the result include DLC content that is not enabled for build

Returns

DLCProfile[]

An array of DLC profiles matching the search criteria or an empty array if no results are found

GetDLCProfile(string)

Try to get the DLCProfile from the project with the specified unique key. This will check all platform profiles in the DLC for a matching unique key.

public static DLCProfile GetDLCProfile(string uniqueKey)

Parameters

uniqueKey string

The unique key for the DLC

Returns

DLCProfile

A matching profile if found or null

GetDLCProfile(string, Version)

Try to get the DLCProfile from the project with the specified name and optional version.

public static DLCProfile GetDLCProfile(string name, Version version = null)

Parameters

name string

The name of the DLC to find

version Version

The optional version of the DLC to find if an exact match is required

Returns

DLCProfile

A matching profile if found or null