@pumpkin-plugins/bedrock-addon-manager API / packs/pack-index / PackIndex
Class: PackIndex ​
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:9
The packs the plugin currently knows about: scans the packs folder and works out the entry for each pack.
Constructors ​
Constructor ​
new PackIndex(
files,log):PackIndex
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:16
Creates an empty index. Call refresh to fill it.
Parameters ​
files ​
log ​
Returns ​
PackIndex
Accessors ​
entries ​
Get Signature ​
get entries(): readonly
PackEntry[]
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:24
The packs to announce to clients, in the order they are listed.
Returns ​
readonly PackEntry[]
Methods ​
open() ​
open(
fileName):RandomAccessFile|undefined
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:69
Opens a listed pack for serving. Only packs in the current list can be opened.
Parameters ​
fileName ​
string
The pack's name, as in its download URL.
Returns ​
RandomAccessFile | undefined
The open file, or undefined when the pack isn't listed or can't be opened.
rebuild() ​
rebuild(
config,reachableUrl?):BuiltEntries
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:57
Works out the entries again for the packs found by the last refresh, without scanning the folder.
Parameters ​
config ​
The current settings.
overrides ​
TableValues<{ addon_pack: Field<boolean | undefined>; content_id: Field<string | undefined>; content_key: Field<string | undefined>; download_url: Field<string | undefined>; enabled: Field<boolean | undefined>; has_scripts: Field<boolean | undefined>; order: Field<number | undefined>; rtx_enabled: Field<boolean | undefined>; sub_pack_name: Field<string | undefined>; }> = ...
packs ​
SectionValues<{ directory: Field<string>; force: Field<boolean>; }> = ...
web ​
SectionValues<{ bind: Field<string>; enabled: Field<boolean>; port: Field<number>; port_forwarding: Field<boolean>; public_url: Field<string>; }> = ...
reachableUrl? ​
string
Where port forwarding made the web server reachable, if it did.
Returns ​
refresh() ​
refresh(
config,reachableUrl?):void
Defined in: packages/bedrock-addon-manager/src/packs/pack-index.ts:33
Scans the packs folder again and logs what it found.
Parameters ​
config ​
The current settings.
overrides ​
TableValues<{ addon_pack: Field<boolean | undefined>; content_id: Field<string | undefined>; content_key: Field<string | undefined>; download_url: Field<string | undefined>; enabled: Field<boolean | undefined>; has_scripts: Field<boolean | undefined>; order: Field<number | undefined>; rtx_enabled: Field<boolean | undefined>; sub_pack_name: Field<string | undefined>; }> = ...
packs ​
SectionValues<{ directory: Field<string>; force: Field<boolean>; }> = ...
web ​
SectionValues<{ bind: Field<string>; enabled: Field<boolean>; port: Field<number>; port_forwarding: Field<boolean>; public_url: Field<string>; }> = ...
reachableUrl? ​
string
Where port forwarding made the web server reachable, if it did.
Returns ​
void