@minecraft/creator-tools
Version:
Minecraft Creator Tools command line and libraries.
46 lines (45 loc) • 2.06 kB
TypeScript
import IFile from "../storage/IFile";
import { IEventHandler } from "ste-events";
import Project from "../app/Project";
import IWorldManifest, { IWorldManifestHeader } from "./IWorldManifest";
export default class WorldTemplateManifestDefinition {
private _file?;
private _id?;
private _isLoaded;
private _loadedWithComments;
definition?: IWorldManifest;
private _onLoaded;
get isLoaded(): boolean;
get file(): IFile | undefined;
set file(newFile: IFile | undefined);
get onLoaded(): import("ste-events").IEvent<WorldTemplateManifestDefinition, WorldTemplateManifestDefinition>;
get description(): string | undefined;
set description(newDescription: string | undefined);
get name(): string | undefined;
set name(newName: string | undefined);
get uuid(): string | undefined;
set uuid(newId: string | undefined);
static ensureOnFile(file: IFile, loadHandler?: IEventHandler<WorldTemplateManifestDefinition, WorldTemplateManifestDefinition>): Promise<WorldTemplateManifestDefinition>;
get baseGameVersion(): number[];
setBaseGameVersion(versionArray: number[], project: Project): void;
persist(): boolean;
ensureDefinition(name: string, description: string): void;
ensureHeaderForProject(project: Project): IWorldManifestHeader;
ensureHeader(name: string, description: string): IWorldManifestHeader;
getDefaultHeader(name: string, description: string): {
name: string;
description: string;
version: number[];
min_engine_version: number[];
uuid: string;
base_game_version: number[];
};
save(): Promise<void>;
/**
* Loads the definition from the file.
* @param preserveComments If true, uses comment-preserving JSON parsing for edit/save cycles.
* If false (default), uses efficient standard JSON parsing.
* Can be called again with true to "upgrade" a read-only load to read/write.
*/
load(preserveComments?: boolean): Promise<void>;
}