@pumpkin-plugins/distant-horizons-support-pumpkin API / flow/byte-credit / ByteCredit

Class: ByteCredit

Defined in: packages/distant-horizons-support-pumpkin/src/flow/byte-credit.ts:4

Tracks per-client upload allowance in DH's decimal kilobytes per second.

Methods

canSend()

canSend(packetBytes, now): boolean

Defined in: packages/distant-horizons-support-pumpkin/src/flow/byte-credit.ts:24

Returns whether one complete packet fits the allowance accrued by this time.

Parameters

packetBytes

number

now

number

Returns

boolean

---

consume()

consume(packetBytes): void

Defined in: packages/distant-horizons-support-pumpkin/src/flow/byte-credit.ts:30

Charges a packet after a successful send.

Parameters

packetBytes

number

Returns

void

---

setRate()

setRate(rateKbps, now): void

Defined in: packages/distant-horizons-support-pumpkin/src/flow/byte-credit.ts:16

Applies a negotiated rate change without retaining an unlimited credit balance.

Parameters

rateKbps

number

now

number

Returns

void