Skip to content

@pumpkin-plugins/tab-display API / service / TabDisplayService

Class: TabDisplayService ​

Defined in: packages/tab-display/src/service.ts:82

Bounded, changed-only display reconciliation with a host-free test boundary.

Constructors ​

Constructor ​

new TabDisplayService(options): TabDisplayService

Defined in: packages/tab-display/src/service.ts:103

Creates the service from a validated config snapshot.

Parameters ​

options ​

TabDisplayServiceOptions

Returns ​

TabDisplayService

Methods ​

inspect() ​

inspect(uuid): PlayerSnapshot & object | undefined

Defined in: packages/tab-display/src/service.ts:121

Returns one copied online snapshot and configured placeholder IDs, never resolved values.

Parameters ​

uuid ​

string

Returns ​

PlayerSnapshot & object | undefined


setConfig() ​

setConfig(value): ApplyResult

Defined in: packages/tab-display/src/service.ts:110

Validates the whole replacement before atomically swapping configuration.

Parameters ​

value ​

unknown

Returns ​

ApplyResult


shutdown() ​

shutdown(): void

Defined in: packages/tab-display/src/service.ts:195

Restores plugin-owned changes for online players before unload.

Returns ​

void


status() ​

status(): TabDisplayStatus

Defined in: packages/tab-display/src/service.ts:203

Reports safe runtime state without resolved placeholder values or player names.

Returns ​

TabDisplayStatus


tick() ​

tick(): void

Defined in: packages/tab-display/src/service.ts:134

Advances bounded placeholder work and commits only complete display generations.

Returns ​

void

pumpkin-plugins documentation