Class DLCSceneAsset

Namespace

DLCToolkit.Assets

Assembly

DLCToolkit.dll

Represents a scene asset included in the DLC. Scene assets are simply Unity scenes.

public sealed class DLCSceneAsset : DLCAsset

Inheritance

object

DLCAsset

DLCSceneAsset

Inherited Members

DLCAsset.IsLoaded

DLCAsset.IsLoadable

DLCAsset.IsBundleLoaded

DLCAsset.AssetID

DLCAsset.AssetMainType

DLCAsset.FullName

DLCAsset.RelativeName

DLCAsset.Name

DLCAsset.Extension

DLCAsset.ToString()

DLCAsset.IsAssetType(Type)

DLCAsset.IsAssetType<T>()

DLCAsset.IsAssetSubType(Type)

DLCAsset.IsAssetSubType<T>()

Methods

ActivatePendingScene()

Attempt to switch activation to the current streamed scene loaded during the last async load operation. This is the same as setting allowSceneActivation to true and can be used to switch from a loading screen at a suitable time. You must use one of the LoadAsync(LoadSceneMode, bool) methods first with allowSceneActivation set to false.

public void ActivatePendingScene()

Exceptions

InvalidOperationException

There is no pending load scene operation

Load(LoadSceneMode)

Load the DLCSceneAsset.

public void Load(LoadSceneMode loadSceneMode)

Parameters

loadSceneMode LoadSceneMode

The mode to use when loading the scene

Load(LoadSceneParameters)

Load the DLCSceneAsset.

public void Load(LoadSceneParameters loadSceneParameters)

Parameters

loadSceneParameters LoadSceneParameters

The load scene parameters to use when loading the scene

LoadAsync(LoadSceneMode, bool)

Load the DLCSceneAsset asynchronously.

public DLCAsync LoadAsync(LoadSceneMode loadSceneMode, bool allowSceneActivation = true)

Parameters

loadSceneMode LoadSceneMode

Should the scene be additively loaded into the current scene

allowSceneActivation bool

Should the scene be activated as soon as it is loaded

Returns

DLCAsync

LoadAsync(LoadSceneParameters, bool)

Load the DLCSceneAsset asynchronously.

public DLCAsync LoadAsync(LoadSceneParameters loadSceneParameters, bool allowSceneActivation = true)

Parameters

loadSceneParameters LoadSceneParameters

The parameters to use when loading the scene

allowSceneActivation bool

Should the scene be activated as soon as it is loaded

Returns

DLCAsync