Class BuildContext

Basic implementation of IBuildContext. Stores data generated during a build. IBuildContext

Inheritance
Object
BuildContext
Namespace: UnityEditor.Build.Pipeline
Syntax
public class BuildContext : object, IBuildContext

Constructors

BuildContext()

Default constructor

Declaration
public BuildContext()

BuildContext(IContextObject[])

Default constructor, adds the passed in parameters to the context.

Declaration
public BuildContext(params IContextObject[] buildParams)
Parameters
Type Name Description
IContextObject[] buildParams

The set of initial parameters to add to the context.

Methods

ContainsContextObject(Type)

Checks the build context for existence of a data that is of the specified type.

Declaration
public bool ContainsContextObject(Type type)
Parameters
Type Name Description
Type type

Type of data to check for existence.
Returns
Type Description
Boolean

true if the context contains specified type of data; otherwise, false.
Implements

ContainsContextObject<T>()

Checks the build context for existence of a data that is of the specified type.

Declaration
public bool ContainsContextObject<T>()
    where T : IContextObject
Returns
Type Description
Boolean

true if the context contains specified type of data; otherwise, false.
Type Parameters
Name Description
T

Type of data to check for existence.
Implements

GetContextObject(Type)

Gets the data of the specified type contained in the build context.

Declaration
public IContextObject GetContextObject(Type type)
Parameters
Type Name Description
Type type

Type of data to return.
Returns
Type Description
IContextObject

The type of data specified.
Implements

GetContextObject<T>()

Gets the data of the specified type contained in the build context.

Declaration
public T GetContextObject<T>()
    where T : IContextObject
Returns
Type Description
T

The type of data specified.
Type Parameters
Name Description
T

Type of data to return.
Implements

SetContextObject(Type, IContextObject)

Adds the data of the specified type to the build context.

Declaration
public void SetContextObject(Type type, IContextObject contextObject)
Parameters
Type Name Description
Type type

Type of data to add.
IContextObject contextObject

Object holding the data to add.
Implements

SetContextObject(IContextObject)

Adds the data to the build context. Type will be inferred using Reflection.

Declaration
public void SetContextObject(IContextObject contextObject)
Parameters
Type Name Description
IContextObject contextObject

Object holding the data to add.
Implements

SetContextObject<T>(IContextObject)

Adds the data of the specified type to the build context.

Declaration
public void SetContextObject<T>(IContextObject contextObject)
    where T : IContextObject
Parameters
Type Name Description
IContextObject contextObject

Object holding the data to add.
Type Parameters
Name Description
T

Type of data to add.
Implements

TryGetContextObject(Type, out IContextObject)

Tries to get the data of the specified type contained in the build context.

Declaration
public bool TryGetContextObject(Type type, out IContextObject contextObject)
Parameters
Type Name Description
Type type

Type of data to return.
IContextObject contextObject

The object holding the data to be returned if found.
Returns
Type Description
Boolean

true if the context was able to returned the specified data; otherwise, false.
Implements

TryGetContextObject<T>(out T)

Tries to get the data of the specified type contained in the build context.

Declaration
public bool TryGetContextObject<T>(out T contextObject)
    where T : IContextObject
Parameters
Type Name Description
T contextObject

The object holding the data to be returned if found.
Returns
Type Description
Boolean

true if the context was able to returned the specified data; otherwise, false.
Type Parameters
Name Description
T

Type of data to return.
Implements