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

ThrottleStrategy

enum ThrottleStrategy : Enum<ThrottleStrategy>

Which per-user throttling policies are active. Selected by throttle.strategy.

Kept as an enum with capability flags rather than a set of booleans so an admin picks one intelligible word, and so io.fairyfox.papermc.despawneditems.throttle.ThrottleManager can branch without string comparisons on the hot path.

Entries

NONE

No per-user throttling — the global performance budget is the only bound.

RATE

"Max per chunk of time": N relocations per player per window.

CONCURRENT

"Max per each one": N relocations in flight per player at once.

FAIR_SHARE

Weighted round-robin so no one player monopolises the drain.

COMBINED

All three together — the recommended setting when throttling is switched on.

Types

Companion

object Companion

Properties

appliesConcurrent

val appliesConcurrent: Boolean

appliesFairShare

val appliesFairShare: Boolean

appliesRate

val appliesRate: Boolean

entries

val entries: EnumEntries<ThrottleStrategy>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): ThrottleStrategy

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ThrottleStrategy>

Returns an array containing the constants of this enum type, in the order they're declared.