Remarks

The parent class for all Minecraft data types, i.e. MinecraftServerClient.

• MinecraftDataType

  ↳ ClientAttachable

• IClientAttachable

• constructor

• filePath
• format_version
• minecraft:attachable

• DirectoryPath

• addAnimateScript
• addAnimation
• addGeometry
• addInitializeVariable
• addMaterials
• addPreAnimationVariable
• addRenderController
• replacer
• serialize
• toFile
• createFilePath
• createFromTemplate
• deserialize
• fromFile
• fromPathOrTemplate

• new ClientAttachable(filepath, template): ClientAttachable

Name	Type
filepath	string
template	IClientAttachable

ClientAttachable

MinecraftDataType.constructor

ts/app/types/client/attachable.ts:30

• filePath: string

MinecraftDataType.filePath

ts/app/types/minecraft.ts:23

---

• format_version: `${number}.${number}.${number}`

IClientAttachable.format_version

ts/app/types/client/attachable.ts:21

---

• minecraft:attachable: Object

Name	Type
description	IClientAttachableDescription

IClientAttachable.minecraft:attachable

ts/app/types/client/attachable.ts:22

• get DirectoryPath(): string

string

Remarks

The directory where this type of file is kept.

MinecraftDataType.DirectoryPath

ts/app/types/client/attachable.ts:26

▸ addAnimateScript(...animations): void

Name	Type
...animations	(string | { [key: string]: string; })[]

void

ts/app/types/client/attachable.ts:119

---

▸ addAnimation(...animations): void

Name	Type
...animations	{ name: string ; reference: string }[]

void

ts/app/types/client/attachable.ts:112

---

▸ addGeometry(...geometry): void

Name	Type
...geometry	{ name: string ; reference: `geometry.${string}` }[]

void

ts/app/types/client/attachable.ts:95

---

▸ addInitializeVariable(...variables): void

Name	Type
...variables	string[]

void

ts/app/types/client/attachable.ts:66

---

▸ addMaterials(...materials): void

Name	Type
...materials	{ name: string ; reference: string }[]

void

ts/app/types/client/attachable.ts:88

---

▸ addPreAnimationVariable(...variables): void

Name	Type
...variables	string[]

void

ts/app/types/client/attachable.ts:77

---

▸ addRenderController(...render_controllers): void

Name	Type
...render_controllers	MolangOption[]

void

ts/app/types/client/attachable.ts:102

---

▸ replacer(key, value): any

Name	Type
key	string
value	any

any

MinecraftDataType.replacer

ts/app/types/minecraft.ts:72

---

▸ serialize(): string

string

A string representation of this object.

Remarks

Serializes this object to a string.

MinecraftDataType.serialize

ts/app/types/minecraft.ts:63

---

▸ toFile(handleExisting?): File

Name	Type	Description
handleExisting?	"overwrite" | "overwrite_silent"	How to handle existing files. Undefined will not overwrite, 'overwite' replaces the file with this object, 'overwrite_silent' does the same with no terminal log.

File

A File object with this MinecraftDataType's filepath, and this object serialized as the file contents.

Remarks

Creates a File object from this MinecraftDataType.

MinecraftDataType.toFile

ts/app/types/minecraft.ts:98

---

▸ createFilePath(nameData): string

Name	Type	Description
nameData	NameData	The namedata to use when creating the filepath.

string

The filepath as a string.

Remarks

Creates a filepath for this object type from a NameData.

MinecraftDataType.createFilePath

ts/app/types/minecraft.ts:46

---

▸ createFromTemplate(nameData): ClientAttachable

Name	Type	Description
nameData	NameData	The namedata to use for identifiers and the filepath.

ClientAttachable

An instance of this data type.

Remarks

Creates a new instance of the data type using reasonable defaults from a NameData.

MinecraftDataType.createFromTemplate

ts/app/types/client/attachable.ts:36

---

▸ deserialize<T>(create, filepath, json): T

Name
T

Name	Type	Description
create	(filePath: string, template: any) => T	The child of MinecraftDataType to create.
filepath	string	The filepath the MinecraftDataType can be written to with toFile.
json	string	The source string this should be deserialized from.

T

An instance of the MinecraftDataType child provided.

Remarks

Creates an instace of a MinecraftDataType child from a source string, used in fromFile.

MinecraftDataType.deserialize

ts/app/types/minecraft.ts:83

---

▸ fromFile<T>(create, file): T

Name
T

Name	Type	Description
create	(filePath: string, template: any) => T	The child of MinecraftDataType to create.
file	File	The File object used to deserialize into this object.

T

An instance of the MinecraftDataType child provided.

Remarks

Crates an instance of a MinecraftDataTypeChild from a File.

MinecraftDataType.fromFile

ts/app/types/minecraft.ts:108

---

▸ fromPathOrTemplate<T>(create, path): T

Name
T

Name	Type	Description
create	(filePath: string, template: any) => T	The child of MinecraftDataType to create.
path	string	The filepath to create the object from.

T

The deserialized file as a child of MinecraftDataType, or this object's createFromTemplate default if the file doesn't exist.

Remarks

Creates a MinecraftDataType object from a filepath, or a template if that filepath doesn't exist.

MinecraftDataType.fromPathOrTemplate

ts/app/types/minecraft.ts:118