peanut-framework / Classes/Properties/manifest / Manifest

Class: Manifest

Manifest class used to create a pack manifest.

Param

Options for constructing a manifest.

Example

project.manifest = new Manifest({
   header: { name: "Peanut Example", description: "Example pack" },
});

Constructors

new Manifest()

new Manifest(options?): Manifest

Parameters

options?

dependencies

{ [key: string]: Dependency; debug-utilities: Dependency; server: Dependency; server-admin: Dependency; server-editor: Dependency; server-gametest: Dependency; server-net: Dependency; server-ui: Dependency; }

dependencies.debug-utilities

Dependency

dependencies.server

Dependency

dependencies.server-admin

Dependency

dependencies.server-editor

Dependency

dependencies.server-gametest

Dependency

dependencies.server-net

Dependency

dependencies.server-ui

Dependency

header

{ description: string; min_engine_version: number[]; name: string; uuid: string; version: number[]; }

header.description

string

header.min_engine_version

number[]

header.name

string

header.uuid

string

header.version

number[]

metadata

{ authors: string[]; license: string; url: string; }

metadata.authors

string[]

metadata.license

string

metadata.url

string

modules

{ scripts: { entry: string; }; }

modules.scripts

{ entry: string; }

modules.scripts.entry

string

Returns

Manifest

Methods

compile()

compile(
   rePath, 
   bePath, 
   oldManifest?): void

Compiles a finished manifest class to JSON. Use after all other methods on this instance to generate it.

Parameters

rePath

string

bePath

string

oldManifest?

any

Returns

void

---

properties()

properties(options?): void

Parameters

options?

dependencies

{ [key: string]: Dependency; debug-utilities: Dependency; server: Dependency; server-admin: Dependency; server-editor: Dependency; server-gametest: Dependency; server-net: Dependency; server-ui: Dependency; }

dependencies.debug-utilities

Dependency

dependencies.server

Dependency

dependencies.server-admin

Dependency

dependencies.server-editor

Dependency

dependencies.server-gametest

Dependency

dependencies.server-net

Dependency

dependencies.server-ui

Dependency

header

{ description: string; min_engine_version: number[]; name: string; uuid: string; version: number[]; }

header.description

string

header.min_engine_version

number[]

header.name

string

header.uuid

string

header.version

number[]

metadata

{ authors: string[]; license: string; url: string; }

metadata.authors

string[]

metadata.license

string

metadata.url

string

modules

{ scripts: { entry: string; }; }

modules.scripts

{ entry: string; }

modules.scripts.entry

string

Returns

void