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

SuppliedTextWidget

class SuppliedTextWidget(messageSupplier: Supplier<Text>, textRenderer: TextRenderer, width: Int, height: Int) : CustomTextWidget, TooltipChild

A CustomTextWidget that renders text from a supplier of text, not a static text instance

Author

fzzyhmstrs

Since

0.3.1, removed align:direction: methods and now implements TooltipChild in 0.6.0, uses java.util.Supplier instead of googles in 0.6.8 and deprecates constructors with google Supplier. Google supplier constructors removed 0.7.0.

Parameters

messageSupplier

Supplier<Text> - supplies text to this widget

textRenderer

TextRenderer - textRenderer instance

width

Int - width of the widget in pixels

height

Int - height of the widget in pixels

Constructors

SuppliedTextWidget

constructor(messageSupplier: Supplier<Text>, textRenderer: TextRenderer)

constructor(messageSupplier: Supplier<Text>, textRenderer: TextRenderer, width: Int, height: Int)

Properties

active

var active: Boolean

focused

var focused: Boolean

navigationOrder

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

align

fun align(horizontalAlignment: Float): SuppliedTextWidget

Aligns the widget text to the alignment fraction provided

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

draw

open override fun draw(textConsumer: DrawnTextConsumer)

forEachChild

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

getAlpha

open fun getAlpha(): Float

getBorder

open fun getBorder(direction: NavigationDirection): ScreenRect

getBottom

open fun getBottom(): Int

getFocusedPath

open fun getFocusedPath(): @Nullable GuiNavigationPath

getHeight

open override fun getHeight(): Int

getMessage

open fun getMessage(): Text

getNarratedParts

open fun getNarratedParts(): MutableCollection<out Selectable>

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation): @Nullable GuiNavigationPath

getRight

open fun getRight(): Int

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isClickable

open fun isClickable(): Boolean

isHovered

open fun isHovered(): Boolean

isInteractable

open override fun isInteractable(): Boolean

isMouse

open fun isMouse(event: CustomWidget.MouseEvent): Boolean

isMouseOver

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

isSelected

open fun isSelected(): Boolean

mouseMoved

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

onChar

open fun onChar(event: CustomWidget.CharEvent): Boolean

Handles char input events for custom widgets. Override this for handling keyboard inputs.

onClick

open fun onClick(clickedStyleConsumer: @Nullable Consumer<Style>): AbstractTextWidget

onKey

open override fun onKey(event: CustomWidget.KeyEvent): Boolean

Handles keyboard events for custom widgets. Override this for handling keyboard inputs.

onKeyRelease

open fun onKeyRelease(event: CustomWidget.KeyEvent): Boolean

Handles keyboard release events for custom widgets. Override this for handling keyboard inputs.

onMouse

open override fun onMouse(event: CustomWidget.MouseEvent): Boolean

Handles mouse click events for custom widgets. Override this or onPress for handling mouse inputs.

onMouseDrag

open fun onMouseDrag(event: CustomWidget.MouseEvent): Boolean

Handles mouse drag events for custom widgets. Override this for handling drag inputs

onMouseRelease

open fun onMouseRelease(event: CustomWidget.MouseEvent): Boolean

Handles mouse button release events for custom widgets. Override this for handling mouse inputs.

onMouseScroll

open fun onMouseScroll(event: CustomWidget.MouseEvent): Boolean

Handles mouse scroll events for custom widgets. Override this for handling mouse inputs.

onPress

open override fun onPress(event: CustomWidget.MouseEvent): Boolean

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open override fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render