PaperMC Despawned Items/io.fairyfox.papermc.despawneditems.throttle/ThrottleDecision

ThrottleDecision

enum ThrottleDecision : Enum<ThrottleDecision>

What the throttler decided to do with one despawning item.

The three outcomes are deliberately exhaustive and side-effect free — a policy only ever classifies; the io.fairyfox.papermc.despawneditems.despawn.DespawnScheduler is what acts on the classification. That split is what makes every policy unit-testable without a server.

Entries

ALLOW

Relocate now: the actor is within every quota that applies to them.

DEFER

Over quota, but keep the item queued and retry on a later tick. The item is held until the actor's budget refills, so nothing is lost — it just lands later.

DROP

Over quota and over patience: give up on relocating this item. What "give up" means is the admin's choice (ThrottleSettings.onLimit) — vanilla despawn, or a hand-off to the catch-all/void path.

Properties

allowed

val allowed: Boolean

True when the item may start a relocation right now.

entries

val entries: EnumEntries<ThrottleDecision>

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): ThrottleDecision

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<ThrottleDecision>

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