standard-api/kr.toxicity.hud.api.player/HudPlayer

HudPlayer

interface HudPlayer : CommandSourceWrapper

Represents HudPlayer data.

Functions

Link copied to clipboard
@NotNull
abstract fun audience(): @NotNull Audience
Link copied to clipboard
abstract fun cancel()
Cancel and close HudPlayer's data.
Link copied to clipboard
abstract fun cancelTick()
Cancels HudPlayer's task.
Link copied to clipboard
@Nullable
abstract fun getAdditionalComponent(): @Nullable WidthComponent
Gets HudPlayer's additional component.
Link copied to clipboard
@Nullable
abstract fun getBarColor(): @Nullable BossBar.Color
Gets a HudPlayer's current bossbar's color
Link copied to clipboard
@NotNull
open fun getCompasses(): @NotNull Set<Compass>
Gets a current HudPlayer's compass.
Link copied to clipboard
@NotNull
abstract fun getHead(): @NotNull HudPlayerHead
Gets HudPlayer head.
Link copied to clipboard
@NotNull
abstract fun getHudComponent(): @NotNull WidthComponent
Gets HudPlayer's last bar's component.
Link copied to clipboard
@NotNull
abstract fun getHudObjects(): @NotNull Set<HudObject>
Gets a current HudPlayer's hud objects.
Link copied to clipboard
@NotNull
open fun getHuds(): @NotNull Set<Hud>
Gets a current HudPlayer's hud.
Link copied to clipboard
@NotNull
abstract fun getPointedLocation(): @NotNull Set<PointedLocation>
Gets a pointed location.
Link copied to clipboard
@NotNull
abstract fun getPopupGroupIteratorMap(): @NotNull Map<String, PopupIteratorGroup>
Gets a mutable map of popup iterator.
Link copied to clipboard
@NotNull
abstract fun getPopupKeyMap(): @NotNull Map<Any, PopupUpdater>
Gets a mutable map of popup updator.
Link copied to clipboard
@NotNull
open fun getPopups(): @NotNull Set<Popup>
Gets a current HudPlayer's popup.
Link copied to clipboard
abstract fun getTick(): Long
Gets HudPlayer's current tick It represents the count of update() calling;
Link copied to clipboard
@NotNull
abstract fun getVariableMap(): @NotNull Map<String, String>
Gets a mutable map of HudPlayer's local variable.
Link copied to clipboard
@NotNull
abstract fun handle(): @NotNull Any
Gets original hudPlayer.
Link copied to clipboard
abstract fun hasPermission(@NotNull perm: @NotNull String): Boolean
Link copied to clipboard
abstract fun isHudEnabled(): Boolean
Returns whether bossbar update is enabled.
Link copied to clipboard
abstract fun isOp(): Boolean
Link copied to clipboard
@NotNull
abstract fun location(): @NotNull LocationWrapper
Link copied to clipboard
@NotNull
abstract fun name(): @NotNull String
Link copied to clipboard
abstract fun resetElements()
Resets all hud and popup.
Link copied to clipboard
abstract fun save()
Save this data by current database.
Link copied to clipboard
abstract fun setAdditionalComponent(@Nullable component: @Nullable WidthComponent)
Sets HudPlayer's additional component.
Link copied to clipboard
abstract fun setBarColor(@Nullable color: @Nullable BossBar.Color)
Sets HudPlayer's bossbar color.
Link copied to clipboard
abstract fun setHudEnabled(toEnable: Boolean)
Sets whether to update bossbar.
Link copied to clipboard
abstract fun startTick()
Cancels and Starts HudPlayer's task.
Link copied to clipboard
@NotNull
abstract fun type(): @NotNull CommandSourceWrapper.Type
Link copied to clipboard
abstract fun update()
Updates HudPlayer's bossbar.
Link copied to clipboard
@NotNull
abstract fun uuid(): @NotNull UUID
Link copied to clipboard
@NotNull
abstract fun world(): @NotNull WorldWrapper