WoW:Khaos: Difference between revisions
(Typo fixing, Replaced: <br clear=all /> → <br clear="all" /> (2) AWB) |
(hmm) |
||
Line 1: | Line 1: | ||
'''Khaos''' is a universal configuration registration system. It allows you to create configurations for addons or addon-groups and cluster them together. You can import/export your own custom configurations and have them work with anyone else who is using Khaos. Below are some examples of using Khaos. | '''Khaos''' is a universal configuration registration system. It allows you to create configurations for addons or addon-groups and cluster them together. You can import/export your own custom configurations and have them work with anyone else who is using Khaos. Below are some examples of using Khaos. | ||
== API == | |||
== | |||
* [[Khaos.registerFolder|registerFolder]] - Registers a custom folder | * [[Khaos.registerFolder|registerFolder]] - Registers a custom folder | ||
* [[Khaos.updateFolder|updateFolder]] - Updates a custom folder | * [[Khaos.updateFolder|updateFolder]] - Updates a custom folder | ||
Line 31: | Line 28: | ||
* [[Khaos.refresh|refresh]] - Force a re-draw of the gui | * [[Khaos.refresh|refresh]] - Force a re-draw of the gui | ||
== Data Types == | |||
== | |||
* [[KhaosConfigurationFolder]] - folders for sets | * [[KhaosConfigurationFolder]] - folders for sets | ||
* [[KhaosSet]] - sets of options | * [[KhaosSet]] - sets of options | ||
Line 39: | Line 35: | ||
* [[KhaosSlashCommand]] - slash commands for configurations | * [[KhaosSlashCommand]] - slash commands for configurations | ||
=== | == Examples == | ||
=== Login screen === | |||
Choose a configuration from the drop-down menu that appears when you login. | |||
The game will load that configuration so that you can preview it. If you press "Use", it will use that configuration. If you select "Edit" it will display the main screen. Checking the box will make it auto-pick that configuration when you login to this server with that character. | |||
=== | === Folders === | ||
[[Image:Khaos example folders.jpg|thumb|Example folders]] | |||
The yellow text marks a folder. White text with checkmarks denotes an option set and if it is enabled or not. <br clear="all" /> | |||
=== | === Option sets === | ||
[[Image:Khaos example options.jpg|thumb|Example options]] | |||
Each line is a single option. The whole scrollable pane is considered an option set. | |||
==== | == Changelog == | ||
===v2.4=== | |||
#state.type == K_COLORPICKER on callback when clicked via human input (similar to the other input types) | |||
#Slightly modified KhaosConfig_SetCheck_OnClick to allow it to be hooked by Ace2Khaos | |||
#Taiwan translation by DDx | |||
#Tweak to allow frame to remain open despite a blizzard bug with right offset and centered UIPanels | |||
#Updated toc to 20100 | |||
#DropDownList1 now hides when the KhaosFrame does and is wont go off screen | |||
===v2.3=== | |||
#Doubled the time before feedback fades (to 6s) | |||
#Option text and header mouse-overs now correctly shows feedback | |||
#Option registration disabled settings are now optional | |||
#Option dependencies can now be defined as functions | |||
#pcall errors from Khaos are now printed to chat (instead of using message() which seems to cause more errors) | |||
#For pulldown options setup.multiSelect now correctly works with setup.noSelect | |||
===v2.2=== | |||
#Changed collumn widths to make more of the addon names visible | |||
#Difficulties changed to a single "Advanced Options" checkbox, default unchecked | |||
#Added blank configuration section text | |||
#Configuration section now scrolls slower with the mouse wheel | |||
#Added addon dependency trees to the addon list | |||
#Addon help text now shows unloaded required dependancies in red. | |||
#Right clicking an addon now selects the addon as well as shows the dropdown menu | |||
#Removed configuration categories/tabs/folders | |||
#"Set Default" popup is now only used at the beginning before a configuration has been selected. To select the default afterwards simply check the box next to it in the selection menu or right click and select "Set to default" | |||
#Fixed help "?" icon hover text | |||
#Changed all tooltips to use the help text format at the bottom of the frame | |||
#OnShow now re-centers the window if it hasn't been manually dragged. | |||
=== | ===v2.11=== | ||
#Fixed bug in the config dropdown menu | |||
===v2.1=== | |||
#Fixed bug in setSetKeyParameter not returnign after an error | |||
#TOC to 20003 | |||
=== | ===v2.0=== | ||
#No longer requires Earth | |||
#Now uses embedded DynamicPopup library for simple static popups | |||
#Now uses embeddable FireTree XML Template Library | |||
#Included derived Radio Button and Vertical Tab templates | |||
#Now uses the blizzard dropdown menu template | |||
#Changed debug globals to only KHAOS_DEBUG and KHAOS_DEBUG_VALUE | |||
#Available Standalone version with all libs embedded | |||
[[Category:Function Libraries]] | [[Category:Function Libraries]] | ||
[[Category:Cosmos | [[Category:Cosmos]] |
Revision as of 04:28, 2 July 2010
Khaos is a universal configuration registration system. It allows you to create configurations for addons or addon-groups and cluster them together. You can import/export your own custom configurations and have them work with anyone else who is using Khaos. Below are some examples of using Khaos.
API
- registerFolder - Registers a custom folder
- updateFolder - Updates a custom folder
- validateFolder - Validates a custom folder
- unregisterFolder - Unregisters a custom folder
- registerOptionSet - Registers an option set
- updateOptionSet - Updates an option set
- validateOptionSet - Validates an option set prior to registration
- unregisterOptionSet - Unregisters an option set
- registerConfigurationLoadNotice - Register to be notified when the user selects a different configuration
- unregisterConfigurationLoadNotice - Removes the load updater with specified id
- registerGlobal - Registers a global variable to be saved/loaded when the user selects a new configuration
- unregisterGlobal - Removes a global from the configuration update list
- updateGlobal - Updates the global variable stored inside the configuration
- getSetKey - Allows you to directly access a key-value pair inside the configuration
- setSetKey - Allows you to directly modify a key-value pair inside the configuration
- setSetKeyParameter - Allows you to directly set a key-value pair's parameter
- getSetEnabled - Allows you to detect if an option set is on or off
- setSetEnabled - Allows you to turn an option set on or off
- updateSetKeys - Allows you to update groups of set keys and refresh the gui together
- refresh - Force a re-draw of the gui
Data Types
- KhaosConfigurationFolder - folders for sets
- KhaosSet - sets of options
- KhaosOption - options
- KhaosConfigurationLoadNotice - notify when config is loaded
- KhaosSlashCommand - slash commands for configurations
Examples
Login screen
Choose a configuration from the drop-down menu that appears when you login.
The game will load that configuration so that you can preview it. If you press "Use", it will use that configuration. If you select "Edit" it will display the main screen. Checking the box will make it auto-pick that configuration when you login to this server with that character.
Folders
The yellow text marks a folder. White text with checkmarks denotes an option set and if it is enabled or not.
Option sets
Each line is a single option. The whole scrollable pane is considered an option set.
Changelog
v2.4
- state.type == K_COLORPICKER on callback when clicked via human input (similar to the other input types)
- Slightly modified KhaosConfig_SetCheck_OnClick to allow it to be hooked by Ace2Khaos
- Taiwan translation by DDx
- Tweak to allow frame to remain open despite a blizzard bug with right offset and centered UIPanels
- Updated toc to 20100
- DropDownList1 now hides when the KhaosFrame does and is wont go off screen
v2.3
- Doubled the time before feedback fades (to 6s)
- Option text and header mouse-overs now correctly shows feedback
- Option registration disabled settings are now optional
- Option dependencies can now be defined as functions
- pcall errors from Khaos are now printed to chat (instead of using message() which seems to cause more errors)
- For pulldown options setup.multiSelect now correctly works with setup.noSelect
v2.2
- Changed collumn widths to make more of the addon names visible
- Difficulties changed to a single "Advanced Options" checkbox, default unchecked
- Added blank configuration section text
- Configuration section now scrolls slower with the mouse wheel
- Added addon dependency trees to the addon list
- Addon help text now shows unloaded required dependancies in red.
- Right clicking an addon now selects the addon as well as shows the dropdown menu
- Removed configuration categories/tabs/folders
- "Set Default" popup is now only used at the beginning before a configuration has been selected. To select the default afterwards simply check the box next to it in the selection menu or right click and select "Set to default"
- Fixed help "?" icon hover text
- Changed all tooltips to use the help text format at the bottom of the frame
- OnShow now re-centers the window if it hasn't been manually dragged.
v2.11
- Fixed bug in the config dropdown menu
v2.1
- Fixed bug in setSetKeyParameter not returnign after an error
- TOC to 20003
v2.0
- No longer requires Earth
- Now uses embedded DynamicPopup library for simple static popups
- Now uses embeddable FireTree XML Template Library
- Included derived Radio Button and Vertical Tab templates
- Now uses the blizzard dropdown menu template
- Changed debug globals to only KHAOS_DEBUG and KHAOS_DEBUG_VALUE
- Available Standalone version with all libs embedded