The Value property for entries won't update anymore until the save button is clicked. If you need to access the new value before it's been saved, you can get the EditedValue property instead.

Serialization and parsing is now handled by Tomlet. Anything Tomlet supports is now technically supported by UIFramework.

More details in the Type Support section

Just add [assembly: UIInfo("My Mod's Better\nDisplay Name")] to your assembly attributes to display your mod's name differently on its button in UI Framework. Yes, it supports line breaks

Entries with IsHidden set to true won't be listed in the preferences list anymore.

I came up with a system to use MelonLoader's custom validator feature to add extra UI configurations for entries. The new sliders and buttons feature are implemented through this system.

Modders can now implement sliders for numeric vlaues.

MySlider = Category.CreateEntry("MySlider", 0.5f, "My Slider", "Float Slider",false, false, new SliderDescriptor { Min = 0, Max = 1, DecimalPlaces = 3 });

Modders can now add their own buttons as entries into UI Framework.

UI.CreateButtonEntry(MelonPreferences_Category category, string buttonText, string displayName, string description, Action handler)

Go to Buttons for more details.

whoops

I somehow missed an entire boolean. Sorry Ulvak.

*^{This will only affect messages when you save or load through UI Framework. It will not suppress messages from melonloader itself when the game starts or closes.}

Support is no longer limited to the types mentioned above. Serialization and parsing is now handled by Tomlet. This means that it supports types described in Toml 1.0.0 and whatever Tomlet supports. You can even make your own custom mappers

Caveat: Types handled by Tomlet will be presented as regular text inputs and they might not always look good. Numerics will have the appropriate filters. I do plan to continue expanding the number of custom UI presenters like I did with enums and booleans.

Interaction Type Configuration

Validator Extension system

Melonloader has a custom validator feature that you can use by inheriting the ValueValidator class. Here's an example of a custom validator that approves everything.

public class CustomValidator : ValueValidator
{
    // These two are required members
    public override bool IsValid(object value) { return true; }
    public override object EnsureValid(object value) { return value; }
}

In UI Framework, we use this system to describe how the entry is represented in the UI. This is done through implementing interfaces in the UIFramework.ValidationExtensions namespace.

UI Framework's ValidationControls namespace contains interfaces you can implement into your validator class. Each interface has required member implementations. So, if you want a slider, the declaration for your validator becomes

using UIFramework.ValidationExtensions;
public class CustomValidator : ValueValidator, SliderDescriptor
{
    // These two are required members from MelonPreferences Value Validator. 
    // You can implement actual validators here or just return true and return the same value
    public override bool IsValid(object value) { return true; }
	public override object EnsureValid(object value) { return value; }

    //You can set default values or set them when you pass a new instance into the validator parameter
    public float Min { get; set; } = 0;
    public float Max { get; set; } = 100; 
    public int DecimalPlaces { get; set; } = 5
}

Now, when you create your entry, you can pass a new instance of your validator with the appropriate properties set for the slider to be represented in the UI:

MySlider = Category.CreateEntry("MySlider", 0.5f, "My Slider", "Float Slider",false, false, new SliderDescriptor { Min = 0, Max = 1, DecimalPlaces = 3 });

Most interfaces haven't been implemented yet but I will list the available ones below as they get added

I will also have a default concrete class for most interfaces that has the required members implemented so you can just set the properties when you create a new instance of the class instead of having to make your own validator class.

Sliders

Interface: ISliderDescriptor

Default extended validator: SliderDescriptor

The UI will represent your entry with a slider if you add a validator that implements SliderDescriptor.

MySlider = Category.CreateEntry("MySlider", 0.5f, "My Slider", "Float Slider",false, false, new SliderDescriptor { Min = 0, Max = 1, DecimalPlaces = 3 });

Buttons

Interface: IButtonDescriptor

Default extended validator: ButtonAsEntry (internal)

This is a special case. You don't need to implement this yourself. Instead, you call

UI.CreateButtonEntry(MelonPreferences_Category category, string buttonText, string displayName, string description, Action handler)

This method will handle the implementation for you and it will show the button in the entries list.

Combined with the previous new feature, you can now adjust your UI according to your users' inputs

The following example uses it to change the visibility of certain categories based on user input without them having to hit save

//Create a method you can pass as a delegate
internal static void UpdateCategoryVis(object newValue)
{
    Experimental.IsHidden = !(bool)newValue;
    TestBooleans.IsHidden = !(bool)newValue;
    TestEmptyDisplayName.IsHidden = !(bool)newValue;
}

Create a new instance of UserEditNotifier and set this as the action for OnUserEdit

EnableDebugMode = CatUIFramework.CreateEntry("EnableDebugMode", false, "Enable Debug Logs", "Enables or disables debug logs for UIFramework.", false, false, new UserEditNotifier { OnUserEdit = UpdateCategoryVis });

Just call UI.RequestRefresh(modInstance)

Create an items list

// It takes a list of DropdownItems which take a string as a display name, and a value of type object 
List<DropdownItem> itemList = new();

Create an instance of the DynamicDropdownDescriptor class passing the item list as a parameter in the constructor

public static DynamicDropdownDescriptor DropdownDescriptor = new(itemList);

Add items with

DropdownDescriptor.AddDropdownItem(new DropdownItem("Display Name", value)); 

or declare a list separately and set it with SetDropdownItems

Pass it into the CreateEntry validator parameter

DropdownTest = Category.CreateEntry("DropdownTest", -1, "Dropdown Test", "Dynamic dropdown test.", false, false, DropdownDescriptor);

The UI window is now draggable by the title bar.

If ModUI is enabled, and it has the VR Menu Toggle setting enabled, UI Framework will follow ModUI's visibility. If ModUI is visible (when the VR toggle is pressed), UI Framework will also be visible and vice versa. If you don't have ModUI or the setting is off, UI Framework will toggle normally with the VR toggle.

The toggle with VR buttons preference is also no longer a thing. A new preference is added for toggling with VR, keyboard, or both.

The Value property for entries won't update anymore until the save button is clicked. If you need to access the new value before it's been saved, you can get the EditedValue property instead.

Serialization and parsing is now handled by Tomlet. Anything Tomlet supports is now technically supported by UIFramework.

More details in the Type Support section

Just add [assembly: UIInfo("My Mod's Better\nDisplay Name")] to your assembly attributes to display your mod's name differently on its button in UI Framework. Yes, it supports line breaks

Entries with IsHidden set to true won't be listed in the preferences list anymore.

I came up with a system to use MelonLoader's custom validator feature to add extra UI configurations for entries. The new sliders and buttons feature are implemented through this system.

Modders can now implement sliders for numeric vlaues.

MySlider = Category.CreateEntry("MySlider", 0.5f, "My Slider", "Float Slider",false, false, new SliderDescriptor { Min = 0, Max = 1, DecimalPlaces = 3 });

Modders can now add their own buttons as entries into UI Framework.

UI.CreateButtonEntry(MelonPreferences_Category category, string buttonText, string displayName, string description, Action handler)

Go to Buttons for more details.

whoops

I somehow missed an entire boolean. Sorry Ulvak.

*^{This will only affect messages when you save or load through UI Framework. It will not suppress messages from melonloader itself when the game starts or closes.}

^{I did have to change the .Register() function's signature. Right now, I have an overload for the old function for backwards compatibility. More details at the bottom of the page}

You can now subscribe to the OnModSaved event that triggers when the saved button is clicked while your mod is selected. This is an alternative for OnPreferencesSaved from MelonPreferences which gets called per category. This one is called once and only if your mod is selected.

UI.Register(this, OBSAutoRecorderSettings, TestCategory1, TestCategory2...).OnModSaved += MyModSaved;

^{*btw while text wrapping is disabled in mod list buttons, your MelonInfo name property does support spaces and line breaks that you can add manually if your mod name is still too long to fit into one line}

Comes with new settings:

• Auto Hide on Inactivity
• Inactivity Timeout

Made discard button visible to load the saved values from the preferences file