Skip to content

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 ​

ts
new ArchiveAssetSource(archiveProxy, options?): ArchiveAssetSource;

Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:31

Parameters ​

ParameterType
archiveProxyArchiveProxy
optionsArchiveAssetSourceOptions

Returns ​

ArchiveAssetSource

Overrides ​

ts
AssetSource.constructor

Properties ​

PropertyModifierTypeDefined in
_archiveProxyreadonlyArchiveProxypackages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:26

Accessors ​

cacheId ​

Get Signature ​

ts
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 ​

AssetSource.cacheId

Methods ​

assetBasePath() ​

ts
assetBasePath(key): string;

Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:131

Parameters ​

ParameterType
keyAssetKey

Returns ​

string


blocks() ​

ts
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 ​

ParameterType
keyAssetKey

Returns ​

Promise<boolean>

Overrides ​

AssetSource.blocks


get() ​

ts
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 ​

ParameterType
keyAssetKey
parserstring

Returns ​

Promise<Maybe<T>>

Overrides ​

AssetSource.get


getEntries() ​

ts
getEntries(): Promise<ArchiveEntry[]>;

Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:53

Returns ​

Promise<ArchiveEntry[]>

Implementation of ​

ArchiveProxy.getEntries


getEntry() ​

ts
getEntry(path): Promise<Maybe<ArchiveEntry>>;

Defined in: packages/minerender/src/assets/source/archive/ArchiveAssetSource.ts:60

Parameters ​

ParameterType
pathstring

Returns ​

Promise<Maybe<ArchiveEntry>>


blob() ​

ts
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 ​

ParameterType
blobBlob
options?ArchiveAssetSourceOptions

Returns ​

ArchiveAssetSource