Table of Contents

Namespace OnixRuntime.Api.OnixClient.Settings

Classes

InvalidOnixEnumValueException

Exception thrown when an invalid value is set for an Onix enum setting.

OnixSettingAir

Represents an Onix setting for air, allowing getting and setting the air value for a module.

OnixSettingBool

Represents an Onix setting for a boolean value, allowing getting and setting the value and default for a module.

OnixSettingButton

Represents an Onix setting for a button, allowing configuration of button text and click behavior for a module.

OnixSettingCategory

Represents an Onix setting category, allowing grouping of settings with control over included count and open state.

OnixSettingColor

Represents an Onix setting for a color value, supporting advanced options like opacity, rainbow, and chroma effects.

OnixSettingColor.ValueType

Represents the value type for a color setting, including color, opacity, rainbow, and chroma options.

OnixSettingColor.ValueTypeMutable

Represents the value type for a color setting, including color, opacity, rainbow, and chroma options.

OnixSettingColor_ValueTypeConverter
OnixSettingColor_ValueTypeMutableConverter

Provides functionality to convert JSON data to and from instances of OnixSettingColor.ValueTypeMutable.

OnixSettingCustom

Represents a custom Onix setting, allowing creation of settings with user-defined types registered in the setting registry.

OnixSettingEnum

Represents an enum setting.

OnixSettingEnum.EnumEntries

Represents a collection of enum entries, adding some convenience function.

OnixSettingEnum.EnumEntry

Represents an entry in an enum setting.

OnixSettingFloat

Represents a float setting in Onix, allowing configuration of value, default, min, and max.

OnixSettingGamepadKeybind

Represents a setting containing a list of gamepad keys in Onix.

OnixSettingGamepadKeybind.ValueType

Represents a read-only collection of InputKey values and provides convenience methods for working with key combinations.

OnixSettingInfo

Adds basically text as a setting.

OnixSettingInt

Represents an integer setting in Onix, allowing configuration of value, default, min, and max.

OnixSettingKeybind

Represents a keybind setting in Onix, allowing configuration of a single key value and its default.

OnixSettingLocalizedInfo

This is mainly so you can read the text from the settings, there is no benefit from C# in using this one over OnixSettingInfo.

OnixSettingModuleHeader

This is just used internally to show the header. Use the ParentModule to get the module. Modules come with one by default so you should never need to create one.

OnixSettingTextbox

Represents a textbox setting in Onix, allowing configuration of text value, default, and maximum length.

OnixSettingValueAdapterColorF
OnixSettingValueAdapterColorValue
OnixSettingValueAdapterEnum
OnixSettingVec2

Represents a Vec2 setting in Onix, allowing configuration of value, default, min, and max.