Remarks

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

• MinecraftDataType

  ↳ ServerDialogue

• IServerDialogue

• constructor

• filePath
• format_version
• minecraft:npc_dialogue

• DirectoryPath

• addButtonToAllScenes
• addScene
• addToAllButtonCommands
• addToAllCloseCommands
• addToAllOpenCommands
• replacer
• serialize
• toFile
• createFilePath
• createFromTemplate
• deserialize
• fromFile
• fromPathOrTemplate

• new ServerDialogue(filepath, template): ServerDialogue

Name	Type
filepath	string
template	IServerDialogue

ServerDialogue

MinecraftDataType.constructor

ts/app/types/server/dialogue.ts:35

• filePath: string

MinecraftDataType.filePath

ts/app/types/minecraft.ts:23

---

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

IServerDialogue.format_version

ts/app/types/server/dialogue.ts:26

---

• minecraft:npc_dialogue: Object

Name	Type
scenes	IServerDialogueScene[]

IServerDialogue.minecraft:npc_dialogue

ts/app/types/server/dialogue.ts:27

• get DirectoryPath(): string

string

Remarks

The directory where this type of file is kept.

MinecraftDataType.DirectoryPath

ts/app/types/server/dialogue.ts:31

▸ addButtonToAllScenes(button): void

Name	Type
button	Object
button.commands	string[]
button.name	RawMessage

void

ts/app/types/server/dialogue.ts:54

---

▸ addScene(scene): void

Name	Type
scene	IServerDialogueScene

void

ts/app/types/server/dialogue.ts:50

---

▸ addToAllButtonCommands(...commands): void

Name	Type
...commands	string[]

void

ts/app/types/server/dialogue.ts:75

---

▸ addToAllCloseCommands(...commands): void

Name	Type
...commands	string[]

void

ts/app/types/server/dialogue.ts:61

---

▸ addToAllOpenCommands(...commands): void

Name	Type
...commands	string[]

void

ts/app/types/server/dialogue.ts:68

---

▸ 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): ServerDialogue

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

ServerDialogue

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/server/dialogue.ts:41

---

▸ 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