Skip to content

@pumpkin-plugins/bedrock-addon-manager API / packs/scanner / PackScanner

Class: PackScanner ​

Defined in: packages/bedrock-addon-manager/src/packs/scanner.ts:34

Finds .mcpack and .mcaddon files and reads the resource packs in them. A file is only read again when its size or modification time changes, so scanning stays cheap with large packs. The resource packs in a .mcaddon are written out as .mcpack files in a hidden folder next to it, so they can be served like any other pack.

Constructors ​

Constructor ​

new PackScanner(files): PackScanner

Defined in: packages/bedrock-addon-manager/src/packs/scanner.ts:38

Creates a scanner over the plugin's data folder.

Parameters ​

files ​

DataFiles

Returns ​

PackScanner

Methods ​

scan() ​

scan(directory): ScanResult

Defined in: packages/bedrock-addon-manager/src/packs/scanner.ts:45

Scans a folder.

Parameters ​

directory ​

string

The packs folder, relative to the data folder. It must exist.

Returns ​

ScanResult

The packs found, in file name order, and what was left out.

Pumpkin Plugins documentation