Skip to content

Class: Models ​

Defined in: packages/minerender/src/assets/Models.ts:33

Loads and caches Java block/item models, including inherited geometry and textures.

Constructors ​

Constructor ​

ts
new Models(): Models;

Returns ​

Models

Methods ​

clearCache() ​

ts
static clearCache(): Promise<void>;

Defined in: packages/minerender/src/assets/Models.ts:405

Clears persisted models. Use Caching.clear to also discard in-memory assets.

Returns ​

Promise<void>


get() ​

ts
static get(key, context?): Promise<Maybe<Model>>;

Defined in: packages/minerender/src/assets/Models.ts:400

Alias for getMerged.

Parameters ​

ParameterType
keyAssetKey
contextItemModelContext

Returns ​

Promise<Maybe<Model>>


getItemList() ​

ts
static getItemList(): Promise<string[]>;

Defined in: packages/minerender/src/assets/Models.ts:46

Lists item filenames from the asset source's _list.json, with a legacy model-directory fallback.

Returns ​

Promise<string[]>


getMerged() ​

ts
static getMerged(key, context?): Promise<Maybe<Model>>;

Defined in: packages/minerender/src/assets/Models.ts:375

Loads a model and resolves its parent chain. Returns undefined when the model is missing. Item keys default to GUI context and a stack count of 1. Unresolved conditions are false and numeric properties are zero. Versioned stack-size, durability, and glint defaults apply unless components override them. Pass context to supply component values, property overrides, and item references for a preview. Composite items retain independently merged children in ItemModel.parts.

Parameters ​

ParameterTypeDescription
keyAssetKeyModel key, for example AssetKey.parse("models", "minecraft:item/diamond_sword").
contextItemModelContext-

Returns ​

Promise<Maybe<Model>>


getRaw() ​

ts
static getRaw(key): Promise<Maybe<Model>>;

Defined in: packages/minerender/src/assets/Models.ts:345

Loads one model file without resolving its parents. Returns undefined when the file is missing.

Parameters ​

ParameterType
keyAssetKey

Returns ​

Promise<Maybe<Model>>


loadAndMerge() ​

ts
static loadAndMerge(key, context?): Promise<Maybe<Model>>;

Defined in: packages/minerender/src/assets/Models.ts:54

Parameters ​

ParameterType
keyAssetKey
contextItemModelContext

Returns ​

Promise<Maybe<Model>>