Package kr.toxicity.hud.api.popup

Interface Popup

All Superinterfaces:

HudObject

public interface Popup
extends HudObject

Represents popup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Popup.FrameType	Frame type

Nested classes/interfaces inherited from interface kr.toxicity.hud.api.configuration.HudObject

HudObject.Identifier

Method Summary

Modifier and Type	Method	Description
@NotNull Popup.FrameType	frameType()	Gets a frame type.
@NotNull String	getGroupName()	Gets a group name of popup.
default int	getLastIndex()	Gets a last index of the popup.
int	getMaxStack()	Gets a popup's max stack size
default boolean	hide(@NotNull HudPlayer player)	Hides popup to some player.
@Nullable PopupUpdater	show(@NotNull UpdateEvent reason, @NotNull HudPlayer player)	Shows popup to some player.

Methods inherited from interface kr.toxicity.hud.api.configuration.HudObject

add, getComponentsByType, getName, getType, identifier, isDefault, remove, tick

Method Details

getGroupName

@NotNull
@NotNull String getGroupName()

Gets a group name of popup.

Returns:

group name.

getMaxStack

int getMaxStack()

Gets a popup's max stack size

Returns:

max stack size

show

@Nullable
@Nullable PopupUpdater show(@NotNull
 @NotNull UpdateEvent reason,
 @NotNull
 @NotNull HudPlayer player)

Shows popup to some player.

Parameters:

reason - causes

player - target player

Returns:

updater of popup or null if showing has failed.

hide

default boolean hide(@NotNull
 @NotNull HudPlayer player)

Hides popup to some player.

Parameters:

player - target player

Returns:

whether to success

getLastIndex

default int getLastIndex()

Gets a last index of the popup. It equals getMaxStack() - 1

Returns:

last index

frameType

@NotNull
@NotNull Popup.FrameType frameType()

Gets a frame type.

Returns:

frame type