Skip to content

Class: Renames ​

Defined in: packages/minerender/src/assets/Renames.ts:8

Maps IDs that older Minecraft versions used to the IDs the selected version uses.

Constructors ​

Constructor ​

ts
new Renames(): Renames;

Returns ​

Renames

Methods ​

get() ​

ts
static get(root?): Promise<Maybe<object & Record<RenameKind, Record<string, {
  ranges: object[];
  registered: boolean;
}>>>>;

Defined in: packages/minerender/src/assets/Renames.ts:10

Loads the selected version's rename table, or undefined when its published data has none.

Parameters ​

ParameterType
root?string

Returns ​

Promise<Maybe<object & Record<RenameKind, Record<string, { ranges: object[]; registered: boolean; }>>>>


key() ​

ts
static key(kind, key): Promise<Maybe<AssetKey>>;

Defined in: packages/minerender/src/assets/Renames.ts:29

Returns a copy of key for the replacement ID, or undefined when the ID keeps its meaning.

Parameters ​

ParameterType
kindRenameKind
keyAssetKey

Returns ​

Promise<Maybe<AssetKey>>


resolve() ​

ts
static resolve(
   kind, 
   id, 
   dataVersion?, 
   root?
): Promise<Maybe<string>>;

Defined in: packages/minerender/src/assets/Renames.ts:19

Returns the ID that replaced id, or undefined when id keeps its meaning. Without a data version, an ID that the selected version still registers keeps its meaning.

Parameters ​

ParameterType
kindRenameKind
idstring
dataVersion?number
root?string

Returns ​

Promise<Maybe<string>>