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

HudPlayer

interface HudPlayer : BetterCommandSource

Represents player data.

Functions

Link copied to clipboard
abstract fun audience(): @NotNull Audience
Link copied to clipboard
abstract fun cancel()
Cancel and close player's data.
Link copied to clipboard
abstract fun cancelTick()
Cancels player's task.
Link copied to clipboard
@Nullable
abstract fun getAdditionalComponent(): @Nullable WidthComponent
Gets player's additional component.
Link copied to clipboard
@Nullable
abstract fun getBarColor(): @Nullable BossBar.Color
Gets a player's current bossbar's color
Link copied to clipboard
@NotNull
open fun getCompasses(): @NotNull Set<Compass>
Gets a current player's compass.
Link copied to clipboard
@NotNull
abstract fun getHead(): @NotNull HudPlayerHead
Gets player head.
Link copied to clipboard
@NotNull
abstract fun getHudComponent(): @NotNull WidthComponent
Gets player's last bar's component.
Link copied to clipboard
@NotNull
abstract fun getHudObjects(): @NotNull Map<HudObject.Identifier, HudComponentSupplier<out Any>>
Gets a current player's hud objects.
Link copied to clipboard
@NotNull
open fun getHuds(): @NotNull Set<Hud>
Gets a current player'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 player's popup.
Link copied to clipboard
abstract fun getTick(): Long
Gets player'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 player's local variable.
Link copied to clipboard
@NotNull
abstract fun handle(): @NotNull Any
Gets original player.
Link copied to clipboard
abstract fun hasPermission(p: @NotNull String): Boolean
Link copied to clipboard
abstract fun isHudEnabled(): Boolean
Returns whether bossbar update is enabled.
Link copied to clipboard
abstract fun locale(): @NotNull Locale
Link copied to clipboard
@NotNull
abstract fun location(): @NotNull LocationWrapper
Gets player location
Link copied to clipboard
@NotNull
abstract fun name(): @NotNull String
Gets player scoreboard name
Link copied to clipboard
@NotNull
abstract fun pointers(): @NotNull Set<PointedLocation>
Gets all internal player's pointer.
Link copied to clipboard
abstract fun reload()
Reloads this player.
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 player's additional component.
Link copied to clipboard
abstract fun setBarColor(@Nullable color: @Nullable BossBar.Color)
Sets player'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 player's task.
Link copied to clipboard
abstract fun type(): @NotNull SenderType
Link copied to clipboard
abstract fun update()
Updates player's bossbar.
Link copied to clipboard
@NotNull
abstract fun uuid(): @NotNull UUID
Gets player uuid.
Link copied to clipboard
@NotNull
abstract fun world(): @NotNull WorldWrapper
Gets player world