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
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
| Parameter | Type |
|---|---|
root | string |
options? | Partial<HostedAssetSourceOptions> |
Returns
HostedAssetSource
Overrides
AssetSource.constructorProperties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
BINARY | readonly | ResponseParser<BinaryAsset> | packages/minerender/src/assets/source/HostedAssetSource.ts:82 |
BLOCKSTATE | readonly | ResponseParser<BlockState> | packages/minerender/src/assets/source/HostedAssetSource.ts:37 |
IMAGE | readonly | ResponseParser<TextureAsset> | packages/minerender/src/assets/source/HostedAssetSource.ts:60 |
JSON | readonly | ResponseParser<any> | packages/minerender/src/assets/source/HostedAssetSource.ts:75 |
LIST | readonly | ResponseParser<ListAsset> | packages/minerender/src/assets/source/HostedAssetSource.ts:68 |
META | readonly | ResponseParser<MinecraftTextureMeta> | packages/minerender/src/assets/source/HostedAssetSource.ts:44 |
MODEL | readonly | ResponseParser<Model> | packages/minerender/src/assets/source/HostedAssetSource.ts:30 |
NBT | readonly | ResponseParser<NBTAsset> | packages/minerender/src/assets/source/HostedAssetSource.ts:52 |
PARSER_MAP | readonly | Map<AssetParser, ResponseParser<any>> | packages/minerender/src/assets/source/HostedAssetSource.ts:92 |
Accessors
cacheId
Get Signature
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
options
Get Signature
get options(): HostedAssetSourceOptions;Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:189
Returns
HostedAssetSourceOptions
root
Get Signature
get root(): string;Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:181
Returns
string
Methods
assetBasePath()
assetBasePath(key): string;Defined in: packages/minerender/src/assets/source/HostedAssetSource.ts:164
Parameters
| Parameter | Type |
|---|---|
key | AssetKey |
Returns
string
blocks()
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
| Parameter | Type |
|---|---|
key | AssetKey |
Returns
boolean | Promise<boolean>
Inherited from
get()
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
| Parameter | Type |
|---|---|
key | AssetKey |
parser | AssetParser |
Returns
Promise<Maybe<T>>
Overrides
loadOrRetryWithDefaults()
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
| Parameter | Type |
|---|---|
key | AssetKey |
parser | ResponseParser<T> |
Returns
Promise<Maybe<T>>