Xerr API/com.hiusers.xerr.api.compass/CompassStorageRegistration

CompassStorageRegistration

interface CompassStorageRegistration : AutoCloseable(source)

Plugin-scoped target API returned by XerrCompassAPI.registerStorage. Target IDs passed here are local IDs; Xerr adds the registration owner namespace internally.

Properties

owner

abstract val owner: String

Functions

clearTargets

abstract fun clearTargets(playerId: UUID, compassId: String): CompletableFuture<Void>

open override fun close()

closeAsync

abstract fun closeAsync(): CompletableFuture<Void>

flush

abstract fun flush(playerId: UUID): CompletableFuture<Void>

flushAll

abstract fun flushAll(): CompletableFuture<Void>

listTargets

abstract fun listTargets(playerId: UUID, compassId: String): CompletableFuture<List<CompassTargetInfo>>

ready

abstract fun ready(playerId: UUID): CompletableFuture<Void>

removeTarget

abstract fun removeTarget(playerId: UUID, compassId: String, targetId: String): CompletableFuture<Void>

replaceTargets

abstract fun replaceTargets(playerId: UUID, compassId: String, targets: List<CompassTarget>): CompletableFuture<Int>

setTarget

abstract fun setTarget(playerId: UUID, compassId: String, target: CompassTarget): CompletableFuture<CompassTarget>