JSPrismarine

API reference / @jsprismarine/prismarine / content/packStack

content/packStack ​

Interfaces ​

PackStackRequest ​

Defined in: prismarine/src/content/packStack.ts:37

What resolvePackStack was asked to assemble.

Properties ​

bedrockPacks? ​

readonly optional bedrockPacks?: readonly string[] | "all"

Defined in: prismarine/src/content/packStack.ts:56

Which packs to compose out of a BDS behavior_packs folder, by header UUID, or 'all' for every pack the folder holds.

Defaults to the vanilla behavior pack alone. BDS ships chemistry, the editor, the server script libraries and four experimental toggles in that folder, and a world composes those only when it turns them on; a server aiming at vanilla parity turns none of them on. Education Edition content is out of scope by plan section 12 decision 8, and the editor's five editor: entities are tools for a world author rather than content a server serves.

The packs are on disk either way, so naming one here is how a server that does want it opts in.

javaVanilla? ​

readonly optional javaVanilla?: boolean

Defined in: prismarine/src/content/packStack.ts:60

Whether to include the Java vanilla datapack. Defaults to true.

overlay? ​

readonly optional overlay?: boolean

Defined in: prismarine/src/content/packStack.ts:58

Whether to include this project's block and entity vanilla overlays. Defaults to true.

pluginPacks? ​

readonly optional pluginPacks?: readonly PackSource[]

Defined in: prismarine/src/content/packStack.ts:64

Plugin packs, applied last so a plugin overrides a world.

vanilla? ​

readonly optional vanilla?: boolean

Defined in: prismarine/src/content/packStack.ts:39

Whether to include the composed vanilla Bedrock pack. Defaults to true.

worldPacks? ​

readonly optional worldPacks?: readonly PackSource[]

Defined in: prismarine/src/content/packStack.ts:62

The world's own behavior packs and datapacks, applied after the vanilla members.

ResolvedPackStack ​

Defined in: prismarine/src/content/packStack.ts:68

The stack, plus a report of the members that could not be found.

Properties ​

cache? ​

readonly optional cache?: PrefixCacheOptions

Defined in: prismarine/src/content/packStack.ts:72

The immutable vanilla prefix cache used by the default content loader, when available.

diagnostics ​

readonly diagnostics: readonly Diagnostic[]

Defined in: prismarine/src/content/packStack.ts:70

stack ​

readonly stack: PackStack

Defined in: prismarine/src/content/packStack.ts:69

Variables ​

PACK_STACK_ENV ​

const PACK_STACK_ENV: object

Defined in: prismarine/src/content/packStack.ts:29

Points the resolver at a local copy of one fetched source.

Type Declaration ​

vanillaBedrockPack ​

readonly vanillaBedrockPack: "JSP_VANILLA_BEHAVIOR_PACK" = 'JSP_VANILLA_BEHAVIOR_PACK'

A composed vanilla Bedrock behavior pack directory, or a folder of BDS vanilla layers.

vanillaDatapack ​

readonly vanillaDatapack: "JSP_VANILLA_DATAPACK" = 'JSP_VANILLA_DATAPACK'

A Java vanilla datapack directory, as the Java data generator writes one.

Functions ​

entityOverlayPackPath() ​

entityOverlayPackPath(): string

Defined in: prismarine/src/content/packStack.ts:216

The @jsprismarine/entities overlay, which declares entity types absent from Bedrock's pack.

Returns ​

string

fingerprintPackDirectories() ​

fingerprintPackDirectories(directories): string

Defined in: prismarine/src/content/packStack.ts:111

Hashes overlay paths and bytes so edits at an unchanged checkout path invalidate the cache.

Parameters ​

directories ​

readonly string[]

Returns ​

string

overlayPackPath() ​

overlayPackPath(): string

Defined in: prismarine/src/content/packStack.ts:208

The jsprismarine_vanilla overlay, which @jsprismarine/blocks publishes beside its dist.

Returns ​

string

resolvePackStack() ​

resolvePackStack(request?): ResolvedPackStack

Defined in: prismarine/src/content/packStack.ts:232

Assembles the default pack stack.

Parameters ​

request? ​

PackStackRequest = {}

Returns ​

ResolvedPackStack

The stack in apply order, and one pack.missing warning per member whose directory is not on disk.