Class DLCContent
- Namespace
- DLCToolkit
- Assembly
- DLCToolkit.dll
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.
- Inheritance
-
ObjectComponentBehaviourMono
Behaviour DLCContent
- Implements
- Inherited Members
-
Behaviour.
enabled Behaviour.is Active And Enabled Component.GetComponent<T>()Component.TryGetComponent<T>(out T)Component.GetComponentInChildren<T>()Component.GetComponentsInChildren<T>()Component.GetComponentInParent<T>()Component.GetComponentsInParent<T>()Component.GetComponents<T>()Component.transform Component.game Object Component.tag Object.Get InstanceID() Object.Get Hash Code() Object.Instantiate(Object, Vector3, Quaternion) Object.Instantiate(Object, Vector3, Quaternion, Transform) Object.Instantiate(Object) Object.Instantiate(Object, Transform) Object.Instantiate<T>(T)Object.Instantiate<T>(T, Vector3, Quaternion)Object.Instantiate<T>(T, Vector3, Quaternion, Transform)Object.Instantiate<T>(T, Transform)Object.Destroy(Object) Object.Destroy Immediate(Object) Object.Dont Destroy OnLoad(Object) Object.Destroy Object(Object) Object.FindObjectsOfType<T>()Object.FindObjectsByType<T>(FindObjectsSortMode)Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)Object.FindObjectOfType<T>()Object.FindFirstObjectByType<T>()Object.FindAnyObjectByType<T>()Object.FindFirstObjectByType<T>(FindObjectsInactive)Object.FindAnyObjectByType<T>(FindObjectsInactive)Object.To String() Object.name Object.hide Flags
Fields
OnUnloaded
Called when the DLC content has finished unloading. Usually this means an unload request was made of the content was disposed.
Field Value
- Unity
Event
OnWillUnload
Called when the DLC content is just about to be unloaded. Usually this means an unload request was made of the content was disposed.
Field Value
- Unity
Event
Properties
HintLoadPath
Get the local path where the DLC content was loaded from.
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded
IconProvider
Get the IDLCIcon
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded
IsLoaded
Check if the DLC content has been successfully loaded.
Property Value
IsLoading
Check if the DLC content is currently loading.
Property Value
Metadata
Get the IDLCMetadata for the loaded DLC content. Provides access to useful metadata such as name, version, author information and more.
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded
NameInfo
Get the IDLCName
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded
SceneAssets
Get a collection DLCScene
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded or is loaded in metadata only mode
SharedAssets
Get a collection DLCShared
Property Value
Exceptions
- DLCNot
Loaded Exception The DLC is not currently loaded or is loaded in metadata only mode
Methods
Dispose()
Unload this DLC and release all associated resources.
Will call Unload(bool) with true
argument internally to cause the DLC to be unloaded from memory.
Note that this will cause the DLCContent container object to be recycled and will become available for other load operations.
For that reason references should not be kept after dispose has been called.
Unload(bool)
Request that the DLC contents be unloaded from memory. This will case DLC metadata, assets and scenes to be unloaded. Note that the DLCContent container object will not be destroyed and will remain in memory until manually destroyed. Use Dispose() to unload the content and to recycle the DLCContent container object for use in other DLC load operations.
Parameters
withAssets
boolShould asset instances also be unloaded