XerrCompassAPI

Stable compass API exposed by com.hiusers.xerr.api.XerrAPI.

Functions

Link copied to clipboard
abstract fun clearTargets(viewerId: UUID, compassId: String): CompletableFuture<Int>
Link copied to clipboard
open fun followEntity(viewer: Player, compassId: String, targetId: String, entity: Entity): CompletableFuture<CompassTarget>
abstract fun followEntity(viewer: Player, compassId: String, targetId: String, entity: Entity, marker: String, label: String, priority: Int): CompletableFuture<CompassTarget>
Link copied to clipboard
abstract fun hasView(viewerId: UUID, compassId: String): Boolean
Link copied to clipboard
abstract fun ids(): Set<String>
Link copied to clipboard
abstract fun listTargets(viewerId: UUID, compassId: String): CompletableFuture<List<CompassTargetInfo>>
Link copied to clipboard
abstract fun position(location: Location): CompassPosition
Link copied to clipboard
abstract fun registerProvider(owner: Plugin, refresh: Int, provider: CompassTargetProvider): CompletableFuture<AutoCloseable>
Link copied to clipboard

Registers one persistent namespace for this plugin; duplicate plugin registrations fail.

Link copied to clipboard
abstract fun removeTarget(viewerId: UUID, compassId: String, targetId: String): CompletableFuture<Boolean>
Link copied to clipboard
abstract fun replaceTargets(owner: Plugin, viewerId: UUID, compassId: String, targets: List<CompassTarget>): CompletableFuture<Int>
Link copied to clipboard
open fun setScriptTarget(viewerId: UUID, compassId: String, targetId: String, script: String): CompletableFuture<CompassTarget>
abstract fun setScriptTarget(viewerId: UUID, compassId: String, targetId: String, script: String, refresh: Int, marker: String, label: String, variables: Map<String, String>, priority: Int): CompletableFuture<CompassTarget>
Link copied to clipboard
abstract fun setTarget(viewerId: UUID, compassId: String, target: CompassTarget): CompletableFuture<CompassTarget>
open fun setTarget(viewer: Player, compassId: String, targetId: String, location: Location): CompletableFuture<CompassTarget>
abstract fun setTarget(viewer: Player, compassId: String, targetId: String, location: Location, marker: String, label: String, priority: Int): CompletableFuture<CompassTarget>
Link copied to clipboard
abstract fun setVisible(viewerId: UUID, compassId: String, visible: Boolean): CompletableFuture<Boolean>
Link copied to clipboard
abstract fun targetIds(viewerId: UUID, compassId: String): List<String>