BetterHud/api/standard-api/kr.toxicity.hud.api.compass/Compass

Compass

interface Compass : HudObject

Represents compass.

Functions

Link copied to clipboard
open fun add(@NotNull player: @NotNull HudPlayer): Boolean
Adds this object to player.
Link copied to clipboard
@ApiStatus.Internal
@NotNull
open fun getComponentsByType(@NotNull player: @NotNull HudPlayer): @NotNull HudComponentSupplier<out Any>
Gets rendered component of this object.
Link copied to clipboard
@NotNull
abstract fun getName(): @NotNull String
Gets an internal name of object.
Link copied to clipboard
@NotNull
abstract fun getType(): @NotNull HudObjectType<out Any>
Gets the type instance.
Link copied to clipboard
@ApiStatus.Internal
@NotNull
open fun identifier(): @NotNull HudObject.Identifier
Creates object identifier
Link copied to clipboard
@NotNull
abstract fun indicate(@NotNull player: @NotNull HudPlayer): @NotNull HudComponentSupplier<Compass>
Indicates some player's compass by some location
Link copied to clipboard
abstract fun isDefault(): Boolean
Returns this object is default object or not.
Link copied to clipboard
open fun remove(@NotNull player: @NotNull HudPlayer): Boolean
Removes this object to player.
Link copied to clipboard
abstract fun tick(): Long
Gets object's frame time