Skip to content

Class: AssetKey ​

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

Locates an asset by namespace, directory, extension, and optional asset root.

Extends ​

Constructors ​

Constructor ​

ts
new AssetKey(
   namespace, 
   path, 
   assetType?, 
   type?, 
   rootType?, 
   extension?, 
   root?
): AssetKey;

Defined in: packages/minerender/src/assets/AssetKey.ts:52

Creates a key from separate path components. Use parse for a combined reference.

Parameters ​

ParameterTypeDefault valueDescription
namespacestringundefined-
pathstringundefined-
assetType?stringundefinedAsset directory, such as models, textures, or blockstates.
type?stringundefinedSubdirectory, such as block or item.
rootType?string"assets"Top-level directory, usually assets or data.
extension?string".json"-
root?stringundefinedBase URL override for hosted asset sources.

Returns ​

AssetKey

Overrides ​

BasicAssetKey.constructor

Properties ​

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
assetType?publicstringundefinedAsset directory, such as models, textures, or blockstates.-packages/minerender/src/assets/AssetKey.ts:54
extensionpublicstring".json"--packages/minerender/src/assets/AssetKey.ts:57
isAssetKeyreadonlytruetrue--packages/minerender/src/assets/AssetKey.ts:42
namespacereadonlystringundefined-BasicAssetKey.namespacepackages/minerender/src/assets/AssetKey.ts:53
pathreadonlystringundefined-BasicAssetKey.pathpackages/minerender/src/assets/AssetKey.ts:53
root?publicstringundefinedBase URL override for hosted asset sources.-packages/minerender/src/assets/AssetKey.ts:58
rootTypepublicstring"assets"Top-level directory, usually assets or data.-packages/minerender/src/assets/AssetKey.ts:56
type?publicstringundefinedSubdirectory, such as block or item.-packages/minerender/src/assets/AssetKey.ts:55

Methods ​

getFullPath() ​

ts
getFullPath(): string;

Defined in: packages/minerender/src/assets/AssetKey.ts:112

Joins the type subdirectory and path without adding a namespace or file extension.

Returns ​

string


serialize() ​

ts
serialize(): string;

Defined in: packages/minerender/src/assets/AssetKey.ts:126

Returns a cache identifier that includes the explicit root or AssetLoader.ROOT.

Returns ​

string

Overrides ​

BasicAssetKey.serialize


toNamespacedString() ​

ts
toNamespacedString(): string;

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

Returns ​

string

Overrides ​

BasicAssetKey.toNamespacedString


toString() ​

ts
toString(): string;

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

Returns a string representation of an object.

Returns ​

string

Overrides ​

BasicAssetKey.toString


parse() ​

ts
static parse(
   assetType, 
   str, 
   origin?
): AssetKey;

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

Parses an asset reference such as minecraft:block/stone. A missing namespace defaults to the origin's namespace or minecraft.

Parameters ​

ParameterTypeDescription
assetTypestringAsset category, such as models or textures.
strstringPath with an optional namespace and file extension.
origin?AssetKeySupplies the asset root, default namespace, and non-texture extension.

Returns ​

AssetKey

A key with the matching extension removed from its path. Textures use .png; other assets use the origin's extension or .json.