BetterHud/api/standard-api/kr.toxicity.hud.api.popup/Popup

Popup

interface Popup : HudObject

Represents popup.

Types

Link copied to clipboard
enum FrameType
Frame type

Functions

Link copied to clipboard
open fun add(@NotNull player: @NotNull HudPlayer): Boolean
Adds this object to player.
Link copied to clipboard
@NotNull
abstract fun frameType(): @NotNull Popup.FrameType
Gets a frame type.
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 getGroupName(): @NotNull String
Gets a group name of popup.
Link copied to clipboard
open fun getLastIndex(): Int
Gets a last index of the popup.
Link copied to clipboard
abstract fun getMaxStack(): Int
Gets a popup's max stack size
Link copied to clipboard
@NotNull
abstract fun getName(): @NotNull String
Gets an internal name of an object.
Link copied to clipboard
@NotNull
abstract fun getType(): @NotNull HudObjectType<out Any>
Gets the type instance.
Link copied to clipboard
open fun hide(@NotNull player: @NotNull HudPlayer): Boolean
Hides popup to some player.
Link copied to clipboard
@ApiStatus.Internal
@NotNull
open fun identifier(): @NotNull HudObject.Identifier
Creates object identifier
Link copied to clipboard
abstract fun isDefault(): Boolean
Returns this object is a 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
@Nullable
abstract fun show(@NotNull reason: @NotNull UpdateEvent, @NotNull player: @NotNull HudPlayer): @Nullable PopupUpdater
Shows popup to some player.
Link copied to clipboard
abstract fun tick(): Long
Gets object's frame time