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

PopupIterator

interface PopupIterator : Comparable<PopupIterator>

Represents popup iterator.

Functions

alwaysCheckCondition

abstract fun alwaysCheckCondition(): Boolean

Returns whether this popup always checks condition.

available

abstract fun available(): Boolean

Checks this popup is available.

canSave

abstract fun canSave(): Boolean

Returns this popup can save.

compareTo

abstract fun compareTo(p: T): Int

getIndex

abstract fun getIndex(): Int

Gets the index of iterator.

getKey

@NotNull

abstract fun getKey(): @NotNull Any

Returns key.

getMaxIndex

abstract fun getMaxIndex(): Int

Gets the max index of iterator.

getPriority

abstract fun getPriority(): Int

Gets priority

getSortType

@NotNull

abstract fun getSortType(): @NotNull PopupSortType

Returns sort type.

getUUID

@NotNull

abstract fun getUUID(): @NotNull UUID

Returns uuid.

isUnique

abstract fun isUnique(): Boolean

Returns whether this iterator is unique

markedAsRemoval

abstract fun markedAsRemoval(): Boolean

Returns whether this popup is marked as removal.

name

@NotNull

abstract fun name(): @NotNull String

Gets name.

@NotNull

@Unmodifiable

abstract fun next(): @NotNull @Unmodifiable List<WidthComponent>

Iterates this and returns next value.

parent

@NotNull

abstract fun parent(): @NotNull Popup

Returns parent popup.

push

abstract fun push(): Boolean

When added, this iterator will reduce all iterator's index when true.

remove

abstract fun remove()

Removes this iterator

setIndex

abstract fun setIndex(index: Int)

Sets the index of iterator.

setPriority

abstract fun setPriority(priority: Int)

Sets priority