Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/DynamicListWidget

DynamicListWidget

class DynamicListWidget(client: MinecraftClient, entryBuilders: List<BiFunction<DynamicListWidget, Int, out DynamicListWidget.Entry>>, x: Int, y: Int, width: Int, height: Int, spec: DynamicListWidget.ListSpec = ListSpec()) : CustomListWidget<DynamicListWidget.Entry> , Neighbor, LastSelectable, SuggestionWindowListener, ContextHandler, ContextProvider

Constructors

DynamicListWidget

constructor(client: MinecraftClient, entryBuilders: List<BiFunction<DynamicListWidget, Int, out DynamicListWidget.Entry>>, x: Int, y: Int, width: Int, height: Int, spec: DynamicListWidget.ListSpec = ListSpec())

Types

Companion

object Companion

Entries

inner class Entries(delegate: List<DynamicListWidget.Entry>) : Iterable<DynamicListWidget.Entry>

Entry

abstract class Entry(parentElement: DynamicListWidget, val texts: Translatable.Result, val scope: DynamicListWidget.Scope, visibility: DynamicListWidget.Visibility = Visibility.VISIBLE) : CustomListWidget.Entry<DynamicListWidget> , ParentElement, Searcher.SearchContent, ContextHandler, ContextProvider, LastSelectable

ListSpec

data class ListSpec(val leftPadding: Int = 16, val rightPadding: Int = 10, val verticalPadding: Int = 4, val hideScrollBar: Boolean = false, val listNarrationKey: String = "fc.narrator.position.config")

Scope

data class Scope(val scope: String, val group: String = "", val inGroups: List<String> = EMPTY)

Visibility

enum Visibility : Enum<DynamicListWidget.Visibility>

VisibilityStack

data class VisibilityStack(baseVisibility: DynamicListWidget.Visibility, visibilityStack: LinkedList<DynamicListWidget.Visibility>)

Properties

active

var active: Boolean

lastSelected

open override var lastSelected: Element?

getter and setter for the cached element.

message

var message: Text

navigationOrder

var navigationOrder: Int

neighbor

open override val neighbor: EnumMap<NavigationDirection, Neighbor>

verticalPadding

val verticalPadding: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

bottomDelta

open override fun bottomDelta(): Int

The length in pixels that the bottom of the list is out of frame below the bottom of the widget.

charTyped

open fun charTyped(chr: Char, modifiers: Int): Boolean

contentHeight

open override fun contentHeight(): Int

The height of the entries in the list. If the list contains twenty 20px entries, content height is 400

ensureVisible

open override fun ensureVisible(entry: DynamicListWidget.Entry)

Ensures that the provided entry is in frame. Implementations should scroll as needed to fully incorporate the entry into the widget frame.

entryAtY

open override fun entryAtY(mouseY: Int): DynamicListWidget.Entry?

The entry underneath the mouse, if any.

fitToContent

fun fitToContent(max: Int)

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getFocused

open override fun getFocused(): Element?

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation?): GuiNavigationPath?

Return a navigation path leading through this list and to an entry, as applicable. The default implementation will likely not function properly; see DynamicListWidget for an example implementation

getNeighbor

open fun getNeighbor(direction: NavigationDirection): Neighbor?

getRight

open fun getRight(): Int

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

groupIsVisible

fun groupIsVisible(g: String): Boolean

handleContext

open override fun handleContext(contextType: ContextType, position: Position): Boolean

Handle a context event. This will be triggered by a parent, typically on key press or mouse click. A parent object can of course also be a context handler, handle context as applicable and then pass the event downstream for further handling.

handleScroll

open override fun handleScroll(verticalAmount: Double): Boolean

Handles a scroll input. This is scroll from a mouse, so the input should be multiplied by a factor to make scroll distance reasonable.

handleScrollByBar

open override fun handleScrollByBar(scrollAmount: Int): Boolean

Handles "direct" scroll input. This amount is not scaled, so the amount input should be the amount scrolled.

hideScrollWhileNotHovered

open override fun hideScrollWhileNotHovered(): Boolean

Whether the scroll bar should not render if the widget isn't hovered. Default false.

hoveredElement

open fun hoveredElement(mouseX: Double, mouseY: Double): Optional<Element>

inFrameEntries

open override fun inFrameEntries(): List<DynamicListWidget.Entry>

Entries that are currently visible in the list frame. These entries will be rendered as applicable. Entries partially in frame should be included.

isFocused

open override fun isFocused(): Boolean

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

keyPressed

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

listNarrationKey

open override fun listNarrationKey(): String

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open override fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onClick

open fun onClick(mouseX: Double, mouseY: Double)

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

onReposition

open override fun onReposition()

This is run when the widget is moved or resized. List elements should be repositioned when this is called.

page

fun page(up: Boolean)

"Pages" the list up or down as if Page Up/Down has been pressed.

playDownSound

open fun playDownSound(soundManager: SoundManager)

popLast

open override fun popLast()

Indicates that the overlay has been removed and the parent should return focus to the cached element, if any, in lastSelected

provideContext

open override fun provideContext(builder: ContextResultBuilder)

Add a set of grouped context action builders to a result

pushLast

open override fun pushLast()

Indicates to the parent element to cache it's current focused element. The current focused element should be stored in lastSelected

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

resetHover

open override fun resetHover(mouseX: Double, mouseY: Double)

When called the parent element should reselect a hovered element based on the supplied mouse positions, if it tracks such things

rowWidth

fun rowWidth(): Int

The content width of the row, excluding padding and space for the scroll bar

rowX

fun rowX(): Int

The X position of the row content, after padding

scrollToBottom

open override fun scrollToBottom(): Boolean

Scroll to the bottom of the list content. bottomDelta should be 0 or negative after this scroll

scrollToGroup

fun scrollToGroup(g: String)

scrollToTop

open override fun scrollToTop(): Boolean

Scroll to the top of the list content. topDelta should be 0 after this scroll.

fun search(searchInput: String): Int

selectableEntries

open override fun selectableEntries(): List<DynamicListWidget.Entry>

List entries tht are currently selectable. Hidden or otherwise disabled entries should not be counted in this list.

setAlpha

open fun setAlpha(alpha: Float)

setFocused

open override fun setFocused(focused: Boolean)

open override fun setFocused(focused: Element?)

setHeight

open fun setHeight(height: Int)

setNeighbor

open fun setNeighbor(direction: NavigationDirection, neighbor: Neighbor?)

setSuggestionWindowElement

open override fun setSuggestionWindowElement(element: Element?)

setTooltip

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setWidth

open fun setWidth(width: Int)

toggleGroup

fun toggleGroup(g: String)

topDelta

open override fun topDelta(): Int

The length in pixels that the top of the list is out of frame above the top of the widget.