Interface HudPlayer

All Superinterfaces:
kr.toxicity.command.BetterCommandSource
public interface HudPlayer extends kr.toxicity.command.BetterCommandSource
Represents player data.

  • Method Details

    • uuid

      @NotNull @NotNull UUID uuid()
      Gets player uuid.
      Returns:
      uuid

    • name

      @NotNull @NotNull String name()
      Gets player scoreboard name
      Returns:
      name

    • location

      @NotNull @NotNull LocationWrapper location()
      Gets player location
      Returns:
      location

    • world

      @NotNull @NotNull WorldWrapper world()
      Gets a player world
      Returns:
      world

    • getHead

      @NotNull @NotNull HudPlayerHead getHead()
      Gets player head.
      Returns:
      player head

    • handle

      @NotNull @NotNull Object handle()
      Gets original player.
      Returns:
      handle.

    • getHudComponent

      @NotNull @NotNull WidthComponent getHudComponent()
      Gets player's last bar's component.
      Returns:
      component

    • setAdditionalComponent

      void setAdditionalComponent(@Nullable @Nullable WidthComponent component)
      Sets player's additional component.
      Parameters:
      component - component

    • getAdditionalComponent

      @Nullable @Nullable WidthComponent getAdditionalComponent()
      Gets player's additional component.
      Returns:
      component

    • isHudEnabled

      boolean isHudEnabled()
      Returns whether bossbar update is enabled.
      Returns:
      whether to enable.

    • setHudEnabled

      void setHudEnabled(boolean toEnable)
      Sets whether to update bossbar.
      Parameters:
      toEnable - whether to update

    • getTick

      long getTick()
      Gets player's current tick It represents the count of update() calling;
      Returns:
      tick

    • cancel

      void cancel()
      Cancel and close player's data.

    • update

      void update()
      Updates player's bossbar.

    • startTick

      void startTick()
      Cancels and Starts player's task.

    • cancelTick

      void cancelTick()
      Cancels player's task.

    • getPopupGroupIteratorMap

      @NotNull @NotNull Map<String, PopupIteratorGroup> getPopupGroupIteratorMap()
      Gets a mutable map of popup iterator.
      Returns:
      popup group's map
      See Also:

    • getVariableMap

      @NotNull @NotNull Map<String,String> getVariableMap()
      Gets a mutable map of the player's local variable.
      Returns:
      player's variable map

    • getPopupKeyMap

      @NotNull @NotNull Map<Object, PopupUpdater> getPopupKeyMap()
      Gets a mutable map of popup updator.
      Returns:
      popup updator map.

    • getBarColor

      @Nullable net.kyori.adventure.bossbar.BossBar.Color getBarColor()
      Gets a player's current bossbar's color
      Returns:
      bar color

    • getHudObjects

      @NotNull @NotNull Map<HudObject.Identifier, HudComponentSupplier<?>> getHudObjects()
      Gets a current player's hud objects.
      Returns:
      hud objects

    • getPopups

      @NotNull default @NotNull Set<Popup> getPopups()
      Gets a current player's popup.
      Returns:
      popups

    • getHuds

      @NotNull default @NotNull Set<Hud> getHuds()
      Gets a current player's hud.
      Returns:
      hud

    • getCompasses

      @NotNull default @NotNull Set<Compass> getCompasses()
      Gets a current player's compass.
      Returns:
      compass

    • getPointedLocation

      @NotNull @NotNull Set<PointedLocation> getPointedLocation()
      Gets a pointed location.
      Returns:
      location set

    • reload

      void reload()
      Reloads this player.

    • save

      void save()
      Save this data by current database.

    • setBarColor

      void setBarColor(@Nullable net.kyori.adventure.bossbar.BossBar.Color color)
      Sets player's bossbar color.
      Parameters:
      color - bar color

    • pointers

      @NotNull @NotNull Set<PointedLocation> pointers()
      Gets all internal player's pointer.
      Returns:
      mutable pointer set