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

ConfigScreenWidget

class ConfigScreenWidget : CustomPressableWidget

A widget that will open a fzzy config screen directly on press.

Author

fzzyhmstrs

Since

0.5.7, reimplemented with CustomPressableWidget 0.6.3

Types

object Companion

class Position(corner: ConfigScreenWidget.Position.Corner, xOffset: Int, yOffset: Int)

Properties

var active: Boolean

var focused: Boolean

navigationOrder

var navigationOrder: Int

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

open fun drawMessage(context: DrawContext, textRenderer: TextRenderer, x: Int, y: Int, width: Int, height: Int, color: Int)

Draws the widgets message with standard edge padding and positioning.

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

open fun getAlpha(): Float

open fun getBorder(direction: NavigationDirection): ScreenRect

open fun getBottom(): Int

open fun getFocusedPath(): @Nullable GuiNavigationPath

open override fun getHeight(): Int

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

open fun getRight(): Int

open override fun getType(): Selectable.SelectionType

open override fun getWidth(): Int

open fun isClickable(): Boolean

open fun isHovered(): Boolean

open override fun isInteractable(): Boolean

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

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

open fun isSelected(): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

open override fun onPress()

Action invoked whenever the button is clicked on or activated with Enter.

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 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.

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

renderBackground

open fun renderBackground(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom background rendering for the widget. By default, will render the standard MC button texture set.

open override fun renderCustom(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom foreground rendering for the widget. By default, will render the label.

open fun setAlpha(alpha: Float)

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

open fun setHeight(height: Int)

open fun setMessage(message: Text)

open fun setPosition(x: Int, y: Int)

open fun setTooltip(tooltip: @Nullable Tooltip)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

open fun setWidth(width: Int)