Remarks

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

• MinecraftDataType

  ↳ ClientSoundDefinitions

• IClientSoundDefinitions

• constructor

• filePath
• format_version
• sound_definitions

• DirectoryPath

• addSound
• convertSoundsToObjects
• replacer
• serialize
• toFile
• createFilePath
• createFromTemplate
• deserialize
• fileWithAddedSound
• fromFile
• fromPathOrTemplate

• new ClientSoundDefinitions(filepath, template): ClientSoundDefinitions

Name	Type
filepath	string
template	IClientSoundDefinitions

ClientSoundDefinitions

MinecraftDataType.constructor

ts/app/types/client/sound_definitions.ts:43

• filePath: string

MinecraftDataType.filePath

ts/app/types/minecraft.ts:23

---

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

IClientSoundDefinitions.format_version

ts/app/types/client/sound_definitions.ts:34

---

• sound_definitions: Object

▪ [key: string]: IClientSoundDefinition

IClientSoundDefinitions.sound_definitions

ts/app/types/client/sound_definitions.ts:35

• get DirectoryPath(): string

string

Remarks

The directory where this type of file is kept.

MinecraftDataType.DirectoryPath

ts/app/types/client/sound_definitions.ts:39

▸ addSound(name, sound): void

Name	Type
name	string
sound	IClientSoundDefinition

void

ts/app/types/client/sound_definitions.ts:99

---

▸ convertSoundsToObjects(): void

void

ts/app/types/client/sound_definitions.ts:104

---

▸ replacer(key, value): any

Name	Type
key	string
value	any

any

MinecraftDataType.replacer

ts/app/types/client/sound_definitions.ts:71

---

▸ 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(): File

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/client/sound_definitions.ts:67

---

▸ createFilePath(): string

string

The filepath as a string.

Remarks

Creates a filepath for this object type from a NameData.

MinecraftDataType.createFilePath

ts/app/types/client/sound_definitions.ts:49

---

▸ createFromTemplate(): ClientSoundDefinitions

ClientSoundDefinitions

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/sound_definitions.ts:53

---

▸ 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

---

▸ fileWithAddedSound(name, sound): File

Name	Type
name	string
sound	IClientSoundDefinition

File

ts/app/types/client/sound_definitions.ts:60

---

▸ 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