PaperMC Despawned Items/io.fairyfox.papermc.despawneditems.config/ThrottleSettings

ThrottleSettings

class ThrottleSettings(c: FileConfiguration, logger: Logger? = null)

Per-user throttling of the despawn pipeline, read from the throttle: section.

Off by default — a server upgrading to this version sees no behaviour change until an admin sets throttle.enabled: true. See io.fairyfox.papermc.despawneditems.throttle.ThrottleManager for the semantics and io.fairyfox.papermc.despawneditems.throttle.ThrottleQuotas for the permission nodes that let different ranks get different allowances.

Constructors

ThrottleSettings

constructor(c: FileConfiguration, logger: Logger? = null)

Properties

val defaultWeight: Int

Fair-share weight for players with no despi.throttle.weight.<n> permission.

val enabled: Boolean

Master switch. When false nothing in this class is consulted on the hot path.

maxConcurrentPerPlayer

val maxConcurrentPerPlayer: Int

Relocations a single player may have in flight simultaneously.

val onLimit: String

defer (retry later, default), drop (let it despawn), or void (hand to the void/catch-all path).

onLimitDecision

val onLimitDecision: ThrottleDecision

onLimit resolved to the decision the throttler returns when a quota is exceeded.

overLimitToCatchAll

val overLimitToCatchAll: Boolean

True when an over-quota item should be handed to the void/catch-all path rather than simply lost.

val ratePerWindow: Int

Relocations a player may start per windowSeconds before being throttled.

val strategy: ThrottleStrategy

Which policies apply. Unrecognised values fall back to ThrottleStrategy.COMBINED with a warning.

throttleUnowned

val throttleUnowned: Boolean

Whether ownerless drops (mob loot, dispensers) are throttled too.

val windowSeconds: Long

Length of the rate window in seconds.