Class: ArchiveAssetSource
Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:24
Loads assets from resource-pack ZIP entries. Register it with AssetLoader.addSource.
Extends
Implements
Constructors
Constructor
new ArchiveAssetSource(archiveProxy, options?): ArchiveAssetSource;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:31
Parameters
| Parameter | Type |
|---|---|
archiveProxy | ArchiveProxy |
options | ArchiveAssetSourceOptions |
Returns
ArchiveAssetSource
Overrides
AssetSource.constructorProperties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
_archiveProxy | readonly | ArchiveProxy | packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:26 |
Accessors
cacheId
Get Signature
get cacheId(): Maybe<string>;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:47
Identifies this source's content across sessions for persistent caching. Sources that cannot tell whether their content changed (an unnamed archive, for example) return undefined, which keeps their results out of long-lived caches.
Returns
Maybe<string>
Overrides
Methods
assetBasePath()
assetBasePath(key): string;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:131
Parameters
| Parameter | Type |
|---|---|
key | AssetKey |
Returns
string
blocks()
blocks(key): Promise<boolean>;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:77
Whether this source prevents lower-priority sources from supplying the key. Its own assets remain available.
Parameters
| Parameter | Type |
|---|---|
key | AssetKey |
Returns
Promise<boolean>
Overrides
get()
get<T>(key, parser): Promise<Maybe<T>>;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:84
Returns a parsed asset, or undefined to allow fallback. Load and parse failures should reject.
Type Parameters
| Type Parameter |
|---|
T extends MinecraftAsset |
Parameters
| Parameter | Type |
|---|---|
key | AssetKey |
parser | string |
Returns
Promise<Maybe<T>>
Overrides
getEntries()
getEntries(): Promise<ArchiveEntry[]>;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:53
Returns
Promise<ArchiveEntry[]>
Implementation of
getEntry()
getEntry(path): Promise<Maybe<ArchiveEntry>>;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:60
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
Promise<Maybe<ArchiveEntry>>
blob()
static blob(blob, options?): ArchiveAssetSource;Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:43
Creates a browser ZIP source from a Blob or File.
Parameters
| Parameter | Type |
|---|---|
blob | Blob |
options? | ArchiveAssetSourceOptions |
Returns
ArchiveAssetSource