Skip to content

Class: AssetLoader ​

Defined in: packages/minerender/src/assets/AssetLoader.ts:22

Loads assets from a shared, ordered registry of hosted sources and resource packs.

Constructors ​

Constructor ​

ts
new AssetLoader(): AssetLoader;

Returns ​

AssetLoader

Properties ​

PropertyModifierTypeDefault valueDescriptionDefined in
ROOTstaticstringDEFAULT_ROOTDefault asset base URL. Use setVersion to select a Minecraft version.packages/minerender/src/assets/AssetLoader.ts:25

Accessors ​

persistentScope ​

Get Signature ​

ts
get static persistentScope(): string;

Defined in: packages/minerender/src/assets/AssetLoader.ts:62

Scope for persistent cache keys. Empty with only the default vanilla source, so its entries stay valid across sessions; otherwise it names every added source (resource packs, mirrors) so their results never masquerade as vanilla assets after a reload.

Returns ​

string


version ​

Get Signature ​

ts
get static version(): string;

Defined in: packages/minerender/src/assets/AssetLoader.ts:40

Returns ​

string

Methods ​

addSource() ​

ts
static addSource(
   key, 
   source, 
   override?
): void;

Defined in: packages/minerender/src/assets/AssetLoader.ts:86

Registers a source at the highest priority. Call Caching.clear after changing sources to discard previously loaded assets.

Parameters ​

ParameterTypeDefault valueDescription
keystringundefinedName used to replace or remove this source.
sourceAssetSourceundefined-
overridebooleantrueRemoves the first source with this name before adding the new one.

Returns ​

void


get() ​

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

Defined in: packages/minerender/src/assets/AssetLoader.ts:123

Returns the first defined result in source-priority order, without merging assets.

Type Parameters ​

Type Parameter
T extends MinecraftAsset

Parameters ​

ParameterType
keyAssetKey
parserstring

Returns ​

Promise<Maybe<T>>


getAll() ​

ts
static getAll<T>(key, parser): Promise<T[]>;

Defined in: packages/minerender/src/assets/AssetLoader.ts:111

Loads from all sources and returns defined results in priority order. Any source failure rejects the call.

Type Parameters ​

Type Parameter
T extends MinecraftAsset

Parameters ​

ParameterType
keyAssetKey
parserstring

Returns ​

Promise<T[]>


getFirst() ​

ts
static getFirst<T>(keys, parser): Promise<Maybe<{
  asset: T;
  key: AssetKey;
}>>;

Defined in: packages/minerender/src/assets/AssetLoader.ts:134

Tries each path within a source before considering lower-priority sources.

Type Parameters ​

Type Parameter
T extends MinecraftAsset

Parameters ​

ParameterType
keysreadonly AssetKey[]
parserstring

Returns ​

Promise<Maybe<{ asset: T; key: AssetKey; }>>


persistentKey() ​

ts
static persistentKey(key): string;

Defined in: packages/minerender/src/assets/AssetLoader.ts:74

Prefixes a persistent cache key with the current source scope.

Parameters ​

ParameterType
keystring

Returns ​

string


removeSource() ​

ts
static removeSource(key): Maybe<AssetSource>;

Defined in: packages/minerender/src/assets/AssetLoader.ts:99

Removes and returns the first source with this name. Call Caching.clear to reload assets.

Parameters ​

ParameterType
keystring

Returns ​

Maybe<AssetSource>


setVersion() ​

ts
static setVersion(version): void;

Defined in: packages/minerender/src/assets/AssetLoader.ts:45

Selects an mcasset.cloud version, updates the vanilla source, and clears in-memory caches.

Parameters ​

ParameterType
versionstring

Returns ​

void