Ace3

https://github.com/wowuidev/ace3
Admin
Ace3 is a framework for WoW AddOn development, streamlining common tasks like lifecycles, saved...
Tokens:4,350
Snippets:27
Trust Score:4.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Untitled

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

No description

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

### AceConfigDialog-3.0 Configuration Dialog Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry details significant improvements to the AceConfigDialog-3.0 module, which manages in-game configuration dialogs. It covers updates to panel refresh behavior, callback signatures, safe method calls, and new functionalities for group selection, window opening, and control customization.

```APIDOC
AceConfigDialog-3.0 API:
  Panel Management:
    - Refresh Behavior: The Options Panel now refreshes automatically after a confirmation is canceled, resetting values to their previous state.
  Callbacks:
    - Confirm Callback: The confirm callback now receives the new value being set, aligning its signature with the validate callback.
    - Safe Closures: Close() and CloseAll() methods can now be safely invoked from within other callbacks without causing errors.
  Navigation & Display:
    - SelectGroup(appName: string, ...pathSegments: string[]): Selects a specific configuration group identified by its path and refreshes any open configuration windows.
    - Open(path: string): Opens the configuration window, optionally displaying only the specified group and its children if a path is provided.
    - AddToBlizOptions(path: string): Integrates a configuration page into the Blizzard Options interface, optionally displaying only the specified group and its children.
  Control Customization:
    - Multiselect Display: Allows multiselect controls to be rendered as a dropdown by setting 'dialogControl = "Dropdown".'
    - Custom Tooltips: Provides custom tooltips for TreeGroup and TabGroup elements, displaying both the name and description of the group.
```

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

### AceGUI-3.0 Widget API Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Details API changes for AceGUI-3.0 widgets, including new callbacks for resizing, method renames for consistency, and new visibility methods. It also covers a new method for setting label colors and improvements to the ColorPicker widget's alpha handling.

```APIDOC
AceGUI-3.0 Widget API:

Callbacks:
  OnWidthSet()
    - Triggered when a widget's width is resized.
  OnHeightSet()
    - Triggered when a widget's height is resized.

Renamed Methods:
  Release -> OnRelease()
  Acquire -> OnAcquire()
    - These methods, used for widget lifecycle management, are now prefixed with 'On' for improved clarity and consistency within the AceGUI framework.

New Widget Metatable Methods:
  IsVisible(): boolean
    - Returns true if the widget is currently visible, false otherwise.
  IsShown(): boolean
    - Returns true if the widget is currently shown, false otherwise.

Label Widget:
  SetColor(r: number, g: number, b: number, a: number)
    - Sets the color of the label text using RGBA values.

ColorPicker Widget:
  - Improved alpha channel display with checkers texture.
  - Fixes a "white"-texture bug.
  - Closes the ColorPickerFrame before opening to prevent values from being carried over from previous uses.
```

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

### AceConfigCmd-3.0 Command Line Interface Improvements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry outlines enhancements to the AceConfigCmd-3.0 module, which handles command-line interface interactions for configuration. It includes improvements to help output and fixes related to error handling for configuration properties.

```APIDOC
AceConfigCmd-3.0 API:
  Command Line Interface:
    - Help Output: Improved clarity and detail in help messages when viewing configuration groups.
    - Error Handling: Removed unnecessary references to '.confirm' property, preventing errors when '.confirm' is a boolean value.
```

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

### AceConfigDialog-3.0 Dialog and Validation Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Enhances AceConfigDialog-3.0 with fallback validation feedback in StaticPopups, more meaningful titles for Blizzard Options Groups, and improvements to prevent static popup taint. It also adds sorting for multiselects with 'radio' style.

```APIDOC
AceConfigDialog-3.0:
  Dialog Enhancements:
    - Fallback Validation: Implements fallback validation feedback using StaticPopups.
    - Title Clarity: Displays more meaningful titles on Blizzard Options Groups.
    - Taint Prevention: Includes measures to prevent static popup taint.
    - Multiselect Sorting: Sorts multiselects when using "radio" style.
```

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

### AceConfig-3.0 and AceConfigDialog-3.0 API Updates

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Details API changes for AceConfig-3.0 and AceConfigDialog-3.0, including new fields for the info table in AceConfig and enhancements to AceConfigDialog for UI element configuration and frame management.

```APIDOC
AceConfig-3.0 API:

Info Table Fields:
  - Added new fields to the info table: uiName, uiType, handler, option, type. These fields provide more detailed metadata for configuration options.

AceConfigDialog-3.0 API:

Widget Configuration:
  - The description widget now supports a "width" parameter for better layout control.
  - Multiline editboxes now support a "rowcount" parameter, allowing developers to specify the number of visible text rows.

Frame Management:
  - The :AddToBlizOptions() method now returns the registered frame, enabling its use with InterfaceOptionsFrame_OpenToFrame for direct navigation.
```

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

### AceGUI EditBox and MultiLineEditBox HighlightText API

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Exposes the HighlightText API for AceGUI EditBox and MultiLineEditBox widgets, allowing programmatic text highlighting within these input fields.

```APIDOC
AceGUI-3.0 EditBox/MultiLineEditBox Widgets:
  HighlightText()
    - Highlights the text within the edit box.
```

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

### AceGUI-3.0 WoW 7.0 Texture Color Handling

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

AceGUI-3.0 now uses SetColorTexture for handling colors, specifically to ensure compatibility with World of Warcraft 7.0's rendering changes.

```APIDOC
AceGUI-3.0:
  Texture Handling:
    - Uses SetColorTexture: Adopted for color handling to ensure compatibility with WoW 7.0.
```

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

### AceAddon-3.0 NewAddon Base Table Option

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry describes an enhancement to the AceAddon-3.0 module, which is responsible for addon creation. It introduces an optional argument to the NewAddon function, allowing a custom table to be used as the base for the new addon instance.

```APIDOC
AceAddon-3.0 API:
  NewAddon(baseTable: table, addonName: string, ...): table:
    - Parameters:
      - baseTable: An optional table that can be provided as the first argument to serve as the base object for the new addon.
      - addonName: The name of the addon.
      - ...: Additional arguments for addon initialization.
    - Purpose: Allows for an optional first argument to NewAddon to be a table, which will be used as the base object for the newly created addon instance.
    - Returns: The new addon instance.
```

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

### AceGUI EditBox Macro Drag-and-Drop Support

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Enables AceGUI EditBox widgets to accept drag-and-drop of macros, automatically populating the editbox with the macro's name, streamlining macro management within UI configurations.

```APIDOC
AceGUI-3.0 EditBox Widget:
  Behavior:
    - Drag-and-Drop: Supports dragging macros onto the editbox.
    - Input: When a macro is dropped, its name is automatically inserted into the editbox.
```

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

### AceGUI-3.0 Widget API Enhancements and Fixes

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This comprehensive entry covers a wide array of enhancements, new features, and bug fixes for the AceGUI-3.0 module, which provides various UI widgets. It includes improvements to existing widgets like Sliders, TreeGroups, TabGroups, and Dropdowns, as well as the introduction of new interactive elements and general API extensions for layout and styling.

```APIDOC
AceGUI-3.0 Widget API:
  Slider Widget:
    - Behavior: Properly shows percentage values as min/max when 'isPercent' property is true.
  TreeGroup Widget:
    - Fixes: Corrected an error that halted execution if no name was provided.
    - Features: Supports displaying icons within the tree.
    - Methods: EnableButtonTooltips(enable: boolean) - Controls the visibility of default tooltips on tree buttons (enabled by default).
  MultiLineEditbox Widget:
    - Fixes: Resolved issues with the Accept button not being clickable and general disabling behavior.
  TabGroup Widget:
    - Layout: Sets a maximum width for tabs based on widget size; improved visual styling to stretch tabs to full width only if they would use more than 75% of available space.
    - Behavior: Ensures consistent tab resizing.
    - Callbacks: OnTabEnter(), OnTabLeave() - New callbacks for tab interaction.
    - Architecture: Re-written layouting for improved performance and flexibility.
  InteractiveLabel Widget (New):
    - Features: Provides OnEnter(), OnLeave(), and OnClick() callbacks for interactive behavior, along with support for a highlight texture.
  Label Widget:
    - Methods: SetFont(font: string, size: number, flags: string), SetFontObject(fontObject: table) - Functions to control the font appearance.
  Widget API Extensions:
    - SetRelativeWidth(width: number): Allows setting the width of widgets relative to their container's width.
  Container Methods:
    - AddChild(widget: table, position: number): Adds a child widget, with an optional third argument to specify its position.
  EditBox Widget:
    - Fixes: Corrected alignment issues when the label associated with the EditBox is disabled.
  Keybinding Widget:
    - Enhancements: General improvements to its functionality and user experience.
  Base Widget Table:
    - Extensions: Added new methods to the core widget base table (refer to ACE-205 for full reference).
  Dropdown Widget:
    - Features: Completed multiselect support; introduced a new and improved DropDown widget implementation.
  General:
    - Includes various bug fixes, minor tweaks, and consistency changes across multiple widgets, along with improvements to the widget recycling process.
```

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

### AceGUI Label and InteractiveLabel Justification API

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Adds SetJustifyV and SetJustifyH methods to AceGUI Label and InteractiveLabel widgets for controlling text alignment, providing more precise control over UI element presentation.

```APIDOC
AceGUI-3.0 Label/InteractiveLabel Widgets:
  SetJustifyV(justify: string)
    - Sets vertical justification (e.g., "TOP", "MIDDLE", "BOTTOM").
  SetJustifyH(justify: string)
    - Sets horizontal justification (e.g., "LEFT", "CENTER", "RIGHT").
```

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

### AceDBOptions-3.0 API Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Outlines an enhancement to the GetOptionsTable method in AceDBOptions-3.0, introducing an optional argument to control the display of default profiles in the profile selection UI.

```APIDOC
AceDBOptions-3.0 API:

GetOptionsTable(db: table, noDefaultProfiles?: boolean): table
  - Added an optional second argument, 'noDefaultProfiles'.
  - If 'noDefaultProfiles' is set to true, the default profiles will not be shown in the profile selection interface, providing more control over the displayed options.
```

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

### AceGUI DropDown Widget API Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Enhances the AceGUI DropDown widget API to allow specifying the width of the pullout menu, provide notifications when opened, and make the entire widget clickable for improved usability and customization.

```APIDOC
AceGUI-3.0 DropDown Widget:
  API Enhancements:
    - Pullout Width Specification: Allows setting the width of the dropdown's pullout menu.
    - Open Notification: Provides a mechanism to be notified when the dropdown is opened.
    - Full Widget Clickability: The entire dropdown widget area is now clickable.
```

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

### AceTimer-3.0 Implementation and Callback Fixes

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

AceTimer-3.0 has been re-written based on AnimationTimers and C_Timer.After, improving its reliability and integration with the game client. It also fixes an issue where callback parameter lists were truncated at nil values.

```APIDOC
AceTimer-3.0:
  Implementation:
    - Re-written based on AnimationTimers.
    - New implementation leverages C_Timer.After for improved accuracy and game integration.
  Callback Fixes:
    - Resolves an issue where parameter lists passed to callbacks were cut off at nil values, ensuring all parameters are correctly received.
```

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

### AceDB-3.0 Profile Management API

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Describes updates to AceDB-3.0's profile management, focusing on the ResetProfile method. It clarifies how namespaces can be individually reset and introduces an optional argument to control the scope of the reset operation.

```APIDOC
AceDB-3.0 Profile Management API:

ResetProfile() Method Enhancements:
  - Namespaces can now be individually reset by calling :ResetProfile() directly on the namespace object.
  - Added an optional argument to :ResetProfile() to prevent the reset operation from populating to all namespaces, allowing the main profile to be reset independently.

Callbacks:
  - DB callbacks are now fired after namespaces have changed their profile, ensuring proper synchronization and event handling.
```

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

### AceGUI-3.0 ColorPicker Frame Level and Clamping

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

AceGUI-3.0's ColorPicker now automatically increases its frame level to ensure it appears above the option panel and is clamped to the screen to prevent it from going off-screen, improving visibility and usability.

```APIDOC
AceGUI-3.0 ColorPicker:
  Behavior:
    - Frame Level: Automatically increases its frame level to ensure visibility above option panels.
    - Screen Clamping: The color picker frame is now clamped to the screen boundaries.
```

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

### AceDBOptions-3.0 Profile Management and Localization

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry details updates to the AceDBOptions-3.0 module, focusing on improvements to profile management UI and localization. It addresses the disabling of profile manipulation options when no profiles are available and includes updates to locale files.

```APIDOC
AceDBOptions-3.0 API:
  Profile Management:
    - Behavior: "Copy From" and "Delete" dropdowns are disabled when no profiles are available, preventing invalid operations.
  Localization:
    - Updates: Locale files for esES (Spanish, Spain) and ruRU (Russian, Russia) have been updated.
```

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

### AceHook-3.0 Script Hooking Enhancements

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Improves AceHook-3.0 by allowing hooking of AnimationGroup scripts, ensuring secure script hooking via HookScript, and providing better error messages for hooking on nil frames, enhancing robustness and debugging.

```APIDOC
AceHook-3.0:
  Hooking Capabilities:
    - AnimationGroup Scripts: Now supports hooking scripts on AnimationGroup objects.
    - Secure Hooking: Consistently uses HookScript for secure and taint-free script hooking.
    - Error Handling: Provides improved checks and more informative error messages when attempting to hook scripts on non-existent (nil) frames.
```

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

### AceDB-3.0 Region-Based Profile Key Determination

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

AceDB-3.0 now utilizes the GetCurrentRegion() API to accurately determine region-based profile keys, ensuring correct profile loading and management across different WoW regions and client versions.

```APIDOC
AceDB-3.0:
  Uses GetCurrentRegion() API
    - Purpose: Determines region-based profile keys.
    - Impact: Fixes profile loading issues for WoW 6.0 and later.
```

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

### AceGUI Button Auto Width Option

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Adds an 'Auto Width' option to AceGUI Button widgets, enabling them to automatically adjust their width based on content, simplifying layout management for dynamic button labels.

```APIDOC
AceGUI-3.0 Button Widget:
  Options:
    - "Auto Width": boolean
      - When true, the button automatically adjusts its width to fit its content.
```

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

### AceDB-3.0 API Updates and Fixes

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry details updates and fixes for the AceDB-3.0 module, which is responsible for database and profile management within Ace3. It includes a new function for namespace retrieval, a critical fix for data consistency, and the implementation of a profile shutdown callback.

```APIDOC
AceDB-3.0 API:
  GetNamespace():
    - Purpose: Returns an existing namespace from the DB object.
  Data Inconsistency Fix:
    - Addresses issues when using 'false' as a table key, ensuring consistent data handling.
  OnProfileShutdown Callback:
    - Purpose: Implements a callback function that is triggered during profile shutdown events.
```

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

### AceTimer-3.0 Timer Management Functions

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry covers updates to the AceTimer-3.0 module, which provides timer management functionalities. It includes the implementation of a new function to query remaining time for a timer and a robustness improvement for canceling timers with nil handles.

```APIDOC
AceTimer-3.0 API:
  TimeLeft(handle: any): number:
    - Purpose: Returns the remaining time for a scheduled timer identified by its handle.
    - Returns: The time left in seconds, or nil if the handle is invalid.
  CancelTimer(handle: any):
    - Behavior: Modified to gracefully handle 'nil' timer handles by bailing out early without generating an error.
```

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

### AceHook-3.0 SecureHookScript Fix

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry describes a specific bug fix for the AceHook-3.0 module, which provides robust hooking capabilities. The fix addresses an issue where SecureHookScript would fail when attempting to hook previously empty scripts.

```APIDOC
AceHook-3.0 API:
  SecureHookScript(frame: table, scriptName: string, func: function):
    - Fixes: Ensures that SecureHookScript does not fail when attempting to hook previously empty scripts, addressing a limitation where frame:HookScript would do nothing in such cases.
```

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

### AceConfigRegistry-3.0 Options Table Validation Control

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

Adds an option to AceConfigRegistry-3.0 to skip validation of the options table during registration, offering developers more control and flexibility for specific configuration scenarios.

```APIDOC
AceConfigRegistry-3.0:
  Registration Options:
    - Skip Validation: An option is available to bypass the validation of the options table when registering configurations.
```

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

### AceDB-3.0 Default Profile Fallback

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

AceDB-3.0 now switches characters to their default profile if their currently active profile is deleted, preventing data loss or errors when a user's custom profile is removed.

```APIDOC
AceDB-3.0:
  Profile Management:
    - Default Profile Fallback: Automatically switches a character to its default profile if their active profile is deleted.
```

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

### AceLocale-3.0 NewLocale Silent Option

Source: https://github.com/wowuidev/ace3/blob/master/changelog.txt

This entry details a new feature for the AceLocale-3.0 module, which manages localization within Ace3. It introduces a 'silent' option for the NewLocale function to suppress warnings for unknown entries.

```APIDOC
AceLocale-3.0 API:
  NewLocale(localeName: string, silent: boolean):
    - Parameters:
      - localeName: The name of the locale to create or retrieve.
      - silent: An optional boolean. If true, disables warnings for unknown entries during locale creation or access.
    - Purpose: Implements a 'silent' option to suppress warnings for unknown entries when creating or accessing new locales.
```
Tokens:
Raw