Index (api 1.0.0 API)

A B C D E F G H I K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

accept(EntryVisitor) - Method in class dev.xichil.mvui.Button
accept(EntryVisitor) - Method in class dev.xichil.mvui.Checkbox
accept(EntryVisitor) - Method in class dev.xichil.mvui.ColorPicker
accept(EntryVisitor) - Method in class dev.xichil.mvui.Cycle
accept(EntryVisitor) - Method in class dev.xichil.mvui.Dropdown
accept(EntryVisitor) - Method in class dev.xichil.mvui.Entry: Calls the EntryVisitor method for this entry's type (visitButton for a Button, …) and returns its result.
accept(EntryVisitor) - Method in class dev.xichil.mvui.Keybind
accept(EntryVisitor) - Method in class dev.xichil.mvui.Label
accept(EntryVisitor) - Method in class dev.xichil.mvui.MultiLineInput
accept(EntryVisitor) - Method in class dev.xichil.mvui.NumberField: As its NumberField.input(): EntryVisitor.visitTextInput(TextInput).
accept(EntryVisitor) - Method in class dev.xichil.mvui.Section: As its header: a Button if collapsible, a Label if not.
accept(EntryVisitor) - Method in class dev.xichil.mvui.SelectList
accept(EntryVisitor) - Method in class dev.xichil.mvui.Slider
accept(EntryVisitor) - Method in class dev.xichil.mvui.StatusLine
accept(EntryVisitor) - Method in class dev.xichil.mvui.TextInput
accept(EntryVisitor) - Method in class dev.xichil.mvui.Toggle
add(Entry) - Method in class dev.xichil.mvui.MenuScreen.Builder: Appends an entry to the list.
add(Entry) - Method in class dev.xichil.mvui.Section.Builder: Appends a child entry.
add(StringListEditor) - Method in class dev.xichil.mvui.MenuScreen.Builder: Appends a StringListEditor's entries (its list, input, Add and Remove buttons), in that order.
add(StringListEditor) - Method in class dev.xichil.mvui.Section.Builder: Appends a StringListEditor's entries as children.
ADD - Static variable in class dev.xichil.mvui.UiTexts: "Add": a StringListEditor's default Add label.
addLabel(Text) - Method in class dev.xichil.mvui.StringListEditor.Builder: The Add button's label; UiTexts.ADD by default.
all() - Method in class dev.xichil.mvui.BackendRegistry: Every backend, sorted by id.
all() - Method in class dev.xichil.mvui.MenuScreen: MenuScreen.entries() followed by MenuScreen.footer().
allowMouse(boolean) - Method in class dev.xichil.mvui.Keybind.Builder: Whether mouse buttons can be bound; true by default, as in vanilla.
allowsMouse() - Method in class dev.xichil.mvui.Keybind: Whether a mouse button can be bound; if not, a click while waiting for a key is ignored.
alpha(boolean) - Method in class dev.xichil.mvui.ColorPicker.Builder: Whether the color has an alpha (opacity) byte the player can edit; false by default.
ALREADY_IN_LIST - Static variable in class dev.xichil.mvui.UiTexts: "Already in the list": a StringListEditor's error for a duplicate item.
applied() - Static method in class dev.xichil.mvui.ReloadResult: Everything was applied live; ReloadResult.needsRestart() is false.
applyRestoredOptions() - Method in interface dev.xichil.mvui.UiBackend: For platforms where a mod changes options.txt after the game read it (Forge without Mixin, TODO.md §3.1): makes the running game re-read and apply it, as a menu's GameBridge.reloadOptions() does.
args() - Method in class dev.xichil.mvui.Text: The arguments of translatable text.
AT_LEAST - Static variable in class dev.xichil.mvui.UiTexts: "Must be at least %s": a NumberField's error below its minimum; the argument is the minimum.
AT_MOST - Static variable in class dev.xichil.mvui.UiTexts: "Must be at most %s": a NumberField's error above its maximum; the argument is the maximum.

B

back() - Method in interface dev.xichil.mvui.UiHost: Closes the current screen and returns to the one below it, or, from the menu's first screen, to the screen the menu was opened from.
BackendDescriptor - Class in dev.xichil.mvui: What one backend serves (TODO.md 0.6, 5.3): per platform, the DataVersion range it was checked against, plus the runtime names it is remapped to.
BackendDescriptor(String, String, Map) - Constructor for class dev.xichil.mvui.BackendDescriptor: A descriptor; usually made by BackendDescriptor.parse(Properties).
BackendRegistry - Class in dev.xichil.mvui: The backends a jar bundles, and which one serves a running game (TODO.md 5.3).
BackendRegistry(List) - Constructor for class dev.xichil.mvui.BackendRegistry: A registry of backends; usually made by BackendRegistry.load(ClassLoader).
Behavior - Section in class dev.xichil.mvui.StringListEditor
build() - Method in class dev.xichil.mvui.Button.Builder: Builds the button.
build() - Method in class dev.xichil.mvui.Checkbox.Builder: Builds the check box.
build() - Method in class dev.xichil.mvui.ColorPicker.Builder: Builds the color picker.
build() - Method in class dev.xichil.mvui.ConfirmDialog.Builder: Builds the dialog.
build() - Method in class dev.xichil.mvui.Cycle.Builder: Builds the cycle.
build() - Method in class dev.xichil.mvui.Dropdown.Builder: Builds the dropdown.
build() - Method in class dev.xichil.mvui.Keybind.Builder: Builds the key binding button.
build() - Method in class dev.xichil.mvui.Label.Builder: Builds the label.
build() - Method in class dev.xichil.mvui.MenuScreen.Builder: Builds the screen.
build() - Method in class dev.xichil.mvui.MultiLineInput.Builder: Builds the text box.
build() - Method in class dev.xichil.mvui.NumberField.Builder: Builds the field.
build() - Method in class dev.xichil.mvui.Section.Builder: Builds the section and attaches its children to it.
build() - Method in class dev.xichil.mvui.SelectList.Builder: Builds the list.
build() - Method in class dev.xichil.mvui.Slider.Builder: Builds the slider.
build() - Method in class dev.xichil.mvui.StatusLine.Builder: Builds the status line, empty.
build() - Method in class dev.xichil.mvui.StringListEditor.Builder: Builds the editor's entries.
build() - Method in class dev.xichil.mvui.TextInput.Builder: Builds the field.
build() - Method in class dev.xichil.mvui.Toggle.Builder: Builds the toggle.
builder(String) - Static method in class dev.xichil.mvui.Button: Starts building a button.
builder(String) - Static method in class dev.xichil.mvui.Checkbox: Starts building a check box.
builder(String) - Static method in class dev.xichil.mvui.ColorPicker: Starts building a color picker.
builder(String) - Static method in class dev.xichil.mvui.ConfirmDialog: Starts building a dialog.
builder(String) - Static method in class dev.xichil.mvui.Cycle: Starts building a cycle.
builder(String) - Static method in class dev.xichil.mvui.Dropdown: Starts building a dropdown.
builder(String) - Static method in class dev.xichil.mvui.Keybind: Starts building a key binding button.
builder(String) - Static method in class dev.xichil.mvui.Label: Starts building a label.
builder(String) - Static method in class dev.xichil.mvui.MenuScreen: Starts building a menu screen.
builder(String) - Static method in class dev.xichil.mvui.MultiLineInput: Starts building a text box.
builder(String) - Static method in class dev.xichil.mvui.Section: Starts building a section.
builder(String) - Static method in class dev.xichil.mvui.SelectList: Starts building a list.
builder(String) - Static method in class dev.xichil.mvui.Slider: Starts building a slider.
builder(String) - Static method in class dev.xichil.mvui.StatusLine: Starts building a status line.
builder(String) - Static method in class dev.xichil.mvui.StringListEditor: Starts building a list editor.
builder(String) - Static method in class dev.xichil.mvui.TextInput: Starts building a text field.
builder(String) - Static method in class dev.xichil.mvui.Toggle: Starts building a toggle.
Button - Class in dev.xichil.mvui: A push button, drawn as the version's vanilla button.
Button.Builder - Class in dev.xichil.mvui: Builds a Button; from Button.builder(String).
buttonLabel() - Method in interface dev.xichil.mvui.ScreenFactory: Label of the button that opens the menu: the Options screen's button when this is the only registered menu (with several, that button reads UiTexts.MOD_MENUS and the "Mod menus" list uses the name given to MultiversionUi.register(String, Text, ScreenFactory) instead).

C

call(String, Supplier, T) - Static method in class dev.xichil.mvui.Failsafe: Calls action, guarded: if it throws, Failsafe.fail(String, Throwable) handles it and this returns fallback.
cancel() - Method in class dev.xichil.mvui.ConfirmDialog: Runs the no action (none by default).
CANCEL - Static variable in class dev.xichil.mvui.UiTexts: "Cancel" (gui.cancel).
capture(Key) - Method in class dev.xichil.mvui.Keybind: What the player pressed while the button waited for a key: Escape unbinds, a mouse button binds only if Keybind.allowsMouse(), anything else binds.
check(String) - Static method in class dev.xichil.mvui.ForcedFailure: Throws if the switch is on; backends call it at the start of each hook, inside Failsafe's guard.
Checkbox - Class in dev.xichil.mvui: A check box with its label to the right, like vanilla's Checkbox (1.16+; older versions get an equivalent drawing).
Checkbox.Builder - Class in dev.xichil.mvui: Builds a Checkbox; from Checkbox.builder(String).
checked() - Method in class dev.xichil.mvui.Checkbox: Whether the box is checked: the mod's current value, from its value supplier.
children() - Method in class dev.xichil.mvui.Section: The children in screen order.
clear() - Method in class dev.xichil.mvui.StatusLine: Empties the line (and resets StatusLine.kind() to StatusLine.Kind.INFO).
click(int, int) - Method in class dev.xichil.mvui.TextAreaModel: Puts the cursor where the player clicked: on line (clamped), x pixels from its start.
close() - Method in interface dev.xichil.mvui.UiHost: Closes every screen opened through this host, returning to the screen the menu was opened from.
code() - Method in class dev.xichil.mvui.Key: The GLFW key code for a keyboard key (-1 for Key.UNBOUND), the button number for a mouse button.
collapsible() - Method in class dev.xichil.mvui.Section: Whether the player can expand and collapse it; true unless the builder set collapsible(false).
collapsible(boolean) - Method in class dev.xichil.mvui.Section.Builder: Whether the player can expand and collapse the section; true by default.
color() - Method in class dev.xichil.mvui.ColorPicker: The mod's color: 0xRRGGBB (top byte cleared), or 0xAARRGGBB with alpha.
COLOR_ALPHA - Static variable in class dev.xichil.mvui.UiTexts: "Alpha": a ColorPicker editor's slider, with alpha only.
COLOR_BLUE - Static variable in class dev.xichil.mvui.UiTexts: "Blue": a ColorPicker editor's slider.
COLOR_GREEN - Static variable in class dev.xichil.mvui.UiTexts: "Green": a ColorPicker editor's slider.
COLOR_HEX - Static variable in class dev.xichil.mvui.UiTexts: "Hex": the label of a ColorPicker editor's hex field.
COLOR_RED - Static variable in class dev.xichil.mvui.UiTexts: "Red": a ColorPicker editor's slider.
ColorPicker - Class in dev.xichil.mvui: A color setting: a button "label: #RRGGBB" with a swatch of the color on it.
ColorPicker.Builder - Class in dev.xichil.mvui: Builds a ColorPicker; from ColorPicker.builder(String).
Colors - Section in class dev.xichil.mvui.ColorPicker
confirm() - Method in class dev.xichil.mvui.ConfirmDialog: Runs the yes action.
ConfirmDialog - Class in dev.xichil.mvui: A yes/no question on its own screen, drawn as the version's vanilla confirm screen (like "Delete world?").
ConfirmDialog.Builder - Class in dev.xichil.mvui: Builds a ConfirmDialog; from ConfirmDialog.builder(String).
Core concepts - Section in package dev.xichil.mvui
CPW_FORGE_GUI_FACTORY - Static variable in class dev.xichil.mvui.MultiversionUi: Class name for @Mod(guiFactory = MultiversionUi.CPW_FORGE_GUI_FACTORY) on Forge 1.7.10 (whose FML lives in the cpw.mods.fml packages).
create(UiHost) - Method in interface dev.xichil.mvui.ScreenFactory: Builds the menu's first screen, usually a MenuScreen.
cursor() - Method in class dev.xichil.mvui.TextAreaModel: The cursor's offset in TextAreaModel.text(), from 0 to its length.
cursorLine() - Method in class dev.xichil.mvui.TextAreaModel: The line the cursor is on.
cursorX() - Method in class dev.xichil.mvui.TextAreaModel: The cursor's x in pixels from the start of its line.
Cycle<T> - Class in dev.xichil.mvui: A button that steps through a fixed list of values, shown as "label: value" like vanilla's option buttons (e.g.
Cycle.Builder<T> - Class in dev.xichil.mvui: Builds a Cycle; from Cycle.builder(String).

D

DESCRIPTORS - Static variable in class dev.xichil.mvui.BackendRegistry: Folder of the descriptors in a platform jar; same as UI_BACKEND_DESCRIPTORS in buildSrc.
dev.xichil.mvui - package dev.xichil.mvui: The API of Xi's Multiversion UI Lib (xis_mvui): declarative, version-independent menus for Minecraft mods.
DONE - Static variable in class dev.xichil.mvui.UiTexts: "Done" (gui.done): the usual footer button that saves or confirms and goes back.
Dropdown<T> - Class in dev.xichil.mvui: Picks one of a list of values, for lists too long to step through with a Cycle: languages, biomes, profiles.
Dropdown.Builder<T> - Class in dev.xichil.mvui: Builds a Dropdown; from Dropdown.builder(String).

E

enabled() - Method in class dev.xichil.mvui.Entry: Whether the widget can be used now, from the builder's enabled supplier.
enabled() - Static method in class dev.xichil.mvui.Failsafe: Whether the library's menus are on: false once a backend entry point failed (or the runtime couldn't start), for the rest of the session.
enabled(boolean) - Method in class dev.xichil.mvui.Entry.Builder: A fixed enabled state; see Entry.Builder.enabled(BooleanSupplier).
enabled(String) - Static method in class dev.xichil.mvui.Failsafe: Whether mod modId's menu is on: false once every menu is off (Failsafe.enabled()) or the mod's own menu code failed this session.
enabled(BooleanSupplier) - Method in class dev.xichil.mvui.Entry.Builder: Whether the widget can be used, re-read on every refresh.
end() - Method in class dev.xichil.mvui.TextAreaModel.Line: Offset just after the line's last character (before its '\n', if any).
englishName() - Method in class dev.xichil.mvui.Key: The English name, as vanilla's en_us shows it: "R", "Left Shift", "Button 4", "Not Bound".
entries() - Method in class dev.xichil.mvui.MenuScreen: The list's entries in screen order, top to bottom.
entries() - Method in class dev.xichil.mvui.StringListEditor: The entries the editor consists of: the list, the input, the Add button and the Remove button, in that order.
entry(String) - Method in class dev.xichil.mvui.MenuScreen: The entry with this id, in the list or the footer, or null if there is none.
Entry - Class in dev.xichil.mvui: One widget on a MenuScreen: the base class of every widget type (Button, Toggle, Slider…).
Entry.Builder<B> - Class in dev.xichil.mvui: The options every entry builder has.
entryClassName() - Method in class dev.xichil.mvui.BackendDescriptor: The backend's UiBackend implementation.
EntryVisitor<R> - Interface in dev.xichil.mvui: One method per entry type, for code that must handle every widget: a backend implements it to create the vanilla widget for each entry, and the test fixture's FakeHost to render and drive them.
equals(Object) - Method in class dev.xichil.mvui.BackendDescriptor
equals(Object) - Method in class dev.xichil.mvui.Key: Equal if both are the same type with the same code.
equals(Object) - Method in class dev.xichil.mvui.Text: Equal if key, fallback and arguments are equal.
error() - Method in class dev.xichil.mvui.MultiLineInput: Why the current text is invalid, from the mod's validator; shown below the box.
error() - Method in class dev.xichil.mvui.TextInput: Why the current text is invalid, from the mod's validator; shown below the field.
ERROR - Enum constant in enum class dev.xichil.mvui.StatusLine.Kind: An action failed.
ESCAPE - Static variable in class dev.xichil.mvui.Key: The Escape key (GLFW 256).
Exceptions - Section in class dev.xichil.mvui.Entry
expanded() - Method in class dev.xichil.mvui.Section: Whether the children are shown (if the section itself is visible); always true for a section that can't collapse.
expanded(boolean) - Method in class dev.xichil.mvui.Section.Builder: Whether a collapsible section starts expanded; false (collapsed) by default.

F

FABRIC - Enum constant in enum class dev.xichil.mvui.UiPlatform: Fabric and Quilt, 1.14+.
fail(String, Throwable) - Static method in class dev.xichil.mvui.Failsafe: Turns the menu of the mod whose code threw t off (ModFault), or every menu if no mod's code did; logs what and t if this is that mod's, or the session's, first failure.
Failsafe - Class in dev.xichil.mvui: The fail-safe around every backend entry point (D9, TODO.md 9.1): Options screen hooks, opening the menu, the mod list's config screen, a menu screen's init and drawing, and GameBridge calls.
Failures - Section in package dev.xichil.mvui
fallback() - Method in class dev.xichil.mvui.Text: The English pattern for translatable text, the text itself for literal text.
Fallback patterns and arguments - Section in class dev.xichil.mvui.Text
first(UiPlatform) - Method in class dev.xichil.mvui.BackendDescriptor: First DataVersion the backend was checked against on platform; selection starts here.
firstVisibleLine(int) - Method in class dev.xichil.mvui.TextAreaModel: The first line to draw when the box shows visibleLines: scrolled so the cursor is in view after it moved or the text changed, otherwise where TextAreaModel.scroll left it.
flushOptions() - Method in interface dev.xichil.mvui.GameBridge: Makes the game write its in-memory options to options.txt now, so that a copy of the file made afterwards has the newest values.
footer() - Method in class dev.xichil.mvui.MenuScreen: The footer row's entries, left to right.
footer(Entry) - Method in class dev.xichil.mvui.MenuScreen.Builder: Appends an entry to the footer row at the bottom of the screen, which stays in place while the list scrolls.
For backend authors - Section in package dev.xichil.mvui
ForcedFailure - Class in dev.xichil.mvui: Test switch for the fail-safe paths (D9): with -Dxis_mvui.forceError=true every backend hook that calls ForcedFailure.check(String) fails as if Minecraft had changed under it, so integration tests can show that the game and sync keep working without the menu.
FORGE - Enum constant in enum class dev.xichil.mvui.UiPlatform: Minecraft Forge, every supported version.
For mods - Section in class dev.xichil.mvui.Failsafe
forPlatform(UiPlatform) - Method in class dev.xichil.mvui.BackendRegistry: The backends serving platform, oldest first (by BackendDescriptor.first(UiPlatform)).
forTask(Callable) - Static method in class dev.xichil.mvui.MenuWorkers: The executor for task, as passed to a backend's UiHost.runAsync(Callable, BiConsumer): its mod's own single thread (Failsafe marks a registered menu's tasks with the mod id), or a shared one for tasks of no mod.
fromLwjgl2(int) - Static method in class dev.xichil.mvui.Key: The key for a 1.7.10 – 1.12.2 key code, as vanilla's KeyBinding stores them there: an LWJGL 2 Keyboard.KEY_* code, or -100 + button for a mouse button.
fromName(String) - Static method in class dev.xichil.mvui.Key: The key named name as in 1.13+'s options.txt: the inverse of Key.name().

G

game() - Method in interface dev.xichil.mvui.UiHost: The running game's options, for menus that save or load options.txt (e.g.
GameBridge - Interface in dev.xichil.mvui: The running game's options file, for menus that save or restore it (TODO.md §3.5): e.g.
guard(ScreenFactory) - Static method in class dev.xichil.mvui.Failsafe: menu with every UiHost and GameBridge call of its screens guarded: a backend failure there turns the menu off.

H

hasAlpha() - Method in class dev.xichil.mvui.ColorPicker: Whether the color has an alpha byte the player can edit (ColorPicker.Builder.alpha).
hashCode() - Method in class dev.xichil.mvui.BackendDescriptor
hashCode() - Method in class dev.xichil.mvui.Key
hashCode() - Method in class dev.xichil.mvui.Text
headerText() - Method in class dev.xichil.mvui.Section: What the header shows: "▼ title" while expanded, "▶ title" while collapsed (UiTexts.SECTION_EXPANDED, UiTexts.SECTION_COLLAPSED); just the title if the section can't collapse.
hex() - Method in class dev.xichil.mvui.ColorPicker: The color as the button shows it: "#RRGGBB", or "#AARRGGBB" with alpha; upper-case hex digits.
How it is drawn - Section in class dev.xichil.mvui.Section
How it looks and behaves - Section in class dev.xichil.mvui.Dropdown
How values and refreshes work - Section in package dev.xichil.mvui

I

id() - Method in class dev.xichil.mvui.BackendDescriptor: The backend id, e.g.
id() - Method in class dev.xichil.mvui.Entry: The entry's id, as given to its builder: matches [A-Za-z0-9_.-]+ and is unique within its screen.
id() - Method in class dev.xichil.mvui.Screen: The screen's id, as given to its builder; matches [A-Za-z0-9_.-]+.
id() - Method in class dev.xichil.mvui.SelectList.Row: The row's id within its list.
id() - Method in enum class dev.xichil.mvui.UiPlatform: The platform's key in a backend descriptor file, e.g.
Ids - Section in package dev.xichil.mvui
index() - Method in class dev.xichil.mvui.Cycle: Index of the mod's current value in Cycle.values(); 0 if the current value is not in the list.
index() - Method in class dev.xichil.mvui.Dropdown: Index of the mod's current value in Dropdown.values(); 0 if the current value is not in the list.
INDEX - Static variable in class dev.xichil.mvui.BackendRegistry: One backend id per line: the descriptors bundled next to it (a class loader can't list a folder).
INFO - Enum constant in enum class dev.xichil.mvui.StatusLine.Kind: Neutral information.
initial(String) - Method in class dev.xichil.mvui.MultiLineInput.Builder: The text the box starts with; empty by default.
initial(String) - Method in class dev.xichil.mvui.TextInput.Builder: The text the field starts with, usually the mod's current value; empty by default.
initial(N) - Method in class dev.xichil.mvui.NumberField.Builder: The number the field starts with, usually the mod's current value.
input() - Method in class dev.xichil.mvui.NumberField: The text input backends draw; it has this entry's id, label, enabled state, tooltip and visibility.
inputLabel(Text) - Method in class dev.xichil.mvui.StringListEditor.Builder: The label above the text field, e.g.
insert(String) - Method in class dev.xichil.mvui.TextAreaModel: Inserts s at the cursor (pasted text), as much of it as fits; false if nothing was inserted.
isBusy() - Method in interface dev.xichil.mvui.UiHost: Whether a UiHost.runAsync(Callable, BiConsumer) task is running; the screen is inactive meanwhile.
isInWorld() - Method in interface dev.xichil.mvui.GameBridge: Whether a world (single- or multiplayer) is loaded, e.g.
isLiteral() - Method in class dev.xichil.mvui.Text: Whether this is Text.literal(String) text (it has no key).
isUnbound() - Method in class dev.xichil.mvui.Key: Whether this is Key.UNBOUND, "no key".
isValid() - Method in class dev.xichil.mvui.MultiLineInput: Whether the current text is valid: MultiLineInput.error() is null.
isValid() - Method in class dev.xichil.mvui.TextInput: Whether the current text is valid: TextInput.error() is null.
items(Supplier) - Method in class dev.xichil.mvui.StringListEditor.Builder: The current items, in display order; re-read on every refresh.

K

key() - Method in class dev.xichil.mvui.Keybind: The mod's current key; Key.UNBOUND if its supplier returns null.
key() - Method in class dev.xichil.mvui.Text: The translation key, or null for literal text.
key(Key) - Method in class dev.xichil.mvui.TextAreaModel: A pressed key: Backspace, Delete, Enter (line break), the arrows, Home and End (of the line).
Key - Class in dev.xichil.mvui: A keyboard key or mouse button that a Keybind can be set to, the same in every Minecraft version.
Key.Type - Enum Class in dev.xichil.mvui: Whether a Key is a keyboard key or a mouse button.
Keybind - Class in dev.xichil.mvui: A key binding button, as on vanilla's Controls screen: "label: key".
Keybind.Builder - Class in dev.xichil.mvui: Builds a Keybind; from Keybind.builder(String).
keyboard(int) - Static method in class dev.xichil.mvui.Key: The keyboard key with GLFW key code glfwCode, e.g.
KEYBOARD - Enum constant in enum class dev.xichil.mvui.Key.Type: A keyboard key; Key.code() is its GLFW key code.
kind() - Method in class dev.xichil.mvui.StatusLine: The current message's severity; StatusLine.Kind.INFO while empty.

L

label() - Method in class dev.xichil.mvui.Button: The text on the button, from the mod's supplier.
label() - Method in class dev.xichil.mvui.Checkbox: The text to the right of the box, from the mod's supplier.
label() - Method in class dev.xichil.mvui.ColorPicker: The text before ": #RRGGBB", from the mod's supplier; also the editor's title.
label() - Method in class dev.xichil.mvui.Cycle: The text before ": value", from the mod's supplier.
label() - Method in class dev.xichil.mvui.Dropdown: The text before ": value", from the mod's supplier; also the picker screen's title.
label() - Method in class dev.xichil.mvui.Keybind: The text before ": key", from the mod's supplier.
label() - Method in class dev.xichil.mvui.MultiLineInput: The text shown above the box, from the mod's supplier.
label() - Method in class dev.xichil.mvui.Slider: The text before ": value", from the mod's supplier.
label() - Method in class dev.xichil.mvui.TextInput: The text shown above the field, from the mod's supplier.
label() - Method in class dev.xichil.mvui.Toggle: The text before ": ON/OFF", from the mod's supplier.
label(Text) - Method in class dev.xichil.mvui.Button.Builder: A fixed text; see Button.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Checkbox.Builder: A fixed label; see Checkbox.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.ColorPicker.Builder: A fixed label; see ColorPicker.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Cycle.Builder: A fixed label; see Cycle.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Dropdown.Builder: A fixed label; see Dropdown.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Keybind.Builder: A fixed label; see Keybind.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.MultiLineInput.Builder: A fixed label; see MultiLineInput.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.NumberField.Builder: A fixed label; see NumberField.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Slider.Builder: A fixed label; see Slider.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.TextInput.Builder: A fixed label; see TextInput.Builder.label(Supplier).
label(Text) - Method in class dev.xichil.mvui.Toggle.Builder: A fixed label; see Toggle.Builder.label(Supplier).
label(Supplier) - Method in class dev.xichil.mvui.Button.Builder: The text on the button, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Checkbox.Builder: The text to the right of the box, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.ColorPicker.Builder: The text before ": #RRGGBB" and the editor's title, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Cycle.Builder: The text before ": value", re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Dropdown.Builder: The text before ": value" and the picker's title, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Keybind.Builder: The text before ": key", re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.MultiLineInput.Builder: The text above the box, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.NumberField.Builder: The text above the field, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Slider.Builder: The text before ": value", re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.TextInput.Builder: The text above the field, re-read on every refresh.
label(Supplier) - Method in class dev.xichil.mvui.Toggle.Builder: The text before ": ON/OFF", re-read on every refresh.
Label - Class in dev.xichil.mvui: Read-only text on its own row: an explanation, a heading, or a value to show.
Label.Builder - Class in dev.xichil.mvui: Builds a Label; from Label.builder(String).
last(UiPlatform) - Method in class dev.xichil.mvui.BackendDescriptor: Last DataVersion the backend was checked against on platform, or BackendDescriptor.OPEN.
layout(int, ToIntFunction) - Method in class dev.xichil.mvui.TextAreaModel: Wraps lines to maxWidth pixels, measured with widthOf (the font's string width).
LEGACY_FABRIC - Enum constant in enum class dev.xichil.mvui.UiPlatform: Legacy Fabric, 1.7.10 – 1.13.2.
LEGACY_FORGE_GUI_FACTORY - Static variable in class dev.xichil.mvui.MultiversionUi: Class name for @Mod(guiFactory = MultiversionUi.LEGACY_FORGE_GUI_FACTORY) on Forge 1.8 – 1.12.2.
lines() - Method in class dev.xichil.mvui.MultiLineInput: How many lines of text the box shows at once (2 – 12): its height.
lines() - Method in class dev.xichil.mvui.TextAreaModel: The lines as drawn, wrapped to the TextAreaModel.layout(int, ToIntFunction) width; at least one (empty text has one empty line).
lines(int) - Method in class dev.xichil.mvui.MultiLineInput.Builder: How many lines the box shows at once, from 2 to 12; 4 by default.
literal(String) - Static method in class dev.xichil.mvui.Text: Text shown as-is in every language, e.g.
load(ClassLoader) - Static method in class dev.xichil.mvui.BackendRegistry: Reads the backends listed in BackendRegistry.INDEX.
logTo(BiConsumer) - Static method in class dev.xichil.mvui.Failsafe: Where failures are logged; by default System.err in the core's format.

M

max() - Method in class dev.xichil.mvui.NumberField: The maximum (inclusive), or null for none.
max() - Method in class dev.xichil.mvui.Slider: The largest value.
maxLength() - Method in class dev.xichil.mvui.MultiLineInput: The most characters the box accepts, line breaks included; longer text is cut.
maxLength() - Method in class dev.xichil.mvui.TextInput: The most characters the field accepts; longer text is cut.
maxLength(int) - Method in class dev.xichil.mvui.MultiLineInput.Builder: The most characters the box accepts, line breaks included; 1024 by default.
maxLength(int) - Method in class dev.xichil.mvui.NumberField.Builder: The most characters the field accepts; 32 by default.
maxLength(int) - Method in class dev.xichil.mvui.StringListEditor.Builder: The most characters of a new item; 256 by default.
maxLength(int) - Method in class dev.xichil.mvui.TextInput.Builder: The most characters the field accepts; 64 by default.
menu() - Method in class dev.xichil.mvui.MultiversionUi.Registration: The menu, wrapped by Failsafe: not the object the mod passed, but one that delegates to it and turns only this mod's menu off when the mod's code fails.
menu(String) - Static method in class dev.xichil.mvui.MultiversionUi: Mod modId's registered menu, or null if that mod registered none.
MENU_OFF - Static variable in class dev.xichil.mvui.Failsafe: Logged with the failing hook's name; integration tests look for it.
MENU_OFF - Static variable in class dev.xichil.mvui.UiTexts: A mod's menu once its own code failed (Failsafe): the text of the screen it opens as, and its tooltip in the list of mod menus.
menus() - Static method in class dev.xichil.mvui.MultiversionUi: Every registered menu, in registration order: a snapshot that later registrations don't change.
menuScreen(ScreenFactory, Object) - Method in interface dev.xichil.mvui.MultiversionUi.Runtime: UiBackend.menuScreen(ScreenFactory, Object) of the running backend.
menuScreen(ScreenFactory, Object) - Method in interface dev.xichil.mvui.UiBackend: menu as this version's vanilla screen, returning to parent (also a vanilla screen) when closed, without showing it.
menuScreen(String, Object) - Static method in class dev.xichil.mvui.MultiversionUi: Mod modId's menu as the running version's vanilla screen, without showing it; for a mod that opens its menu from its own buttons or key bindings.
MenuScreen - Class in dev.xichil.mvui: The main screen type: a title, a vertical, scrolling list of entries, and a row of footer entries at the bottom (usually "Done").
MenuScreen.Builder - Class in dev.xichil.mvui: Builds a MenuScreen; from MenuScreen.builder(String).
MenuWorkers - Class in dev.xichil.mvui: Where backends run UiHost.runAsync(Callable, BiConsumer) tasks: one daemon thread per mod, so a mod whose task hangs (store IO waiting on another instance's file lock) holds up only its own menu.
message() - Method in class dev.xichil.mvui.ConfirmDialog: The question's explanation, shown below the title.
message(Text) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: The explanation below the question, e.g.
min() - Method in class dev.xichil.mvui.NumberField: The minimum (inclusive), or null for none.
min() - Method in class dev.xichil.mvui.Slider: The smallest value.
mixinPackage() - Method in class dev.xichil.mvui.BackendDescriptor: Package of the backend's mixins (Fabric and Legacy Fabric backends).
MOD_ID - Static variable in class dev.xichil.mvui.MultiversionUi: The library's mod id, "xis_mvui": what a mod names in its dependency declaration, e.g.
MOD_MENU_OFF - Static variable in class dev.xichil.mvui.Failsafe: Logged with the failing mod's id when only its menu turns off; integration tests look for it.
MOD_MENUS - Static variable in class dev.xichil.mvui.UiTexts: "Mod menus...": the Options screen's button when several mods registered a menu; it opens UiTexts.MOD_MENUS_TITLE.
MOD_MENUS_TITLE - Static variable in class dev.xichil.mvui.UiTexts: "Mod menus": title of the list of every registered mod's menu.
modId() - Method in class dev.xichil.mvui.MultiversionUi.Registration: The id of the mod that registered the menu, as passed to MultiversionUi.register(String, Text, ScreenFactory).
mouse(int) - Static method in class dev.xichil.mvui.Key: A mouse button.
MOUSE - Enum constant in enum class dev.xichil.mvui.Key.Type: A mouse button; Key.code() is its number (0 left, 1 right, 2 middle…).
MultiLineInput - Class in dev.xichil.mvui: A text box of several lines, for notes, descriptions or lists the player types freely.
MultiLineInput.Builder - Class in dev.xichil.mvui: Builds a MultiLineInput; from MultiLineInput.builder(String).
MultiversionUi - Class in dev.xichil.mvui: Where mods register their menus with Xi's Multiversion UI Lib, and the static entry point of the API.
MultiversionUi.Registration - Class in dev.xichil.mvui: One successful MultiversionUi.register(String, Text, ScreenFactory) call: a mod id, its display name and its guarded menu.
MultiversionUi.Runtime - Interface in dev.xichil.mvui: What MultiversionUi needs from the library's runtime (core, which implements it): the part that knows the running game and its backend.

N

name() - Method in class dev.xichil.mvui.Key: The key's name as in 1.13+'s options.txt: key.keyboard.r, key.mouse.left, key.keyboard.unknown.
name() - Method in class dev.xichil.mvui.MultiversionUi.Registration: What the list of mod menus shows for this mod: the name passed to MultiversionUi.register(String, Text, ScreenFactory).
needsRestart() - Method in class dev.xichil.mvui.ReloadResult: Whether some options take effect only after a restart (ReloadResult.restartOptions() is not empty).
needsRestart(String...) - Static method in class dev.xichil.mvui.ReloadResult: These options apply only after a restart.
NEOFORGE - Enum constant in enum class dev.xichil.mvui.UiPlatform: NeoForge, 1.20.1+.
next() - Method in class dev.xichil.mvui.Cycle: Selects the value after the current one, wrapping to the first after the last, as a click does.
NO - Static variable in class dev.xichil.mvui.UiTexts: "No" (gui.no): a ConfirmDialog's default no label.
noLabel() - Method in class dev.xichil.mvui.ConfirmDialog: The label of the "no" button.
noLabel(Text) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: The "no" button's label; UiTexts.NO by default, e.g.
NOT_A_COLOR - Static variable in class dev.xichil.mvui.UiTexts: "Not a color: use #RRGGBB": a ColorPicker editor's hex field error.
NOT_A_COLOR_ALPHA - Static variable in class dev.xichil.mvui.UiTexts: "Not a color: use #AARRGGBB": a ColorPicker editor's hex field error, with alpha.
NOT_A_NUMBER - Static variable in class dev.xichil.mvui.UiTexts: "Not a number": a NumberField's error for text that doesn't parse.
NOT_A_WHOLE_NUMBER - Static variable in class dev.xichil.mvui.UiTexts: "Not a whole number": an int field's error for a decimal.
nudge(int) - Method in class dev.xichil.mvui.Slider: One arrow key press: moves the value by one step, or by 1% of the range on a slider without a step.
number() - Method in class dev.xichil.mvui.NumberField: The number in the field, for an action that reads it directly.
NumberField<N> - Class in dev.xichil.mvui: A TextInput for a number, optionally between a minimum and a maximum.
NumberField.Builder<N> - Class in dev.xichil.mvui: Builds a NumberField; from NumberField.ofInt(String) or NumberField.ofDouble(String).

O

of(String, Text) - Static method in class dev.xichil.mvui.SelectList.Row: A row.
ofDouble(String) - Static method in class dev.xichil.mvui.NumberField: Starts building a field for decimal numbers (double); '.' is the decimal separator in every language.
OFF - Static variable in class dev.xichil.mvui.UiTexts: "OFF" (options.off): a Toggle's value while off.
ofInt(String) - Static method in class dev.xichil.mvui.NumberField: Starts building a field for whole numbers (int, the full int range unless limited with NumberField.Builder.range(N, N)).
Old versions - Section in class dev.xichil.mvui.Key
ON - Static variable in class dev.xichil.mvui.UiTexts: "ON" (options.on): a Toggle's value while on.
onAdd(Consumer) - Method in class dev.xichil.mvui.StringListEditor.Builder: Adds a new item to the mod's list when the player presses Add; runs on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.NumberField.Builder: Receives the number after each edit that leaves the text valid, on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.Cycle.Builder: Stores the newly selected value; runs on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.Dropdown.Builder: Stores the picked value; runs on the main thread after the picker has closed.
onChange(Consumer) - Method in class dev.xichil.mvui.Keybind.Builder: Stores the newly bound key; runs on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.Checkbox.Builder: Stores a new value when the player clicks; runs on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.Toggle.Builder: Stores a new value when the player clicks; runs on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.MultiLineInput.Builder: Receives the text after each edit that leaves it valid, on the main thread.
onChange(Consumer) - Method in class dev.xichil.mvui.TextInput.Builder: Receives the text after each edit that leaves it valid, on the main thread.
onChange(DoubleConsumer) - Method in class dev.xichil.mvui.Slider.Builder: Stores a new value; called on the main thread for every distinct snapped value while the player drags, not just on release.
onChange(IntConsumer) - Method in class dev.xichil.mvui.ColorPicker.Builder: Stores the color when the player presses Done in the editor; runs on the main thread.
onNo(Runnable) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: What "no" does, run on the main thread after the dialog has closed.
onPress(Runnable) - Method in class dev.xichil.mvui.Button.Builder: What a click does, run on the main thread.
onRemove(Consumer) - Method in class dev.xichil.mvui.StringListEditor.Builder: Removes an item from the mod's list when the player presses Remove; runs on the main thread.
onSelect(Consumer) - Method in class dev.xichil.mvui.SelectList.Builder: Called when the player selects a row (or SelectList.select(String) is called), on the main thread.
onToggle(Consumer) - Method in class dev.xichil.mvui.Section.Builder: Called with the new state (true = expanded) each time the section is expanded or collapsed, e.g.
onYes(Runnable) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: What "yes" does, run on the main thread after the dialog has closed.
open(Screen) - Method in interface dev.xichil.mvui.UiHost: Opens a screen on top of the current one: a new MenuScreen or a ConfirmDialog.
open(UiHost) - Method in class dev.xichil.mvui.ColorPicker: Opens the editor screen on host, starting from the current color.
open(UiHost) - Method in class dev.xichil.mvui.Dropdown: Opens the picker screen on host, the current value selected.
OPEN - Static variable in class dev.xichil.mvui.BackendDescriptor: BackendDescriptor.last(UiPlatform) of an open-ended range (newest backend of a platform, future versions).
OPEN_MENU - Static variable in class dev.xichil.mvui.UiTexts: "Menu...": the default ScreenFactory.buttonLabel().
Options every entry has - Section in class dev.xichil.mvui.Entry

P

packageName() - Method in class dev.xichil.mvui.BackendDescriptor: dev.xichil.mvui.backend.<id with _ for ->: the backend's own package.
parse(Properties) - Static method in class dev.xichil.mvui.BackendDescriptor: Parses a descriptor file: id, names and one <platform>=first-last per served platform (empty last: open-ended).
parseHex(String, boolean) - Static method in class dev.xichil.mvui.ColorPicker: Parses a hex color as the editor's hex field does; useful for mods that read colors from config text.
position() - Method in class dev.xichil.mvui.Slider: The knob's position for the current value: 0 at min, 1 at max.
press() - Method in class dev.xichil.mvui.Button: Runs onPress, as a click does.
PROPERTY - Static variable in class dev.xichil.mvui.ForcedFailure: The system property, "xis_mvui.forceError": launch with -Dxis_mvui.forceError=true to make every hook fail.

Q

Quick start - Section in package dev.xichil.mvui

R

range(double, double) - Method in class dev.xichil.mvui.Slider.Builder: The range of values, both ends inclusive.
range(N, N) - Method in class dev.xichil.mvui.NumberField.Builder: The allowed range, both ends inclusive; either may be null for no bound.
refresh() - Method in interface dev.xichil.mvui.UiHost: Re-reads all suppliers of the current screen (labels, values, enabled states, visibility, rows, tooltips…) and redraws it.
Refreshing - Section in interface dev.xichil.mvui.UiHost
register(String, Text, ScreenFactory) - Static method in class dev.xichil.mvui.MultiversionUi: Registers menu as mod modId's menu, shown as name in the list of mod menus.
registered(MultiversionUi.Registration) - Method in interface dev.xichil.mvui.MultiversionUi.Runtime: registration was just added to MultiversionUi.menus(); called on the registering thread.
Registering - Section in class dev.xichil.mvui.MultiversionUi
registerModConfigScreen(ScreenFactory) - Method in interface dev.xichil.mvui.UiBackend: Makes menu the mod list's config screen of the mod whose container is the loader's active one (Forge and NeoForge 1.13+, where MultiversionUi.register(String, Text, ScreenFactory) runs in that mod's constructor).
reloadGameOptions() - Static method in class dev.xichil.mvui.MultiversionUi: Makes the running game re-read options.txt and apply it, for a mod that changed the file after the game read it (e.g.
reloadGameOptions() - Method in interface dev.xichil.mvui.MultiversionUi.Runtime: UiBackend.applyRestoredOptions() of the running backend.
reloadOptions() - Method in interface dev.xichil.mvui.GameBridge: Re-reads options.txt after the mod changed it, and applies what can be applied in the running game (graphics, sound, controls, language…).
ReloadResult - Class in dev.xichil.mvui: What GameBridge.reloadOptions() could not apply in the running game: the options that take effect only after a restart.
REMOVE - Static variable in class dev.xichil.mvui.UiTexts: "Remove": a StringListEditor's default Remove label.
removeLabel(Text) - Method in class dev.xichil.mvui.StringListEditor.Builder: The Remove button's label; UiTexts.REMOVE by default.
reset() - Static method in class dev.xichil.mvui.Failsafe: Forgets earlier failures.
restartOptions() - Method in class dev.xichil.mvui.ReloadResult: The options that take effect only after a restart, as options.txt keys; options.txt itself if nothing could be applied.
rows() - Method in class dev.xichil.mvui.SelectList: The current rows, from the mod's supplier.
rows(Supplier) - Method in class dev.xichil.mvui.SelectList.Builder: The rows, in display order; re-read on every refresh.
Rules - Section in class dev.xichil.mvui.Section
Rules, checked by the builder - Section in class dev.xichil.mvui.MenuScreen
run(String, Runnable) - Static method in class dev.xichil.mvui.Failsafe: Runs action, guarded: if it throws, Failsafe.fail(String, Throwable) handles it and this returns false.
runAsync(Callable, BiConsumer) - Method in interface dev.xichil.mvui.UiHost: Runs task off the main thread, for work that may block, such as file IO (which may wait on another game instance's file lock) or network requests.
runOnMainThread(Runnable) - Method in interface dev.xichil.mvui.UiHost: Runs a task on the game's main thread, soon; safe to call from any thread.
runtimeNames() - Method in class dev.xichil.mvui.BackendDescriptor: The runtime-name family (TODO.md §3.2), e.g.

S

Safety - Section in class dev.xichil.mvui.MultiversionUi
Screen - Class in dev.xichil.mvui: Something a UiHost can open: exactly one of MenuScreen (a list of widgets) or ConfirmDialog (a yes/no question).
ScreenFactory - Interface in dev.xichil.mvui: A mod's menu: builds the menu's first screen each time the player opens it.
scroll(int, int) - Method in class dev.xichil.mvui.TextAreaModel: Mouse wheel: scrolls by lines (negative is up) without moving the cursor.
Section - Class in dev.xichil.mvui: A titled group of entries on a MenuScreen.
SECTION_COLLAPSED - Static variable in class dev.xichil.mvui.UiTexts: "▶ %s": a collapsible Section's header while collapsed; the argument is the title.
SECTION_EXPANDED - Static variable in class dev.xichil.mvui.UiTexts: "▼ %s": a collapsible Section's header while expanded; the argument is the title.
Section.Builder - Class in dev.xichil.mvui: Builds a Section; from Section.builder(String).
select(int) - Method in class dev.xichil.mvui.Cycle: Passes the value at index to onChange, even if it is the current one.
select(int) - Method in class dev.xichil.mvui.Dropdown: Passes the value at index to onChange, even if it is the current one.
select(UiPlatform, int) - Method in class dev.xichil.mvui.BackendRegistry: The backend for a game at dataVersion on platform: the one with the highest first DataVersion not above dataVersion.
select(String) - Method in class dev.xichil.mvui.SelectList: Selects a row and notifies onSelect, as a click on the row does.
selected() - Method in class dev.xichil.mvui.SelectList: The selected row's id, or null if no row is selected.
SelectList - Class in dev.xichil.mvui: A scrolling list of rows of text, at most one of them selected, like vanilla's world or server lists.
SelectList.Builder - Class in dev.xichil.mvui: Builds a SelectList; from SelectList.builder(String).
SelectList.Row - Class in dev.xichil.mvui: One row of a SelectList: an id the mod knows it by, and the text shown.
serves(UiPlatform) - Method in class dev.xichil.mvui.BackendDescriptor: Whether the backend serves platform.
set(boolean) - Method in class dev.xichil.mvui.Checkbox: Passes checked to onChange, even if it equals the current value.
set(boolean) - Method in class dev.xichil.mvui.Toggle: Passes newValue to onChange, even if it equals the current value.
set(double) - Method in class dev.xichil.mvui.Slider: Sets the value, snapped and clamped; onChange runs only if that changes it.
set(int) - Method in class dev.xichil.mvui.ColorPicker: Passes color to onChange (without alpha, its top byte cleared).
set(Key) - Method in class dev.xichil.mvui.Keybind: Binds key: passes it to onChange, even if it is the current key.
setCursor(int) - Method in class dev.xichil.mvui.TextAreaModel: Moves the cursor and scrolls it into view.
setExpanded(boolean) - Method in class dev.xichil.mvui.Section: Expands or collapses the section and tells onToggle.
setPosition(double) - Method in class dev.xichil.mvui.Slider: Moves the knob to position, as dragging or clicking the slider does: sets the value at that point of the range, snapped.
setText(String) - Method in class dev.xichil.mvui.TextAreaModel: Replaces the text (e.g.
setValue(String) - Method in class dev.xichil.mvui.MultiLineInput: Stores the text (line breaks as '\n', cut to MultiLineInput.maxLength(); null counts as empty) and passes it to onChange if it is valid.
setValue(String) - Method in class dev.xichil.mvui.TextInput: Stores the text (cut to TextInput.maxLength(); null counts as empty) and passes it to onChange if it is valid.
show(StatusLine.Kind, Text) - Method in class dev.xichil.mvui.StatusLine: Shows a message, replacing the previous one.
Slider - Class in dev.xichil.mvui: A vanilla slider over a range of numbers, showing "label: value" on the slider itself, like vanilla's FOV or volume sliders.
Slider.Builder - Class in dev.xichil.mvui: Builds a Slider; from Slider.builder(String).
start() - Method in class dev.xichil.mvui.TextAreaModel.Line: Offset of the line's first character in TextAreaModel.text().
start(ScreenFactory) - Method in interface dev.xichil.mvui.UiBackend: Hooks the Options screen so that its button opens optionsMenu: on Forge and NeoForge by registering the backend's event listener, on Fabric by handing it to the backend's mixins (which only apply for the selected backend).
start(ScreenFactory, int) - Method in interface dev.xichil.mvui.UiBackend: Calls UiBackend.start(ScreenFactory).
StatusLine - Class in dev.xichil.mvui: A line the screen's actions write their results to, e.g.
StatusLine.Builder - Class in dev.xichil.mvui: Builds a StatusLine; from StatusLine.builder(String).
StatusLine.Kind - Enum Class in dev.xichil.mvui: The severity of a message; backends pick its color from it (e.g.
step() - Method in class dev.xichil.mvui.Slider: The step between values: they are min + k * step; 0 allows any value in the range.
step(double) - Method in class dev.xichil.mvui.Slider.Builder: The distance between selectable values: 1 for whole numbers, 0.1 for one decimal, and so on.
Storing keys - Section in class dev.xichil.mvui.Key
StringListEditor - Class in dev.xichil.mvui: Edits a list of unique strings, such as server addresses, item ids or ignored player names: a list of the items, a text field for a new item, and Add and Remove buttons.
StringListEditor.Builder - Class in dev.xichil.mvui: Builds a StringListEditor; from StringListEditor.builder(String).
SUCCESS - Enum constant in enum class dev.xichil.mvui.StatusLine.Kind: An action succeeded.
Suppliers and refreshes - Section in class dev.xichil.mvui.Entry
swatchColor() - Method in class dev.xichil.mvui.ColorPicker: The color to fill the swatch with, as 0xAARRGGBB: fully opaque unless the picker has alpha.

T

Testing menus without Minecraft - Section in package dev.xichil.mvui
text() - Method in class dev.xichil.mvui.Label: The text shown, from the mod's supplier.
text() - Method in class dev.xichil.mvui.SelectList.Row: The text shown in the row.
text() - Method in class dev.xichil.mvui.StatusLine: The current message, or null while the line is empty.
text() - Method in class dev.xichil.mvui.TextAreaModel.Line: The line's text.
text() - Method in class dev.xichil.mvui.TextAreaModel: The whole text, with '\n' line breaks.
text(Text) - Method in class dev.xichil.mvui.Label.Builder: A fixed text; see Label.Builder.text(Supplier).
text(Supplier) - Method in class dev.xichil.mvui.Label.Builder: The text, re-read on every refresh.
Text - Class in dev.xichil.mvui: A piece of user-visible text, independent of Minecraft's text classes (which differ between versions).
TextAreaModel - Class in dev.xichil.mvui: The editing logic of a MultiLineInput box, for backends of versions without vanilla's MultiLineEditBox (before 1.19.3, TODO.md Phase 11): text, cursor, word wrap, scrolling and the keys, so such a backend only draws the box and feeds it input.
TextAreaModel(int) - Constructor for class dev.xichil.mvui.TextAreaModel: An empty model, cursor at 0, with no wrapping until TextAreaModel.layout(int, ToIntFunction) is called.
TextAreaModel.Line - Class in dev.xichil.mvui: One line as drawn: text().substring(start, end), without its line break.
TextInput - Class in dev.xichil.mvui: A one-line text field with a label above it and an error line below it, like the name field of vanilla's world-creation screen.
TextInput.Builder - Class in dev.xichil.mvui: Builds a TextInput; from TextInput.builder(String).
The editor - Section in class dev.xichil.mvui.ColorPicker
The screen stack - Section in interface dev.xichil.mvui.UiHost
Threads - Section in interface dev.xichil.mvui.UiHost
Threads - Section in package dev.xichil.mvui
title() - Method in class dev.xichil.mvui.Screen: The title shown at the top of the screen; never null.
title() - Method in class dev.xichil.mvui.Section: The section's title, from the mod's supplier, without the ▼/▶ marker.
title(Text) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: The question, shown at the top, e.g.
title(Text) - Method in class dev.xichil.mvui.MenuScreen.Builder: The title shown at the top of the screen.
title(Text) - Method in class dev.xichil.mvui.Section.Builder: A fixed title; see Section.Builder.title(Supplier).
title(Supplier) - Method in class dev.xichil.mvui.Section.Builder: The section's title, re-read on every refresh.
toEnglish() - Method in class dev.xichil.mvui.Text: The fallback with the arguments filled in, nested Text rendered in English too; what a player would see without any translation.
toggle() - Method in class dev.xichil.mvui.Checkbox: Passes the opposite of Checkbox.checked() to onChange, as a click does.
toggle() - Method in class dev.xichil.mvui.Section: Flips Section.expanded(), as a click on the header does; see Section.setExpanded(boolean).
toggle() - Method in class dev.xichil.mvui.Toggle: Passes the opposite of Toggle.value() to onChange, as a click does.
Toggle - Class in dev.xichil.mvui: An on/off setting, drawn as a vanilla button reading "label: ON" or "label: OFF" (UiTexts.ON, UiTexts.OFF), like the toggles on vanilla's options screens.
Toggle.Builder - Class in dev.xichil.mvui: Builds a Toggle; from Toggle.builder(String).
toLwjgl2() - Method in class dev.xichil.mvui.Key: The 1.7.10 – 1.12.2 key code: the inverse of Key.fromLwjgl2(int).
tooltip() - Method in class dev.xichil.mvui.Entry: The tooltip shown while the mouse is over the widget, from the builder's tooltip supplier.
tooltip(Text) - Method in class dev.xichil.mvui.Entry.Builder: A fixed tooltip; see Entry.Builder.tooltip(Supplier).
tooltip(Supplier) - Method in class dev.xichil.mvui.Entry.Builder: The tooltip shown while the mouse is over the widget, re-read on every refresh; the supplier may return null for no tooltip at that moment.
toString() - Method in class dev.xichil.mvui.BackendDescriptor
toString() - Method in class dev.xichil.mvui.Key: The Key.name().
toString() - Method in class dev.xichil.mvui.MultiversionUi.Registration: The mod id.
toString() - Method in class dev.xichil.mvui.Text: Text.toEnglish().
translatable(String, String, Object...) - Static method in class dev.xichil.mvui.Text: Translatable text: shown as the running language's translation of key, or as fallback where the key has none.
type() - Method in class dev.xichil.mvui.Key: Whether this is a keyboard key (including Key.UNBOUND) or a mouse button.
type(char) - Method in class dev.xichil.mvui.TextAreaModel: A typed character; false if it isn't allowed (control characters, '§') or the text is full.

U

UiBackend - Interface in dev.xichil.mvui: A backend's entry point: the class BackendDescriptor.entryClassName() names, with a public no-argument constructor.
UiHost - Interface in dev.xichil.mvui: Shows a menu's screens and runs work for them.
UiPlatform - Enum Class in dev.xichil.mvui: The mod loader a backend serves (TODO.md 0.6).
UiTexts - Class in dev.xichil.mvui: Ready-made texts: the ones the widgets themselves need, and common button labels mods can reuse.
UNBOUND - Static variable in class dev.xichil.mvui.Key: No key: GLFW_KEY_UNKNOWN (-1), named key.keyboard.unknown, shown as "Not Bound".

V

Validation - Section in class dev.xichil.mvui.NumberField
validator(Function) - Method in class dev.xichil.mvui.NumberField.Builder: An extra check for numbers that already passed parsing and the range: returns an error text, or null if the number is valid.
validator(Function) - Method in class dev.xichil.mvui.MultiLineInput.Builder: Checks the text: returns an error text for invalid input (shown below the box), null for valid input.
validator(Function) - Method in class dev.xichil.mvui.StringListEditor.Builder: Checks a new item before it can be added: returns an error text (shown below the field) or null.
validator(Function) - Method in class dev.xichil.mvui.TextInput.Builder: Checks the text after every edit and refresh: returns an error text for invalid input (shown below the field), null for valid input.
value() - Method in class dev.xichil.mvui.MultiLineInput: The text in the box now, valid or not, with '\n' line breaks; never null.
value() - Method in class dev.xichil.mvui.Slider: The mod's current value, snapped to the step and clamped to the range (min if it is NaN).
value() - Method in class dev.xichil.mvui.TextInput: The text in the field now, valid or not; never null.
value() - Method in class dev.xichil.mvui.Toggle: The mod's current value, from its value supplier.
value(BooleanSupplier) - Method in class dev.xichil.mvui.Checkbox.Builder: Reads whether the box is checked; re-read on every refresh.
value(BooleanSupplier) - Method in class dev.xichil.mvui.Toggle.Builder: Reads the mod's current value; re-read on every refresh.
value(DoubleSupplier) - Method in class dev.xichil.mvui.Slider.Builder: Reads the mod's current value; re-read on every refresh and during drags.
value(IntSupplier) - Method in class dev.xichil.mvui.ColorPicker.Builder: Reads the mod's current color; re-read on every refresh.
value(Supplier) - Method in class dev.xichil.mvui.Keybind.Builder: Reads the mod's current key; re-read on every refresh.
value(Supplier) - Method in class dev.xichil.mvui.Cycle.Builder: Reads the mod's current value; re-read on every refresh.
value(Supplier) - Method in class dev.xichil.mvui.Dropdown.Builder: Reads the mod's current value; re-read on every refresh.
valueOf(String) - Static method in enum class dev.xichil.mvui.Key.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.xichil.mvui.StatusLine.Kind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.xichil.mvui.UiPlatform: Returns the enum constant of this class with the specified name.
values() - Method in class dev.xichil.mvui.Cycle: The values, in cycling order: a copy of the builder's list taken at build time.
values() - Method in class dev.xichil.mvui.Dropdown: The values, in list order: a copy of the builder's list taken at build time.
values() - Static method in enum class dev.xichil.mvui.Key.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.xichil.mvui.StatusLine.Kind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.xichil.mvui.UiPlatform: Returns an array containing the constants of this enum class, in the order they are declared.
values(List) - Method in class dev.xichil.mvui.Cycle.Builder: The values to step through, in order.
values(List) - Method in class dev.xichil.mvui.Dropdown.Builder: The values the picker lists, in order.
Values - Section in class dev.xichil.mvui.Slider
valueText() - Method in class dev.xichil.mvui.Cycle: The current value's text, shown after "label: ".
valueText() - Method in class dev.xichil.mvui.Dropdown: The current value's text, shown after "label: ".
valueText() - Method in class dev.xichil.mvui.Slider: The current value as the slider shows it after "label: ", from the builder's valueText.
valueText(DoubleFunction) - Method in class dev.xichil.mvui.Slider.Builder: How the value is shown after "label: ".
valueText(Function) - Method in class dev.xichil.mvui.Cycle.Builder: How a value is shown after "label: ".
valueText(Function) - Method in class dev.xichil.mvui.Dropdown.Builder: How a value is shown on the button and in the picker's rows.
valueTexts() - Method in class dev.xichil.mvui.Cycle: Every value's text, in Cycle.values() order, from the mod's valueText function.
valueTexts() - Method in class dev.xichil.mvui.Dropdown: Every value's text, in Dropdown.values() order: the picker's rows.
visible() - Method in class dev.xichil.mvui.Entry: Whether the entry has a row on the screen now: its own visible supplier, and for a child of a Section also whether the section is shown and expanded.
visible(BooleanSupplier) - Method in class dev.xichil.mvui.Entry.Builder: Shows the entry only while visible is true, re-read on every refresh.
visitButton(Button) - Method in interface dev.xichil.mvui.EntryVisitor: A push button; also a collapsible Section's header.
visitCheckbox(Checkbox) - Method in interface dev.xichil.mvui.EntryVisitor: A check box with its label to the right.
visitColorPicker(ColorPicker) - Method in interface dev.xichil.mvui.EntryVisitor: A color button with a swatch, opening an editor screen.
visitCycle(Cycle) - Method in interface dev.xichil.mvui.EntryVisitor: A button that steps through values, "label: value".
visitDropdown(Dropdown) - Method in interface dev.xichil.mvui.EntryVisitor: A button that opens a picker list, drawn like a Cycle.
visitKeybind(Keybind) - Method in interface dev.xichil.mvui.EntryVisitor: A key binding button.
visitLabel(Label) - Method in interface dev.xichil.mvui.EntryVisitor: A line of text; also a non-collapsible Section's header.
visitMultiLineInput(MultiLineInput) - Method in interface dev.xichil.mvui.EntryVisitor: A multi-line text box.
visitSelectList(SelectList) - Method in interface dev.xichil.mvui.EntryVisitor: A scrolling list of selectable rows.
visitSlider(Slider) - Method in interface dev.xichil.mvui.EntryVisitor: A slider over a number range.
visitStatusLine(StatusLine) - Method in interface dev.xichil.mvui.EntryVisitor: A line showing the result of the screen's last action.
visitTextInput(TextInput) - Method in interface dev.xichil.mvui.EntryVisitor: A one-line text field; also every NumberField (visited as its NumberField.input()).
visitToggle(Toggle) - Method in interface dev.xichil.mvui.EntryVisitor: An on/off button, "label: ON/OFF".

W

WARNING - Enum constant in enum class dev.xichil.mvui.StatusLine.Kind: An action did something the player should notice, or partly failed.
Where players find a registered menu - Section in class dev.xichil.mvui.MultiversionUi
Where the text lives - Section in class dev.xichil.mvui.TextInput
WORKING - Static variable in class dev.xichil.mvui.UiTexts: "Working…": what a screen shows while a UiHost.runAsync(Callable, BiConsumer) task runs.
wrapped() - Method in class dev.xichil.mvui.TextAreaModel.Line: True if the text goes on in the next line without a line break (word wrap).

Y

YES - Static variable in class dev.xichil.mvui.UiTexts: "Yes" (gui.yes): a ConfirmDialog's default yes label.
yesLabel() - Method in class dev.xichil.mvui.ConfirmDialog: The label of the "yes" button.
yesLabel(Text) - Method in class dev.xichil.mvui.ConfirmDialog.Builder: The "yes" button's label; UiTexts.YES by default.

A B C D E F G H I K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values