Interface ArenasGUIController

All Superinterfaces:
HologramController

public interface ArenasGUIController extends HologramController
Extending API if HologramControllerType.ARENASGUI_OPENER is used.

Cast HologramEntity.getController() to this class to access the methods.

  • Method Details

    • getLayoutId

      String getLayoutId()
      Get the id of the arenasgui layout that will be opened when clicked on.
      Returns:
      The layout id opened when clicked
    • setLayoutId

      void setLayoutId(String layoutId)
      Set the id of the arenasgui layout that will be opened when clicked on.
      Parameters:
      layoutId - The layout id opened when clicked
    • getName

      String getName()
      Get the name of the hologram that will be displayed above his head.
      Returns:
      The name of the hologram
    • setName

      void setName(String name)
      Set the name of the hologram that will be displayed above his head.

      Make sure to call HologramController.applyProperties() after changing the name to update the hologram.

      Parameters:
      name - The name of the hologram
    • getArenasCondition

      @Nullable @Nullable LazyReference<ArenaConditionGroup> getArenasCondition()
      Get the condition that may optionally be used to limit the arenas shown in the GUI.

      It returns a LazyReference as the condition may only be loaded when needed, to give addons time to register their custom variables.

      Returns:
      The condition used to limit the arenas shown in the GUI. May be null if there is none
    • setArenasCondition

      void setArenasCondition(@Nullable @Nullable ArenaConditionGroup condition)
      Set your own condition that may optionally be used to limit the arenas shown in the GUI.
      Parameters:
      condition - The condition used to limit the arenas shown in the GUI. May be null if there is none