Skip to content

Class: HostedAssetSource ​

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:28

Loads assets over HTTP from a Minecraft directory tree rooted at the constructor's URL.

Extends ​

Constructors ​

Constructor ​

ts
new HostedAssetSource(root, options?): HostedAssetSource;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:175

Creates a hosted source for AssetLoader.addSource. Set options.retryDefaults to false to restrict lookups to the requested namespace and root.

Parameters ​

ParameterType
rootstring
options?Partial<HostedAssetSourceOptions>

Returns ​

HostedAssetSource

Overrides ​

ts
AssetSource.constructor

Properties ​

PropertyModifierTypeDefined in
BINARYreadonlyResponseParser<BinaryAsset>packages/minerender/src/assets/source/HostedAssetSource.ts:82
BLOCKSTATEreadonlyResponseParser<BlockState>packages/minerender/src/assets/source/HostedAssetSource.ts:37
IMAGEreadonlyResponseParser<TextureAsset>packages/minerender/src/assets/source/HostedAssetSource.ts:60
JSONreadonlyResponseParser<any>packages/minerender/src/assets/source/HostedAssetSource.ts:75
LISTreadonlyResponseParser<ListAsset>packages/minerender/src/assets/source/HostedAssetSource.ts:68
METAreadonlyResponseParser<MinecraftTextureMeta>packages/minerender/src/assets/source/HostedAssetSource.ts:44
MODELreadonlyResponseParser<Model>packages/minerender/src/assets/source/HostedAssetSource.ts:30
NBTreadonlyResponseParser<NBTAsset>packages/minerender/src/assets/source/HostedAssetSource.ts:52
PARSER_MAPreadonlyMap<AssetParser, ResponseParser<any>>packages/minerender/src/assets/source/HostedAssetSource.ts:92

Accessors ​

cacheId ​

Get Signature ​

ts
get cacheId(): string;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:185

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 ​

string

Overrides ​

AssetSource.cacheId


options ​

Get Signature ​

ts
get options(): HostedAssetSourceOptions;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:189

Returns ​

HostedAssetSourceOptions


root ​

Get Signature ​

ts
get root(): string;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:181

Returns ​

string

Methods ​

assetBasePath() ​

ts
assetBasePath(key): string;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:164

Parameters ​

ParameterType
keyAssetKey

Returns ​

string


blocks() ​

ts
blocks(key): boolean | Promise<boolean>;

Defined in: packages/minerender/src/assets/source/AssetSource.ts:16

Whether this source prevents lower-priority sources from supplying the key. Its own assets remain available.

Parameters ​

ParameterType
keyAssetKey

Returns ​

boolean | Promise<boolean>

Inherited from ​

AssetSource.blocks


get() ​

ts
get<T>(key, parser): Promise<Maybe<T>>;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:193

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
parserAssetParser

Returns ​

Promise<Maybe<T>>

Overrides ​

AssetSource.get


loadOrRetryWithDefaults() ​

ts
loadOrRetryWithDefaults<T>(key, parser): Promise<Maybe<T>>;

Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:104

Retries missing assets with the minecraft namespace and default root. Other failures reject.

Type Parameters ​

Type Parameter
T extends MinecraftAsset

Parameters ​

ParameterType
keyAssetKey
parserResponseParser<T>

Returns ​

Promise<Maybe<T>>