API reference
Every public class of Galdur UI, generated from the Javadoc. Only use com.galdurstudio.galdurui.api.*: internal.* can change in any version.
Galdur UI 0.1.0 · Minecraft 1.21.1 · 30 classes
api
api.anim
Animations: easing curves (GaldurEasing), animated
values (AnimatedValue) and the global switch the
player can turn off (GaldurAnimations).
api.layout
Layout building blocks, to combine with the vanilla layouts (LinearLayout,
FrameLayout, GridLayout).
Public API, stable within a major version. These classes extend vanilla classes, so a Mojang change there may force a new major version (see "Compatibility and versions" in the README).
api.menuclient & server
Slot menus, logic side (client and server): GaldurMenu
places slot grids and the player inventory and handles Shift-click. No client class is used, so
this package is safe on a dedicated server. Rendering is in
screen.
Public API, stable within a major version.
api.screen
Themed slot menu screens (client only):
GaldurContainerScreen displays any
AbstractContainerMenu, in particular a GaldurMenu.
Never reference this package from code loaded on a dedicated server.
Public API, stable within a major version.
api.text
Text helpers: abbreviated amounts, thousands separators (GaldurFormat,
plain Java) and the brand fonts (GaldurFonts).
Public API, stable within a major version.
api.theme
Theme access: colours and spacings read from assets/galdurui/theme.json, reloaded with
the game resources and overridable by a resource pack.
Public API, stable within a major version.
api.widget
Themed widgets: text and icon buttons, labels, checkboxes, scrolling lists, search fields, tabs,
progress bars, item slots and scrolling item grids. They extend AbstractWidget, so they
work in any vanilla screen and layout.
Public API, stable within a major version. A Mojang change to AbstractWidget may force
a new major version (see "Compatibility and versions" in the README).
api.window
Declarative windows: describe a screen in a few lines, without coordinates or a Screen
subclass.
Get a GaldurWindow from
GaldurLib.createWindow(), add elements, then open it.
Layout, theme and rendering are handled by the library. Every add... method returns a
handle that keeps the element state, before and after opening:
ElementHandle: enabled, visible, tooltip;CheckboxHandle: plus the checked state;RowHandle: elements side by side;ListHandle: lines and selection of a list;SearchHandle: text of a search field;TabsHandleandTabHandle: tabs, each filled like a window;ProgressHandle: progress and label of a bar.
Public API, stable within a major version.