PaperMC Despawned Items/io.fairyfox.papermc.despawneditems.location/LocationManager

LocationManager

class LocationManager(plugin: PaperMcDespawnedItems)

Owns the in-memory LocationStore and the persistent LocationRepository, and is the single entry point the rest of the plugin uses to read and mutate despawn locations.

Persistence is incremental and debounced: a mutation marks its owner dirty and schedules a flush a few seconds later; the flush snapshots the dirty owners on the main thread and writes them off-thread. A synchronous shutdown/saveNow path exists for plugin disable and /despi save, when async tasks can't run.

Constructors

LocationManager

constructor(plugin: PaperMcDespawnedItems)

Types

object Companion

Properties

val enabledCount: Int

Number of targets currently switched on.

var store: LocationStore

Functions

fun add(location: Location, owner: UUID): Boolean

fun all(): List<DespawnLocation>

fun anyAt(location: Location): Boolean

fun anyTargetAt(location: Location): DespawnLocation?

Any stored target at location, whoever owns it — what a click on the block resolves to.

fun atLocation(location: Location): List<DespawnLocation>

fun clearAll(): Int

fun countOfOwner(owner: UUID): Int

fun firstOfOwner(owner: UUID): DespawnLocation?

fun has(location: Location, owner: UUID): Boolean

fun isEmpty(): Boolean

fun load()

Builds the configured backend and loads all locations into memory.

fun ofOwner(owner: UUID): Set<DespawnLocation>

fun ownersAt(location: Location): Set<UUID>

fun random(): DespawnLocation?

fun randomEnabled(): DespawnLocation?

A random target that is switched on, weighted by its priority.

fun reload()

Flushes, closes the current backend, and reloads (used by /despi reload).

fun remove(location: Location, owner: UUID): Boolean

fun removeAllAt(location: Location): Int

removeAllOfOwner

fun removeAllOfOwner(owner: UUID): Int

fun removeOneAt(location: Location): Boolean

Removes one (arbitrary) owner's entry at location.

removeOneOfOwner

fun removeOneOfOwner(owner: UUID): Boolean

Removes one (arbitrary) location owned by owner.

fun replaceWith(locations: Collection<DespawnLocation>)

Replaces the whole store (used by solo-mode testing); marks everything dirty.

Forces a synchronous flush of everything dirty (used by /despi save).

Synchronously flushes and closes the backend (used on plugin disable).

fun targetAt(location: Location, owner: UUID): DespawnLocation?

The stored target at location owned by owner, or null.

fun updateOptions(location: Location, owner: UUID, transform: (TargetOptions) -> TargetOptions): DespawnLocation?

Applies transform to the options of the target at location owned by owner. Returns the updated target, or null when there is nothing there.