-
Notifications
You must be signed in to change notification settings - Fork 1
WorldManifest
Remarks
A class for working with manifest files.
-
↳
WorldManifest
- addAuthors
- replacer
- serialize
- toFile
- createFilePath
- createFromTemplate
- deserialize
- fromFile
- fromPathOrTemplate
• new WorldManifest(filepath, template): WorldManifest
| Name | Type |
|---|---|
filepath |
string |
template |
IManifest |
• Optional dependencies: (IManifestDependencyPack | IManifestDependencyScript)[]
• filePath: string
• format_version: number
• header: IManifestHeader
• Optional metadata: Object
| Name | Type |
|---|---|
authors |
string[] |
• modules: IManifestModule[]
• get DirectoryPath(): string
string
Remarks
The directory where this type of file is kept.
Manifest.DirectoryPath
▸ addAuthors(authors): void
| Name | Type |
|---|---|
authors |
string[] |
void
▸ replacer(key, value): any
| Name | Type |
|---|---|
key |
string |
value |
any |
any
▸ serialize(): string
string
A string representation of this object.
Remarks
Serializes this object to a string.
▸ 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. |
A File object with this MinecraftDataType's filepath, and this object serialized as the file contents.
Remarks
Creates a File object from this MinecraftDataType.
▸ 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.
▸ createFromTemplate(): WorldManifest
An instance of this data type.
Remarks
Creates a new instance of the data type using reasonable defaults from a NameData.
▸ 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.
▸ 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.
▸ 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.