MoulConfig

https://notenoughupdates.org/MoulConfig/
Admin
MoulConfig is a mod configuration GUI framework for Minecraft mods that provides automated...
Tokens:186,653
Snippets:1,991
Trust Score:4.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### getInstance

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the singleton instance of IMinecraft.

```APIDOC
## getInstance

### Description
Retrieves the singleton instance of the IMinecraft interface.

### Method
open fun getInstance(): IMinecraft

### Returns
- IMinecraft - The singleton instance.
```

--------------------------------

### LerpingInteger2 Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-lerping-integer2/index.html

Initializes a new instance of the LerpingInteger2 class with a starting value, speed, and scale.

```APIDOC
## Constructor LerpingInteger2

### Description
Initializes a new instance of the LerpingInteger2 class.

### Parameters
- **value** (Int) - The initial integer value.
- **speed** (Int) - The speed of interpolation.
- **scale** (Int) - The scale factor for interpolation.
```

--------------------------------

### get()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-init-util/-throwing-supplier/index.html

Abstract function to get a value, potentially throwing a Throwable.

```APIDOC
## get()

### Description
Abstract function to get a value. This supplier can throw a Throwable.

### Signature
```kotlin
abstract fun get(): T
```

### Returns
The result of the supplier.

### Throws
Potentially a `Throwable`.
```

--------------------------------

### beginConfig

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-config-structure-reader/begin-config.html

Initializes the configuration process with the provided configuration class, driver, and an existing configuration object.

```APIDOC
## beginConfig

### Description
Initializes the configuration process. This function takes the configuration class, a driver to process the configuration, and an existing configuration object to start with.

### Method Signature
`open fun beginConfig(configClass: Class<out Config>, driver: ConfigProcessorDriver, configObject: Config)`

### Parameters
- **configClass** (Class<out Config>) - The class of the configuration to be processed.
- **driver** (ConfigProcessorDriver) - The driver responsible for processing the configuration.
- **configObject** (Config) - The existing configuration object to initialize with.
```

--------------------------------

### beginCategory

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-config-structure-reader/begin-category.html

Initiates a new configuration category with a base object, field, name, and description.

```APIDOC
## beginCategory

### Description
Starts a new category in the configuration structure. This function is typically used to group related configuration options.

### Signature
abstract fun beginCategory( baseObject: Any, field: Field, name: String, description: String)

### Parameters
- **baseObject** (Any) - The base object for this category.
- **field** (Field) - The field associated with this category.
- **name** (String) - The name of the category.
- **description** (String) - A description for the category.
```

--------------------------------

### getChildCount

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-scroll-panel-loader/index.html

Gets the child count of the ScrollPanelLoader.

```APIDOC
## getChildCount

### Description
Gets the child count of the ScrollPanelLoader.

### Signature
open fun getChildCount(): @NotNull ChildCount

### Returns
@NotNull ChildCount - The count of children.

```

--------------------------------

### acceptOptions

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.tweaker/-development-resource-tweaker/index.html

Accepts the launch options provided to the tweaker.

```APIDOC
## Function: acceptOptions

### Signature

```kotlin
open fun acceptOptions(args: List<String>, gameDir: File, assetsDir: File, profile: String)
```

### Description

This function is called to accept the launch options provided to the tweaker. It receives the command-line arguments, game directory, assets directory, and profile name.
```

--------------------------------

### get

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.observer/-observable/index.html

Retrieves the current value of the observable.

```APIDOC
## get

### Description
Gets the current value of the observable.

### Method
`abstract fun get(): T`

### Returns
- **T** - The current value of the observable.
```

--------------------------------

### beginAccordion Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-moul-config-processor/begin-accordion.html

The beginAccordion function is part of the MoulConfigProcessor and is used to start an accordion section. It takes the base object, field, configuration option, and an ID as parameters.

```APIDOC
## beginAccordion

### Description
Initiates an accordion component within the MoulConfig system.

### Signature
`open fun beginAccordion(baseObject: Any, field: Field, option: ConfigOption, id: Int)`

### Parameters
- **baseObject** (Any) - The base object for the configuration.
- **field** (Field) - The field associated with the accordion.
- **option** (ConfigOption) - The configuration option for the accordion.
- **id** (Int) - A unique identifier for the accordion.
```

--------------------------------

### getLaunchArguments

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.tweaker/-development-resource-tweaker/index.html

Retrieves the launch arguments for the game.

```APIDOC
## Function: getLaunchArguments

### Signature

```kotlin
open fun getLaunchArguments(): Array<String>
```

### Description

Returns an array of strings representing the launch arguments for the game. These arguments are typically used to configure the game's startup process.
```

--------------------------------

### getWidth

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-center-component/index.html

Gets the requested width for this element.

```APIDOC
## getWidth

### Description
Returns the requested horizontal size (width) for this `CenterComponent`.

### Signature
```java
int getWidth()
```
```

--------------------------------

### withDefaults

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-moul-config-processor/with-defaults.html

Creates a new MoulConfigProcessor instance with default settings applied based on the provided configuration object.

```APIDOC
## withDefaults

### Description
Applies default values to a configuration object and returns a `MoulConfigProcessor`.

### Signature
```kotlin
open fun <T : Config?> withDefaults(configBaseObject: T): MoulConfigProcessor<T>
```

### Parameters
* `configBaseObject` (T) - The configuration object to which defaults will be applied.
```

--------------------------------

### getHeight

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-center-component/index.html

Gets the requested height for this element.

```APIDOC
## getHeight

### Description
Returns the requested vertical size (height) for this `CenterComponent`.

### Signature
```java
int getHeight()
```
```

--------------------------------

### beginConfig

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-moul-config-processor/index.html

Initiates the processing of a configuration class.

```APIDOC
## beginConfig

### Description
Starts the configuration processing for a given configuration class.

### Signature
open fun beginConfig(configClass: Class<out Config>, driver: ConfigProcessorDriver, configObject: Config)

### Parameters
- **configClass** (Class<out Config>) - The class of the configuration to process.
- **driver** (ConfigProcessorDriver) - The driver used for processing the configuration.
- **configObject** (Config) - The configuration object instance.
```

--------------------------------

### getKeyName

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the string representation of a key code.

```APIDOC
## getKeyName

### Description
Converts a given key code into its string representation.

### Function
`open override fun getKeyName(keyCode: Int): StructuredText`

### Parameters
- `keyCode` (Int) - The integer code of the key.

### Returns
`StructuredText` - The string representation of the key.
```

--------------------------------

### GuiImmediateContext Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-immediate-context/index.html

Initializes a new GuiImmediateContext with rendering context and UI state information.

```APIDOC
## GuiImmediateContext Constructor

### Description
Initializes a new GuiImmediateContext with the provided rendering context, offsets, dimensions, and mouse coordinates.

### Parameters
- **renderContext** (RenderContext) - The rendering context.
- **renderOffsetX** (Int) - The X offset for rendering.
- **renderOffsetY** (Int) - The Y offset for rendering.
- **width** (Int) - The available width for the GUI element.
- **height** (Int) - The available height for the GUI element.
- **mouseX** (Int) - The mouse X position relative to the GUI element.
- **mouseY** (Int) - The mouse Y position relative to the GUI element.
- **absoluteMouseX** (Int) - The absolute mouse X position.
- **absoluteMouseY** (Int) - The absolute mouse Y position.
- **mouseXHF** (Float) - The high-resolution mouse X position.
- **mouseYHF** (Float) - The high-resolution mouse Y position.
```

--------------------------------

### getVerticalHeight

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-text-render-utils/index.html

Gets the total vertical height of a string.

```APIDOC
## getVerticalHeight

### Description
Gets the total vertical height of a string.

### Parameters
- **str** (String) - The string to measure.

### Returns
- **Float** - The total vertical height of the string.
```

--------------------------------

### GuiContext Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-context/index.html

Initializes a new GuiContext with a specified root GUI component.

```APIDOC
## GuiContext Constructor

### Description
Initializes a new GuiContext with a specified root GUI component.

### Signature
constructor(root: GuiComponent)
```

--------------------------------

### getCharVertLen

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-text-render-utils/index.html

Gets the vertical length of a single character.

```APIDOC
## getCharVertLen

### Description
Gets the vertical length of a character.

### Parameters
- **c** (Char) - The character to measure.

### Returns
- **Int** - The vertical length of the character.
```

--------------------------------

### create

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.managed/-managed-config/-companion/index.html

Creates a new ManagedConfig instance from a file, with optional configuration.

```APIDOC
## create

### Description
Creates a new ManagedConfig instance from a file. It takes the file path, the configuration class, and an optional builder lambda to configure the instance.

### Method
`fun <T : Config> create(file: File, clazz: Class<T>, consumer: ManagedConfigBuilder<T>.() -> Unit = {}): ManagedConfig<T>`

### Parameters
#### Path Parameters
- **file** (File) - Required - The configuration file.
- **clazz** (Class<T>) - Required - The class of the configuration.

#### Query Parameters
- **consumer** (ManagedConfigBuilder<T>.() -> Unit) - Optional - A lambda function to configure the ManagedConfigBuilder.
```

--------------------------------

### context Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.gui/-gui-component-wrapper/index.html

Gets the GuiContext associated with this GuiComponentWrapper.

```APIDOC
## context Property

### Description
Represents the GUI context associated with this component wrapper.

### Type
GuiContext
```

--------------------------------

### element Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.gui/-gui-screen-element-wrapper/index.html

Gets the GuiElement wrapped by this GuiScreenElementWrapper.

```APIDOC
## element Property

### Description
Gets the GuiElement that this wrapper is associated with.

### Type
GuiElement
```

--------------------------------

### openConfigGui()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.managed/-managed-config/index.html

Opens the graphical user interface for configuring the settings.

```APIDOC
## openConfigGui()

### Description
Opens the graphical user interface for editing the configuration.

### Usage
This function can be called to display the configuration options to the user.
```

--------------------------------

### ColourUtil Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-colour-util/index.html

Initializes a new instance of the ColourUtil class.

```APIDOC
## ColourUtil()

### Description
Constructs a new ColourUtil object.

### Parameters
None
```

--------------------------------

### getPropertyFinder

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml/-x-m-l-universe/index.html

Gets a property finder for a given class.

```APIDOC
## getPropertyFinder

### Description
Obtains a utility for finding and accessing properties of a specific class.

### Method
getPropertyFinder(clazz: Class<out Any>): XMLBoundProperties

### Parameters
- **clazz** (Class<out Any>) - The class for which to get the property finder.

### Returns
XMLBoundProperties - An object capable of finding properties within the specified class.
```

--------------------------------

### createInstance

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml/-x-m-l-gui-loader/index.html

Creates an instance of a GUI component based on the provided XML context and element.

```APIDOC
## createInstance

### Description
Creates an instance of a GUI component.

### Method Signature
```java
abstract fun createInstance(@NotNull context: @NotNull XMLContext<out Any>, @NotNull element: @NotNull Element): @NotNull T
```

### Parameters
*   **context** (@NotNull XMLContext<out Any>) - The XML context.
*   **element** (@NotNull Element) - The XML element to process.
```

--------------------------------

### get

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.observer/-observable-list/index.html

Retrieves the element at the specified index in the list.

```APIDOC
## get

### Description
Retrieves the element at the specified index in the list.

### Signature
open fun get(index: Int): T

```

--------------------------------

### get

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.observer/-get-setter/index.html

Retrieves the current value held by the GetSetter.

```APIDOC
## get

### Description
Get the value.

### Signature
`abstract fun get(): T`
```

--------------------------------

### IMinecraft Instance

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Access the singleton instance of the IMinecraft interface.

```APIDOC
## IMinecraft INSTANCE

### Description
Provides access to the singleton instance of the IMinecraft interface.

### Property
- **INSTANCE** (IMinecraft) - The singleton instance of IMinecraft.
```

--------------------------------

### getChildOffsetY

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-center-component/index.html

Gets the offset Y coordinate for the child component.

```APIDOC
## getChildOffsetY

### Description
Retrieves the vertical offset of the child component within the `CenterComponent`.

### Signature
```java
int getChildOffsetY(GuiImmediateContext context)
```

### Parameters
* **context** (`GuiImmediateContext`) - The rendering context.
```

--------------------------------

### render(renderContext, x, y, width)

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.gui.editors/-gui-option-editor-keybind-l/index.html

Renders the keybind editor UI.

```APIDOC
## render(renderContext, x, y, width)

### Description
Renders the keybind editor UI.

### Parameters
- **renderContext** (RenderContext) - The rendering context.
- **x** (Int) - The x-coordinate for rendering.
- **y** (Int) - The y-coordinate for rendering.
- **width** (Int) - The width for rendering.
```

--------------------------------

### getScaledWidth

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the scaled width of the Minecraft window.

```APIDOC
## getScaledWidth

### Description
Retrieves the current scaled width of the Minecraft game window.

### Method
abstract fun getScaledWidth(): Int

### Returns
- Int - The scaled width.
```

--------------------------------

### load(bind: Any, location: MyResourceLocation)

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml/-x-m-l-universe/load.html

Loads a GuiComponent from a specified resource location, binding it to a given object.

```APIDOC
## load(bind: Any, location: MyResourceLocation)

### Description
Loads a GuiComponent from a resource identified by MyResourceLocation. The loaded component will be bound to the provided 'bind' object.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **bind** (Any) - The object to which the loaded component will be bound.
- **location** (MyResourceLocation) - The resource location of the XML configuration.

### Request Example
```kotlin
// Example usage (conceptual)
val component = xmlUniverse.load(myObject, MyResourceLocation("path/to/config.xml"))
```

### Response
#### Success Response (GuiComponent)
- Returns the loaded GuiComponent.

#### Response Example
```kotlin
// Conceptual representation of a GuiComponent
{
  "type": "GuiComponent"
}
```
```

--------------------------------

### addExtraBuiltinConfigProcessors

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/add-extra-builtin-config-processors.html

This method is used to register a new configuration processor with the game's configuration system. It takes a processor instance as input and makes it available for use.

```APIDOC
## addExtraBuiltinConfigProcessors
abstract fun addExtraBuiltinConfigProcessors(processor: MoulConfigProcessor<out Any>)(source)
```

--------------------------------

### getScaledHeight

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the scaled height of the Minecraft window.

```APIDOC
## getScaledHeight

### Description
Retrieves the current scaled height of the Minecraft game window.

### Method
abstract fun getScaledHeight(): Int

### Returns
- Int - The scaled height.
```

--------------------------------

### getMouseY

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse Y-coordinate as an integer.

```APIDOC
## getMouseY

### Description
Retrieves the current vertical (Y) coordinate of the mouse cursor as an integer.

### Method
open fun getMouseY(): Int

### Returns
- Int - The integer Y-coordinate of the mouse.
```

--------------------------------

### acceptOptions Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.tweaker/-development-resource-tweaker/accept-options.html

The acceptOptions function takes a list of string arguments, a game directory, an assets directory, and a profile string to configure development resources.

```APIDOC
## acceptOptions

### Description
Processes and accepts configuration options for development resources.

### Signature
`open fun acceptOptions(args: List<String>, gameDir: File, assetsDir: File, profile: String)`

### Parameters
#### Path Parameters
- **args** (List<String>) - A list of string arguments.
- **gameDir** (File) - The directory of the game.
- **assetsDir** (File) - The directory for assets.
- **profile** (String) - The configuration profile to use.
```

--------------------------------

### getMouseX

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse X-coordinate as an integer.

```APIDOC
## getMouseX

### Description
Retrieves the current horizontal (X) coordinate of the mouse cursor as an integer.

### Method
open fun getMouseX(): Int

### Returns
- Int - The integer X-coordinate of the mouse.
```

--------------------------------

### Config Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-config/index.html

Initializes a new instance of the Config class.

```APIDOC
## Constructor

### Description
Initializes a new instance of the Config class.

### Signature
```kotlin
constructor()
```
```

--------------------------------

### getKeyName

Source: https://notenoughupdates.org/MoulConfig/javadocs/modern/io.github.notenoughupdates.moulconfig.platform/-moul-config-platform/index.html

Gets the name of a key based on its key code.

```APIDOC
## Function: getKeyName

### Description
Gets the name of a key associated with a given key code.

### Signature
`open fun getKeyName(keyCode: Int): StructuredText`

### Parameters
- **keyCode** (Int) - The integer code of the key.

### Returns
`StructuredText` - The structured text representation of the key name.
```

--------------------------------

### InitUtil

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/index.html

Utility class for initialization operations.

```APIDOC
## Class: InitUtil

### Description
Utility class for initialization operations.

### Type
open class
```

--------------------------------

### getName Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-basic-collapsible-loader/index.html

Gets the qualified name of the collapsible component.

```APIDOC
## getName

### Description
Gets the qualified name of the collapsible component.

### Method
open override fun getName(): QName
```

--------------------------------

### GuiLoader Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-gui-loader/index.html

Initializes a new instance of the GuiLoader class.

```APIDOC
## GuiLoader()

### Description
Constructs a new GuiLoader.

### Constructor
GuiLoader()
```

--------------------------------

### getChildCount Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-basic-collapsible-loader/index.html

Gets the child count for the collapsible component.

```APIDOC
## getChildCount

### Description
Gets the child count for the collapsible component.

### Method
open override fun getChildCount(): ChildCount
```

--------------------------------

### GuiOptionEditor Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-option-editor/index.html

Initializes a new instance of the GuiOptionEditor class.

```APIDOC
## GuiOptionEditor Constructor

### Description
Initializes a new instance of the GuiOptionEditor class.

### Parameters
- **option** (ProcessedOption) - The processed configuration option to be edited.
```

--------------------------------

### ColorSelectComponent Constructors

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-color-select-component/index.html

Provides information on how to instantiate the ColorSelectComponent with different configuration options.

```APIDOC
## ColorSelectComponent Constructor 1

### Description
Initializes a new instance of the ColorSelectComponent with basic configuration.

### Parameters
- **x** (Int) - The x-coordinate of the component.
- **y** (Int) - The y-coordinate of the component.
- **initialColour** (String) - The initial color value.
- **colourChangedCallback** (Consumer<String>) - A callback function executed when the color changes.
- **closeCallback** (Runnable) - A callback function executed when the component is closed.

## ColorSelectComponent Constructor 2

### Description
Initializes a new instance of the ColorSelectComponent with extended configuration, including opacity and value sliders.

### Parameters
- **x** (Int) - The x-coordinate of the component.
- **y** (Int) - The y-coordinate of the component.
- **initialColour** (String) - The initial color value.
- **colourChangedCallback** (Consumer<String>) - A callback function executed when the color changes.
- **closeCallback** (Runnable) - A callback function executed when the component is closed.
- **opacitySlider** (Boolean) - Whether to include an opacity slider.
- **valueSlider** (Boolean) - Whether to include a value slider.
```

--------------------------------

### getAttributeNames Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-basic-collapsible-loader/index.html

Gets the attribute names for the collapsible component.

```APIDOC
## getAttributeNames

### Description
Gets the attribute names for the collapsible component.

### Method
open override fun getAttributeNames(): Map<String, Boolean>
```

--------------------------------

### value Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-lerping-integer2/index.html

Gets the current interpolated integer value.

```APIDOC
## Property value

### Description
Gets the current interpolated integer value.

### Type
Int
```

--------------------------------

### KeybindHelper Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-keybind-helper/index.html

Initializes a new instance of the KeybindHelper class.

```APIDOC
## Constructor

### Signature
KeybindHelper()

### Description
Initializes a new instance of the KeybindHelper class.
```

--------------------------------

### Input and Utility Methods

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-render-context/index.html

Methods for checking keyboard and mouse input, and accessing Minecraft instance.

```APIDOC
## getMinecraft

### Description
Returns the Minecraft instance.

### Method
open fun getMinecraft(): IMinecraft

## isCmdDown

### Description
Checks if the Command key is pressed.

### Method
open fun isCmdDown(): Boolean

## isKeyboardKeyDown

### Description
Checks if a specific keyboard key is pressed.

### Parameters
#### Path Parameters
- **keyboardKey** (Int) - The key code to check.

### Method
open fun isKeyboardKeyDown(keyboardKey: Int): Boolean

## isLogicalCtrlDown

### Description
Returns whether the control key is held down on Windows and Linux, and for macOS checks if the command key is held down.

### Method
open fun isLogicalCtrlDown(): Boolean

## isMouseButtonDown

### Description
Checks if a specific mouse button is pressed.

### Parameters
#### Path Parameters
- **mouseButton** (Int) - The mouse button to check.

### Method
open fun isMouseButtonDown(mouseButton: Int): Boolean

## isPhysicalCtrlDown

### Description
Checks if the physical Control key is pressed.

### Method
open fun isPhysicalCtrlDown(): Boolean

## isShiftDown

### Description
Checks if the Shift key is pressed.

### Method
open fun isShiftDown(): Boolean
```

--------------------------------

### getChildOffsetX

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-center-component/index.html

Gets the offset X coordinate for the child component.

```APIDOC
## getChildOffsetX

### Description
Retrieves the horizontal offset of the child component within the `CenterComponent`.

### Signature
```java
int getChildOffsetX(GuiImmediateContext context)
```

### Parameters
* **context** (`GuiImmediateContext`) - The rendering context.
```

--------------------------------

### UnboxGetSetter Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.trans/-unbox-get-setter/index.html

Initializes a new instance of the UnboxGetSetter class.

```APIDOC
## UnboxGetSetter()

### Description
Constructs an UnboxGetSetter instance.

### Constructor
`UnboxGetSetter()`
```

--------------------------------

### getScaleFactor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current scale factor of the Minecraft interface.

```APIDOC
## getScaleFactor

### Description
Retrieves the current scale factor applied to the Minecraft user interface.

### Method
abstract fun getScaleFactor(): Int

### Returns
- Int - The scale factor.
```

--------------------------------

### render()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-element-component/index.html

Renders the GuiElementComponent within the given GUI context.

```APIDOC
## render()

### Description
Called by the parent renderer to render the component.

### Signature
open fun render(@NotNull context: @NotNull GuiImmediateContext)

### Parameters
- **context** (@NotNull GuiImmediateContext) - The current GUI rendering context.

```

--------------------------------

### getMousePosition

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse position as a pair of integers.

```APIDOC
## getMousePosition

### Description
Retrieves the current mouse cursor position in integer coordinates.

### Method
open fun getMousePosition(): Pair<Integer, Integer>

### Returns
- Pair<Integer, Integer> - A pair representing the X and Y coordinates of the mouse.
```

--------------------------------

### getKeyName

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the structured text representation of a key code.

```APIDOC
## getKeyName

### Description
Converts a given key code into its structured text representation.

### Method
abstract fun getKeyName(keyCode: Int): StructuredText

### Parameters
- **keyCode** (Int) - The integer code of the key.

### Returns
- StructuredText - The structured text representation of the key name.
```

--------------------------------

### MathUtil Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-math-util/index.html

Initializes a new instance of the MathUtil class.

```APIDOC
## MathUtil()

### Description
Constructs a new MathUtil object.

### Constructor
`MathUtil()`
```

--------------------------------

### LegacyStringChromaColourTypeAdapter Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-legacy-string-chroma-colour-type-adapter/index.html

Initializes a new instance of the LegacyStringChromaColourTypeAdapter.

```APIDOC
## LegacyStringChromaColourTypeAdapter()

### Description
Constructs a new LegacyStringChromaColourTypeAdapter.

### Method
constructor()

```

--------------------------------

### saveRunnables Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-config/index.html

Gets or sets the list of runnables to be saved.

```APIDOC
## saveRunnables Property

### Description
Represents the list of runnables that can be saved.

### Type
`List<Runnable>`
```

--------------------------------

### scaledWidth Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the scaled width of the Minecraft game window.

```APIDOC
## scaledWidth

### Description
Returns the current scaled width of the game window.

### Property
`open override val scaledWidth: Int`
```

--------------------------------

### renderOverlay

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-option-editor/render-overlay.html

Renders the GUI option with the provided context and dimensions.

```APIDOC
## renderOverlay

### Description
Renders the GUI option with the provided context and dimensions.

### Signature
open fun renderOverlay(renderContext: RenderContext, x: Int, y: Int, width: Int)

### Parameters
* `renderContext` (RenderContext) - The context for rendering.
* `x` (Int) - The x-coordinate for rendering.
* `y` (Int) - The y-coordinate for rendering.
* `width` (Int) - The width for rendering.
```

--------------------------------

### scaledHeight Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the scaled height of the Minecraft game window.

```APIDOC
## scaledHeight

### Description
Returns the current scaled height of the game window.

### Property
`open override val scaledHeight: Int`
```

--------------------------------

### GuiOptionEditorKeybindL Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.gui.editors/-gui-option-editor-keybind-l/index.html

Initializes a new instance of the GuiOptionEditorKeybindL class.

```APIDOC
## GuiOptionEditorKeybindL Constructor

### Description
Initializes a new instance of the GuiOptionEditorKeybindL class.

### Parameters
- **option** (ProcessedOption) - The processed option to be edited.
- **defaultKeyCode** (Int) - The default key code for the keybind.
```

--------------------------------

### defaultFontRenderer Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the default font renderer used by Minecraft.

```APIDOC
## defaultFontRenderer

### Description
Provides access to the default `IFontRenderer` instance.

### Property
`open override val defaultFontRenderer: IFontRenderer`
```

--------------------------------

### beginAccordion

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-config-structure-reader/begin-accordion.html

Initiates an accordion section for configuration options. This function is part of the ConfigStructureReader and is used to group related configuration fields within an expandable accordion UI element.

```APIDOC
## beginAccordion

### Description
Initiates an accordion section for configuration options. This function is part of the ConfigStructureReader and is used to group related configuration fields within an expandable accordion UI element.

### Method Signature
abstract fun beginAccordion( baseObject: Any,  field: Field,  option: ConfigOption,  id: Int)

### Parameters
- **baseObject** (Any) - The base object associated with the configuration.
- **field** (Field) - The configuration field to be placed within the accordion.
- **option** (ConfigOption) - The configuration option related to the accordion.
- **id** (Int) - A unique identifier for the accordion section.
```

--------------------------------

### MoulConfigProcessor Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-moul-config-processor/index.html

Initializes a new instance of the MoulConfigProcessor class.

```APIDOC
## MoulConfigProcessor Constructor

### Description
Initializes a new instance of the MoulConfigProcessor class with a given configuration base object.

### Signature
constructor(configBaseObject: T)

### Parameters
- **configBaseObject** (T) - The base object for the configuration.
```

--------------------------------

### getMouseYHF

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse Y-coordinate with high-precision floating-point value.

```APIDOC
## getMouseYHF

### Description
Retrieves the current vertical (Y) coordinate of the mouse cursor using a high-precision floating-point value.

### Method
open fun getMouseYHF(): Double

### Returns
- Double - The high-precision floating-point Y-coordinate of the mouse.
```

--------------------------------

### ButtonLoader Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-button-loader/index.html

Initializes a new instance of the ButtonLoader class.

```APIDOC
## ButtonLoader()

### Description
Initializes a new instance of the ButtonLoader class.

### Constructor
ButtonLoader()
```

--------------------------------

### getMouseXHF

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse X-coordinate with high-precision floating-point value.

```APIDOC
## getMouseXHF

### Description
Retrieves the current horizontal (X) coordinate of the mouse cursor using a high-precision floating-point value.

### Method
open fun getMouseXHF(): Double

### Returns
- Double - The high-precision floating-point X-coordinate of the mouse.
```

--------------------------------

### getMousePositionHF

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-i-minecraft/index.html

Gets the current mouse position with high-precision floating-point coordinates.

```APIDOC
## getMousePositionHF

### Description
Retrieves the current mouse cursor position using high-precision floating-point coordinates.

### Method
abstract fun getMousePositionHF(): Pair<Double, Double>

### Returns
- Pair<Double, Double> - A pair representing the high-precision X and Y coordinates of the mouse.
```

--------------------------------

### wrap

Source: https://notenoughupdates.org/MoulConfig/javadocs/modern/io.github.notenoughupdates.moulconfig.platform/-moul-config-style/index.html

Wraps a Style into a MoulConfigStyle.

```APIDOC
## wrap

### Description
Wraps a Style into a MoulConfigStyle.

### Function Signature
open fun wrap(style: Style): MoulConfigStyle
```

--------------------------------

### takeOne() Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-stack-util/index.html

Takes the first available stack trace element.

```APIDOC
## takeOne() Function

### Description
Retrieves the first stack trace element from the processed stack trace. Returns null if the stack trace is empty or all elements have been consumed.

### Returns
* **@Nullable StackTraceElement** - The first stack trace element, or null if none is available.
```

--------------------------------

### getEffectiveColour with offset

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-chroma-colour/get-effective-colour.html

Gets the effective color, offset by a hue amount.

```APIDOC
## getEffectiveColour(offset: Float)

### Description
Gets the effective color, offset by a hue amount. If this is a chrome color, the color at the current time is returned.

### Parameters
#### Path Parameters
- **offset** (Float) - Required - Offsets the color by a hue amount.

### Return
Color(source)
```

--------------------------------

### WhenLoader Functions

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-when-loader/index.html

Provides functions for creating instances, retrieving attribute names, child counts, and component names.

```APIDOC
## Functions

### createInstance

open override fun createInstance( context: XMLContext<*>, element: Element): WhenComponent

### getAttributeNames

open override fun getAttributeNames(): Map<String, Boolean>

### getChildCount

open override fun getChildCount(): ChildCount

### getName

open override fun getName(): QName

```

--------------------------------

### scaleFactor Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the current scale factor of the Minecraft game window.

```APIDOC
## scaleFactor

### Description
Returns the current scale factor applied to the game window, used for UI scaling.

### Property
`open override val scaleFactor: Int`
```

--------------------------------

### mousePositionHF Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/legacy/io.github.notenoughupdates.moulconfig.internal/-forge-minecraft/index.html

Gets the current mouse position as a pair of Double values.

```APIDOC
## mousePositionHF

### Description
Returns the current mouse position represented as a `Pair<Double, Double>`.

### Property
`open override val mousePositionHF: Pair<Double, Double>`
```

--------------------------------

### TextComponent Constructor with String

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-text-component/-text-component.html

Initializes a TextComponent with a plain string.

```APIDOC
## TextComponent(string: String)

### Description
Creates a new TextComponent instance with the provided plain string. Default width and alignment are used.

### Parameters
- **string** (String) - The plain string content for the component.
```

--------------------------------

### createVanillaPanel

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-nine-patches/index.html

Creates a NinePatch resource representing a vanilla panel.

```APIDOC
## createVanillaPanel

### Description
Creates a NinePatch resource representing a vanilla panel.

### Signature
fun createVanillaPanel(): NinePatch<MyResourceLocation>
```

--------------------------------

### getEffectiveColour without offset

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-chroma-colour/get-effective-colour.html

Gets the effective color without any hue offset.

```APIDOC
## getEffectiveColour()

### Description
Gets the effective color. If this is a chrome color, the color at the current time is returned.

### Return
Color(source)
```

--------------------------------

### MoulConfigPlatform Constructors

Source: https://notenoughupdates.org/MoulConfig/javadocs/modern/io.github.notenoughupdates.moulconfig.platform/-moul-config-platform/index.html

Provides details on how to instantiate the MoulConfigPlatform class.

```APIDOC
## MoulConfigPlatform Constructor

### Description
Instantiates a new MoulConfigPlatform object.

### Constructor Signature
constructor()

### Parameters
None
```

--------------------------------

### activeConfigGUI Property

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-option-editor/index.html

Gets or sets the active configuration GUI context for this option editor.

```APIDOC
## activeConfigGUI Property

### Description
Represents the active configuration GUI context associated with this option editor. This property allows access to the main editor instance.

### Type
MoulConfigEditor<out Any>
```

--------------------------------

### getEffectiveColourRGB()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-chroma-colour/get-effective-colour-r-g-b.html

Retrieves the effective color at the current time. This is the default method for getting the color.

```APIDOC
## getEffectiveColourRGB()

### Description
Retrieves the effective color at the current time. This is the default method for getting the color.

### Return
the colour, at the current time if this is a chrome colour
```

--------------------------------

### InitUtil Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.internal/-init-util/index.html

Initializes a new instance of the InitUtil class.

```APIDOC
## InitUtil()

### Description
Initializes a new instance of the InitUtil class.

### Constructor
InitUtil()
```

--------------------------------

### createContext

Source: https://notenoughupdates.org/MoulConfig/javadocs/modern/io.github.notenoughupdates.moulconfig.platform/-moul-config-screen-component/index.html

Creates a GUI immediate context. This can be done with or without a draw context (GuiGraphics or GuiGraphicsExtractor).

```APIDOC
## createContext

### Description
Creates a GUI immediate context. This can be done with or without a draw context (GuiGraphics or GuiGraphicsExtractor).

### Method Signatures
- `open fun createContext(): GuiImmediateContext`
- `open fun createContext(@Nullable drawContext: @Nullable GuiGraphics): GuiImmediateContext`
- `open fun createContext(@Nullable drawContext: @Nullable GuiGraphicsExtractor): GuiImmediateContext`
```

--------------------------------

### TextComponent Functions

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-text-component/index.html

Functions available for TextComponent, including getting dimensions, rendering, and text splitting.

```APIDOC
## TextComponent Functions

### getHeight()

open fun getHeight(): Int

Get the requested y size for this element.

### getWidth()

open fun getWidth(): Int

Get the requested x size for this element.

### render(context: GuiImmediateContext)

open fun render(context: GuiImmediateContext)

Called by the parent renderer.

### split(text: StructuredText, width: Int): List<StructuredText>

open fun split(text: StructuredText, width: Int): List<StructuredText>

Splits the given StructuredText into a list of StructuredText objects based on the provided width.
```

--------------------------------

### addAll(Int, Collection<out T>)

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.observer/-observable-list/add-all.html

Inserts all elements from the specified collection into this list, starting at the specified index.

```APIDOC
## addAll(Int, Collection<out T>)

### Description
Inserts all elements from the specified collection into this list, starting at the specified index.

### Method
open fun addAll

### Parameters
#### Path Parameters
- **index** (Int) - Required - The index at which to insert the first element from the specified collection.
- **c** (Collection<out T>) - Required - The collection of elements to add.

### Returns
- **Boolean** - True if the list was modified as a result of the call.
```

--------------------------------

### main Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml/-x-s-d-generator/-companion/index.html

The main function serves as the entry point for the XSdGenerator application. It accepts an array of strings as command-line arguments.

```APIDOC
## main Function

### Description
This is the primary entry point for the XSdGenerator. It allows the program to be executed from the command line with arguments.

### Signature
```kotlin
@JvmStatic
fun main(args: Array<String>)
```

### Parameters
* **args** (Array<String>) - Required - An array of strings representing the command-line arguments passed to the program.
```

--------------------------------

### render Function

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.component/-fixed-component/index.html

Renders the component within the given GUI context.

```APIDOC
## render(context: GuiImmediateContext)

### Description
Called by the parent renderer to render the component.

### Parameters
- **context** (@NotNull GuiImmediateContext) - The current GUI context for rendering.
```

--------------------------------

### Get Value

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.observer/-get-setter/get.html

Retrieves the current value from the GetSetter. Note that subsequent calls may return different values.

```APIDOC
## get()

### Description
Retrieves the current value from the GetSetter. Subsequent evaluations may return different values.

### Method
`get`

### Parameters
None

### Returns
- T: The current value.
```

--------------------------------

### PanelLoader Methods

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-panel-loader/index.html

Contains methods for creating panel instances and retrieving panel information.

```APIDOC
## createInstance

### Description
Creates a new instance of a PanelComponent.

### Method
open override fun createInstance( context: XMLContext<*>, element: Element): PanelComponent

## getAttributeNames

### Description
Retrieves the attribute names for the panel.

### Method
open override fun getAttributeNames(): Map<String, Boolean>

## getChildCount

### Description
Retrieves the child count for the panel.

### Method
open override fun getChildCount(): ChildCount

## getName

### Description
Retrieves the qualified name of the panel.

### Method
open override fun getName(): QName

```

--------------------------------

### GuiOptionEditorInfoText Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.editors/-gui-option-editor-info-text/index.html

Constructs a new GuiOptionEditorInfoText instance.

```APIDOC
## GuiOptionEditorInfoText Constructor

### Description
Initializes a new instance of the GuiOptionEditorInfoText class.

### Parameters
- **option** (ProcessedOption) - The processed option associated with this editor.
- **infoTitle** (StructuredText) - The structured text to be displayed as the informational title.
```

--------------------------------

### onGainedFocus()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-component/on-gained-focus.html

This method is called by the gui context when an element gains focus. This does only get called if this element specifically is being focused.

```APIDOC
## onGainedFocus()

### Description
This method is called by the gui context when an element gains focus. This does only get called if this element specifically is being focused.

### Method
open fun onGainedFocus()
```

--------------------------------

### MoulConfigEditor Constructors

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-moul-config-editor/index.html

Constructors for initializing the MoulConfigEditor.

```APIDOC
## MoulConfigEditor()

### Description
Initializes a new instance of the MoulConfigEditor.

### Parameters
None
```

```APIDOC
## MoulConfigEditor(processedConfig: MoulConfigProcessor<T>)

### Description
Initializes a new instance of the MoulConfigEditor with a processed configuration.

### Parameters
* `processedConfig` (MoulConfigProcessor<T>) - The processed configuration to use.
```

```APIDOC
## MoulConfigEditor(allCategories: LinkedHashMap<String, out ProcessedCategory>, configObject: T)

### Description
Initializes a new instance of the MoulConfigEditor with categories and a configuration object.

### Parameters
* `allCategories` (LinkedHashMap<String, out ProcessedCategory>) - An unmodifiable map of all configuration categories.
* `configObject` (T) - The configuration object to edit.
```

--------------------------------

### onLostFocus()

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-gui-component/on-lost-focus.html

This method is called by the gui context when an element loses focus. This does only get called if this element specifically was focused.

```APIDOC
## onLostFocus()

### Description
This method is called by the gui context when an element loses focus. This does only get called if this element specifically was focused.

### Signature
open fun onLostFocus()
```

--------------------------------

### GuiTextures Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig/-gui-textures/index.html

Initializes a new instance of the GuiTextures class.

```APIDOC
## GuiTextures()

### Description
Constructs a new GuiTextures object.

### Constructor
`GuiTextures()`
```

--------------------------------

### Get All CloseAction Entries

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-close-event-listener/-close-action/entries.html

Retrieves an immutable list of all enum entries for CloseAction. This is useful for iterating through all possible actions.

```APIDOC
## Get CloseAction Entries

### Description
Returns a representation of an immutable list of all enum entries for `CloseAction`, in the order they are declared. This method can be used to iterate over the enum entries.

### Method
Property Access

### Endpoint
N/A (This is a method call on an enum)

### Parameters
None

### Request Example
```kotlin
val allCloseActions = CloseEventListener.CloseAction.entries
```

### Response
#### Success Response
- **entries** (EnumEntries<CloseAction>) - An immutable list of all `CloseAction` enum constants.
```

--------------------------------

### apply

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.trans/-unbox-primitives/apply.html

Transforms an object from one type to another, wrapped into a GetSetter.

```APIDOC
## apply

### Description
Transforms an object from one type to another, wrapped into a GetSetter.

### Method Signature
`open fun apply(domain: Type, value: GetSetter<out Any>): GetSetter<out Any>`

### Parameters
#### Path Parameters
- **domain** (Type) - Description: the type contained in the GetSetter
- **value** (GetSetter<out Any>) - Description: the value to transform
```

--------------------------------

### Get All VerticalAlign Entries

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-vertical-align/entries.html

Retrieves an immutable list of all enum entries for VerticalAlign. This is useful for iterating through all possible alignment options.

```APIDOC
## Get VerticalAlign Entries

### Description
Returns a representation of an immutable list of all enum entries, in the order they're declared. This method may be used to iterate over the enum entries.

### Method
`val`

### Endpoint
`VerticalAlign.entries`

### Parameters
None

### Response
#### Success Response (List<VerticalAlign>)
- Returns an immutable list containing all declared entries of the `VerticalAlign` enum.

### Response Example
```json
["TOP", "CENTER", "BOTTOM"]
```
```

--------------------------------

### GuiOptionEditorText Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.editors/-gui-option-editor-text/index.html

Initializes a new instance of the GuiOptionEditorText class.

```APIDOC
## GuiOptionEditorText constructor

### Description
Initializes a new instance of the GuiOptionEditorText class.

### Parameters
- **option** (ProcessedOption) - Description of the option parameter.
- **forbidden** (String) - Description of the forbidden parameter.
```

--------------------------------

### CloseAction Functions

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui/-close-event-listener/-close-action/index.html

Provides utility functions for the CloseAction enum, including combining actions, retrieving by value, and getting all values.

```APIDOC
## Functions

### or
```kotlin
fun or(other: CloseEventListener.CloseAction): CloseEventListener.CloseAction
```
Combines this CloseAction with another CloseAction.

### valueOf
```kotlin
fun valueOf(value: String): CloseEventListener.CloseAction
```
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

### values
```kotlin
fun values(): Array<CloseEventListener.CloseAction>
```
Returns an array containing the constants of this enum type, in the order they're declared.
```

--------------------------------

### GuiOptionEditorKeybind Constructor

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.editors/-gui-option-editor-keybind/index.html

Initializes a new instance of the GuiOptionEditorKeybind class with a specified option and default key code.

```APIDOC
## GuiOptionEditorKeybind

### Description
Constructs a new GuiOptionEditorKeybind.

### Parameters
- **option** (ProcessedOption) - The processed option to be edited.
- **defaultKeyCode** (Int) - The default key code for the keybind.
```

--------------------------------

### Get All ClickType Entries

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.common/-click-type/entries.html

Retrieves an immutable list of all enum entries for ClickType. This is useful for iterating over all possible click types.

```APIDOC
## Get ClickType Entries

### Description
Returns a representation of an immutable list of all enum entries, in the order they're declared. This method may be used to iterate over the enum entries.

### Method
`val`

### Endpoint
`ClickType.entries`

### Parameters
None

### Request Example
```kotlin
ClickType.entries
```

### Response
#### Success Response
- **List<ClickType>** - An immutable list containing all enum entries of ClickType.
```

--------------------------------

### RootLoader Functions

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.xml.loaders/-root-loader/index.html

Provides functions for creating instances, retrieving attribute names, child counts, and names.

```APIDOC
## Functions

### createInstance

#### Signature
open override fun createInstance(context: XMLContext<*>, element: Element): GuiComponent

#### Description
Creates a new instance of a GuiComponent based on the provided XML context and element.

### getAttributeNames

#### Signature
open override fun getAttributeNames(): Map<String, Boolean>

#### Description
Retrieves the map of attribute names and their boolean values.

### getChildCount

#### Signature
open override fun getChildCount(): ChildCount

#### Description
Retrieves the child count information.

### getName

#### Signature
open override fun getName(): QName

#### Description
Retrieves the qualified name of the component.
```

--------------------------------

### ProcessedOptionImpl Functions

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.processor/-processed-option-impl/index.html

Provides functions for interacting with and managing the ProcessedOptionImpl, including notifying changes, getting and setting values, and retrieving metadata.

```APIDOC
## ProcessedOptionImpl Functions

### explicitNotifyChange()
- **Description**: Manually triggers a change notification for this option.
- **Returns**: void

### get()
- **Description**: Retrieves the current value of the option.
- **Returns**: Any - The current value of the option.

### getDebugDeclarationLocation()
- **Description**: Returns the location where this option was declared for debugging purposes.
- **Returns**: String - The declaration location.

### getDescription()
- **Description**: Retrieves the description of the option.
- **Returns**: StructuredText - The description of the option.

### getSearchTags()
- **Description**: Retrieves an array of search tags associated with this option.
- **Returns**: Array<SearchTag> - The search tags.

### getType()
- **Description**: Retrieves the type of the option.
- **Returns**: Type - The type of the option.

### set(value: Any)
- **Description**: Sets a new value for the option.
- **Parameters**:
  - **value** (Any) - The new value to set for the option.
- **Returns**: Boolean - True if the value was set successfully, false otherwise.
```

--------------------------------

### EditorComponentWrapper Methods

Source: https://notenoughupdates.org/MoulConfig/javadocs/common/io.github.notenoughupdates.moulconfig.gui.editors/-component-editor/-editor-component-wrapper/index.html

Methods for interacting with and rendering the EditorComponentWrapper. These include functions to get dimensions, handle input events, and render the component.

```APIDOC
## Function: getHeight

### Signature
open fun getHeight(): Int

### Description
Get the requested y size for this element.
```

```APIDOC
## Function: getTopHeight

### Signature
open fun getTopHeight(): Int
```

```APIDOC
## Function: getWidth

### Signature
open fun getWidth(): Int

### Description
Get the requested x size for this element.
```

```APIDOC
## Function: keyboardEvent

### Signature
open fun keyboardEvent(event: KeyboardEvent, context: GuiImmediateContext): Boolean

### Description
Called by the parent renderer to handle keyboard events.
```

```APIDOC
## Function: mouseEvent

### Signature
open fun mouseEvent(mouseEvent: MouseEvent, context: GuiImmediateContext): Boolean

### Description
Called by the parent renderer to handle mouse events.
```

```APIDOC
## Function: render

### Signature
open fun render(context: GuiImmediateContext)

### Description
Called by the parent renderer to render the component.
```
Tokens:
Raw