Interface IBuildCache
Base interface for the Build Caching
Namespace: UnityEditor.Build.Pipeline.Interfaces
Syntax
public interface IBuildCache : IContextObjectMethods
GetCachedArtifactsDirectory(CacheEntry)
Returns the path where artifact data can be saved in the cache
Declaration
string GetCachedArtifactsDirectory(CacheEntry entry)Parameters
| Type | Name | Description |
|---|---|---|
| CacheEntry | entry | Cache entry to get the path |
Returns
| Type | Description |
|---|---|
| String | Path on disk where to save cached artifacts |
GetCachedInfoFile(CacheEntry)
Returns the path where info data can be saved in the cache
Declaration
string GetCachedInfoFile(CacheEntry entry)Parameters
| Type | Name | Description |
|---|---|---|
| CacheEntry | entry | Cache entry to get the path |
Returns
| Type | Description |
|---|---|
| String | Path on disk where to save cached info |
GetCacheEntry(GUID, Int32)
Gets a CacheEntry for an asset identified by its GUID.
Declaration
CacheEntry GetCacheEntry(GUID asset, int version = 1)Parameters
| Type | Name | Description |
|---|---|---|
| GUID | asset | GUID identifier for an asset from the Asset Database |
| Int32 | version | Version number of the system asking for an entry to distinguish it from previous incompatible entries. (Optional) |
Returns
| Type | Description |
|---|---|
| CacheEntry | CacheEntry representing current asset. |
GetCacheEntry(ObjectIdentifier, Int32)
Gets a CacheEntry for an object identified by an Object Identifier.
Declaration
CacheEntry GetCacheEntry(ObjectIdentifier objectID, int version = 1)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectIdentifier | objectID | Object identifier for an object |
| Int32 | version | Version number of the system asking for an entry to distinguish it from previous incompatible entries. (Optional) |
Returns
| Type | Description |
|---|---|
| CacheEntry | CacheEntry representing an object identifier. |
GetCacheEntry(String, Int32)
Gets a CacheEntry for a file identified by its relative path.
Declaration
CacheEntry GetCacheEntry(string path, int version = 1)Parameters
| Type | Name | Description |
|---|---|---|
| String | path | Relative path of a file on disk |
| Int32 | version | Version number of the system asking for an entry to distinguish it from previous incompatible entries. (Optional) |
Returns
| Type | Description |
|---|---|
| CacheEntry | CacheEntry representing a file on disk. |
HasAssetOrDependencyChanged(CachedInfo)
Checks if the CachedInfo passed in needs to be rebuilt
Declaration
bool HasAssetOrDependencyChanged(CachedInfo info)Parameters
| Type | Name | Description |
|---|---|---|
| CachedInfo | info | Cached Info to check |
Returns
| Type | Description |
|---|---|
| Boolean |
|
LoadCachedData(IList<CacheEntry>, out IList<CachedInfo>)
Loads a set of CachedInfos from the cache
Declaration
void LoadCachedData(IList<CacheEntry> entries, out IList<CachedInfo> cachedInfos)Parameters
| Type | Name | Description |
|---|---|---|
| IList<CacheEntry> | entries | List of cache entries to load |
| IList<CachedInfo> | cachedInfos | Out list of cached infos loaded |
SaveCachedData(IList<CachedInfo>)
Saves a set of CachedInfos to the cache
Declaration
void SaveCachedData(IList<CachedInfo> infos)Parameters
| Type | Name | Description |
|---|---|---|
| IList<CachedInfo> | infos | List of cached infos to save |