123 releases
This release fixes some annoying bugs and adds new parameters to a Lua API.
emu.get_pref preferences ("caret_blink_time", "high_contrast", "reduced_motion")dialogs.show_notificationmemory.recompile)
Ugui prefix (non-runtime breaking)All ugui types now use the Ugui prefix (e.g., UguiToggleButton instead of ToggleButton).
UguiEnvironment changedThe deprecated UguiEnvironment.wheel has now been wholly removed. So has UguiEnvironment.is_primary_down.
Supply mouse_events instead; users will get a better scrolling experience and you don't have to register atwindowmessage :)
This release adds crazy ghost-related features, map file loading support, and even improves the accuracy of computed angles!
You can now record and playback ghosts (and object ghosts!) from the new Ghost tab. Huge thanks to Xander and Frame for their mountains of work on this!
Even if you don't need the new functionality, your TASes will automatically become faster just by updating :P
.map files. No changelog entry is available for this release.
ugui.PREFERS_REDUCED_MOTION.UguiControl.clip_children removedUguiControl.clip_children has been replaced by x_overflow and y_overflow. Use those, they're better in every way.
UguiControlugui.<type>_uids() functions removedThese functions have been removed.
All controls now consume only one (1) UID slot, which greatly simplifies UID accounting.
Negative UIDs are now forbidden.
If you were using negative UIDs, change them to positive values.
This doesn't affect cases where you're authoring and control and using the internal API.
UIDs are no longer scene-global, but scoped to their siblings, thereby making the following pattern legal:
ugui.panel({ uid = 1 }, function()
ugui.button({ uid = 1 }) -- ✅ allowed and unique! :D
ugui.button({ uid = 2 }) -- ✅ allowed and unique! :D
end))
ugui.panel({ uid = 2 }, function()
ugui.button({ uid = 1 }) -- ✅ allowed and unique! :D
ugui.button({ uid = 2 }) -- ✅ allowed and unique! :D
end))
No changelog entry is available for this release.
window control. opacity property to Control.ugui.DEBUG)colorpicker control.menu to only require one UID slotControl.context_menu and meta context menu resultstandard_styler.draw_rich_text now takes a parameter tableugui.standard_styler.draw_rich_text now accepts a single table instead of positional arguments. Move each argument into the matching named field (rectangle, align_x, align_y, text, color, visual_state, plaintext, font_name, font_size, wrap, fit, or clip). For example:
-ugui.standard_styler.draw_rich_text(rectangle, align_x, align_y, text, color, visual_state)
+ugui.standard_styler.draw_rich_text({
+ rectangle = rectangle,
+ align_x = align_x,
+ align_y = align_y,
+ text = text,
+ color = color,
+ visual_state = visual_state,
+})
standard_styler.draw_icon no longer has visual_state parameterThe visual_state parameter to standard_styler.draw_icon has been removed, and UguiNinesliceStyle was adjusted accordingly
to only have one rectangle per icon.
The following functions have been removed from the standard_styler:
draw_buttondraw_togglebuttondraw_carrousel_buttondraw_comboboxdraw_joystick_innerThe following functions have gained a new visual_state parameter:
draw_textboxdraw_joystickUguiDrawRichTextParams.visual_stateThe visual_state field was removed from UguiDrawRichTextParams.
If you were relying on ugui-side color lookps based on the visual state, do the lookup at the callsites.
ControlRegistryEntry.uids moved to ugui.<type>_uidsUID counts are now exposed through control-specific helpers, such as ugui.button_uids() instead of registry entries.
The menu control now has a static UID count, use just ugui.menu_uids().
The tabcontrol now requires only an item count to be passed in to the UID computation function, not an entire control instance.
ugui.control and ControlType removedugui.control and the ControlType type have been removed; use the specific control functions (e.g. ugui.button or ugui.label) instead.
If you need dynamic runtime lookup, write your own map of type strings to control functions.
Control type renamed to UguiControl (non-runtime breaking)The Control type has been renamed to UguiControl.
The control registry has been removed. Controls are now implemented using custom placement functions with per-instance callbacks.
This only affects API consumers who implement their own controls.
ControlRegistryEntry.setup moved to control placement
Use the fourth argument to ugui.internal.control in the contro's placement function instead.
ControlRegistryEntry.hittestable removed
Apply the default value in the control's placement function instead.
ControlRegistryEntry.added removed
There is no built-in alternative to this API. Try to write controls in a way that doesn't require this kind of lifecycle notification.
ControlRegistryEntry.validate removed
If you need to implement control validation, do it in the control's placement function, e.g.:
ControlRegistryEntry.logic moved to Control.get_return_value
Control logic is now provided by the per-instance Control.get_return_value callback instead of ControlRegistryEntry.logic.
ControlRegistryEntry.draw moved to Control.draw
Draw control graphics in the Control.draw callback instead.
Controls can now be nested, with child controls being positioned relative to their parents.
Many UI patterns benefit from establishing a hierarchy, so you'll want to check and introduce hierarchies where appropriate.
You can configure clipping behavior with Control.clip_children.
Some properties on Control are now inherited, read the API definition for more details.
The valid set of control types is no longer defined by ugui (cf. removal of ugui.control and ControlType).
Adding controls of arbitrary type to the registry is now fully supported, but note that this part of the public API is more volatile.
Context menus are now supported natively using Control.context_menu.
If you were reimplementing them by hiding/showing menus based on mouse clicks, you can remove that in favor of the built-in functionality.
tabcontrol contentThanks to the new control nesting, you can now display tabcontrol content simply by providing it with a child callback:
local result = ugui.tabcontrol({
uid = ...,
rectangle = ...,
items = ...,
selected_index = ...,
}, function()
ugui.panel({
uid = ...,
rectangle = {
x = 0,
y = 0,
width = 100,
height = 100,
},
fill = '#FF00FF55',
})
end)
Note that there is no way to determine the available dimensions for the content, as result is not available inside the callback.
No changelog entry is available for this release.
No changelog entry is available for this release.
Environment.scale in ugui.begin_frame).fill, stroke, stroke_style, and border_radius properties, as well as background support with various image properties.ControlRegistryEntry.uids() to retrieve the number of UID slots reserved by a control instance.mouse_events to Environment.ugui.DEBUG = true.wrap, clip, and fit parameters, including wrapping and fitting support for rich text.editable field.text_x_align.draw_image2.draw_list_item.draw_carrousel_button to avoid deep cloning.draw_list_item passing wrong data to draw_rich_text.draw_icon having the wrong path passed into them.ugui no longer requires an injected environment. This removes a layer of indirection and simplifies user code.
The following APIs have been removed:
ugui.STATIC_ENVUguiClipboardGetDelegateUguiClipboardSetDelegateUguiClipboardUguiVKeycodesRemove the ugui.STATIC_ENV setup from user code. Keycodes are now accessed through the global Mupen API, for example:
-ugui.keycodes.VK_F1
+Mupen.VKeycodes.VK_F1
Users running ugui outside a Mupen environment must implement the global API themselves.
carrousel_button.text clobbering (breaking)If user code was passing text into carrousel_button controls, remove it because the control now clobbers that value.
ugui has replaced various BreitbandGraphics types with ugui-specific equivalents:
Rectangle -> UguiRectVector2 -> UguiVector2Color -> UguiRGBA8ColorSource -> UguiColorSourceAlignment -> UguiAlignment, and BreitbandGraphics.alignment -> ugui.alignmentReplace references to these in your code if you're using them in a direct ugui context. If you're using the BreitbandGraphics types directly, you don't need to change anything.
This doesn't affect runtime behavior.
ugui no longer requires BreitbandGraphics.
If you were pulling it in only for ugui, but not using it directly, you can remove it from your project:
-BreitbandGraphics = dofile(folder .. 'breitbandgraphics-amalgamated.lua')
combobox now reserves 5 UID slots instead of 3. Adjust sequential UIDs accordingly if they're hardcoded. Prefer ugui.registry.combobox.uids() when allocating IDs.spinner is now a real control and reserves 4 UID slots. Adjust sequential UIDs accordingly if they're hardcoded. Prefer ugui.registry.spinner.uids() when allocating IDs.tabcontrol is now a real control and reserves one parent UID plus one UID per tab. Adjust sequential UIDs accordingly if they're hardcoded. Prefer ugui.registry.tabcontrol.uids(control) when allocating IDs.shift modifier must be provided in the environment passed to ugui.begin_frame:local mup_input = input.get()
ugui.begin_frame({ ..., shift = mup_input.shift })
Environment.wheel is deprecated in favor of Environment.mouse_events:+local stored_mouse_events = {}
emu.atpaint(function()
ugui.begin_frame({
- wheel = stored_wheel,
+ mouse_events = stored_mouse_events,
})
ugui.end_frame()
+ stored_mouse_events = {}
end)
+emu.atmouse(function(e)
+ stored_mouse_events[#stored_mouse_events + 1] = e
+end)
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.
No changelog entry is available for this release.