Class: AssetLoader

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

Constructors

Constructor

new AssetLoader(): AssetLoader;

Returns

AssetLoader

Properties

Property	Modifier	Type	Default value	Defined in
ROOT	static	string	DEFAULT_ROOT	packages/minerender/src/assets/AssetLoader.ts:25

Accessors

persistentScope

Get Signature

get static persistentScope(): string;

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

Scope for persistent cache keys. Empty with only the default vanilla sources, so their 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

get static version(): string;

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

Returns

string

Methods

addSource()

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

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

Parameters

Parameter	Type	Default value
key	string	undefined
source	AssetSource	undefined
override	boolean	true

Returns

void

---

get()

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

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

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

Type Parameters

Type Parameter
T extends MinecraftAsset

Parameters

Parameter	Type
key	AssetKey
parser	string

Returns

Promise<Maybe<T>>

---

getAll()

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

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

Type Parameters

Type Parameter
T extends MinecraftAsset

Parameters

Parameter	Type
key	AssetKey
parser	string

Returns

Promise<T[]>

---

getFirst()

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

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

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

Type Parameters

Type Parameter
T extends MinecraftAsset

Parameters

Parameter	Type
keys	readonly AssetKey[]
parser	string

Returns

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

---

persistentKey()

static persistentKey(key): string;

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

Prefixes a persistent cache key with the current source scope.

Parameters

Parameter	Type
key	string

Returns

string

---

removeSource()

static removeSource(key): Maybe<AssetSource>;

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

Parameters

Parameter	Type
key	string

Returns

Maybe<AssetSource>

---

setVersion()

static setVersion(version): void;

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

Parameters

Parameter	Type
version	string

Returns

void