Changelog Discussion

**ZorbaTHut** · 06-29-2011 03:57 PM

This thread used to be the changelog thread, but it's become clear that we need a separate Changelog and Changelog Discussion thread. Since this is where all the discussion has been, this is now officially the Discussion thread. Chat away!

NEW FEATURES:

* Added the framework for units. See documentation for Inspect.Unit.Detail(), Inspect.Unit.List(), Inspect.Unit.Lookup(), Event.Unit.Change.Add, Event.Unit.Change.Remove.
* Added events for buffs. See documentation for Event.Buff.Add, Event.Buff.Change, Event.Buff.Remove.
* Addon files will now be passed a single parameter. The parameter is a table, containing two members: "identifier" with the addon's identifier, and "data", which is an empty table that the addon can use for internal purposes. This parameter will be shared between all files in this addon.
* Documentation is now provided for events.

BREAKING CHANGES:

* Removed Event.Addon.Starting, Event.Addon.Shutdown, and Event.Addon.Finalizing. These have been renamed to Event.Addon.Startup.End, Event.Addon.Shutdown.Begin, and Event.Addon.Shutdown.End.
* The result of Inspect.Buff.Detail() will no longer include a .buff member. To determine if something is a buff, check the .debuff member. If it's not a debuff, it must be a buff.

NONBREAKING CHANGES:

* IDs now have a single-character type identifier as a prefix. Currently this includes 'u'nit, 'b'uff, and 'a'bility.

BUGFIXES:

* Adding more SavedVariables to an addon will no longer force those variables to "nil" on the addon's first run.
* SavedVariables set to "nil" will now actually save "nil"s.
* Event.System.Update.Begin will no longer trigger without a corresponding Event.System.Update.End.
* Frame:SetAlpha() now correctly takes values between 0 and 1.
* Frame:SetParent() will no longer cause events set on that frame to stop working.
* Texture:GetTextureWidth() and Texture:GetTextureHeight() will now be available immediately after loading a texture.

MEMBER DIFF:

Code:

Inspectors:
	Inspect.Unit.Detail
	Inspect.Unit.List
	Inspect.Unit.Lookup

Events:
	Event.Addon.Finalizing (removed)
	Event.Addon.Shutdown (removed)
	Event.Addon.Shutdown.Begin
	Event.Addon.Shutdown.End
	Event.Addon.Starting (removed)
	Event.Addon.Startup.End
	Event.Buff.Add
	Event.Buff.Change
	Event.Buff.Remove
	Event.Unit.Change.Add
	Event.Unit.Change.Remove

**Cairenn** · 06-29-2011 04:02 PM

*purrs at Zorba*

**ZorbaTHut** · 07-01-2011 05:40 PM

NEW FEATURES:

* In any place where you could previously use a unit specifier ("player.target", "group04.pet") you can now also use a unit ID. Note that you can access a unit by ID only if there currently exists a unit specifier that would access that unit. This is meant as a convenience to avoid keeping lookup tables locally, not as a method of monitoring units that you don't have targeted.
* Inspect.Buff.Detail() may now return members .poison, .disease, .curse.

BREAKING CHANGES:

* Event.System.Error has been completely redesigned.
* Fixed a bug which caused your account name to not be properly read. The result is that all saved addon files have now moved. Your SavedVariables will be reset unless you manually move them to the new location.

BUGFIXES:

* The .ability member of Inspect.Buff.Detail() has been re-enabled.
* Inspect.Unit.Lookup will now properly do the ID-to-specifier conversion.

No function additions or removals.

**ZorbaTHut** · 07-06-2011 02:25 PM

NEW FEATURES:

* Add Utility.Serialize.Inline(), which can be used to generate serialized versions of tables. Suitable for either human readability or inserting into loadstring() as a parameter.
* Add dump(), which acts like a shallow wrapper around both print() and Utility.Serialize.Inline(). Handy for debugging.

BREAKING CHANGES:

* Event.Ability.AvailabilityChange has been split into Event.Ability.Availability.Add and Event.Ability.Availability.Remove. (Note that it's about to be renamed again.)

BUGFIXES:

* Inspect.Unit.Detail will now properly show the level of high-level friendly targets.
* Inspect.Buff.* will now accept unit IDs as well as unit specifiers.
* Fix crash caused by accessing the invalid "group00" unit specifier.
* Fix issue where groupXX unit specifiers returned by the system would be off by one.
* Event.Buff.Change will now trigger when removing single stacks of a buff. This will also no longer cause Event.Buff.Remove messages referring to buffs that have already been removed once.

MEMBER DIFF:

Code:

Basic globals:
	Utility.Serialize.Inline
	dump

Events:
	Event.Ability.AvailabilityChange (removed)
	Event.Ability.Availability.Add
	Event.Ability.Availability.Remove

**ZorbaTHut** · 07-08-2011 03:22 PM

NEW FEATURES:

* New events: Event.Ability.Range.True, Event.Ability.Range.False, Event.Ability.Target, Event.Ability.Usable.True, Event.Ability.Usable.False.

BREAKING CHANGES:

* Event.Ability.Availability.Add and Event.Ability.Availability.Remove have been renamed to Event.Ability.Add and Event.Ability.Remove.
* Event.Unit.Change.Add and Event.Unit.Change.Remove have been renamed to Event.Unit.Add and Event.Unit.Remove.

NONBREAKING CHANGES:

* Utility.Serialize.Inline() will now include the address of functions, userdata, or threads in its output, similar to the output of tostring().
* Performance improvements to dump() when dealing with large output.

BUGFIXES:

* Fix issues using print() with timestamps enabled.
* Utility.Serialize.Inline() will now properly return nil when given a non-tree-shaped structure.
* Inspect.Ability.Detail() will no longer crash if called extremely early in the load process.

DIFF:

Code:

Events:
	Event.Ability.Add
	Event.Ability.Availability.Add (removed)
	Event.Ability.Availability.Remove (removed)
	Event.Ability.Range.False
	Event.Ability.Range.True
	Event.Ability.Remove
	Event.Ability.Target
	Event.Ability.Usable.False
	Event.Ability.Usable.True
	Event.Unit.Add
	Event.Unit.Change.Add (removed)
	Event.Unit.Change.Remove (removed)
	Event.Unit.Remove

**ZorbaTHut** · 07-11-2011 08:14 PM

NEW FEATURES:

* print() will now prefix each line with the short addon name. The short addon name defaults to the addon name, but can be overridden in the .toc as "NameShort". print_raw() can be used to bypass the prefix behavior.

BREAKING CHANGES:

* print_console() has been removed.

BUGFIXES:

* SetBackgroundColor will now work properly when setting alpha to zero.
* During Event.Buff.Add, details on a newly created buff will now include the correct remaining time.

DIFF:

Code:

print_console (removed)
print_raw

**ZorbaTHut** · 07-22-2011 04:24 PM

NEW FEATURES:

* Add Layout:Read* and Frame:Clear* functions. These functions can be used to inspect or clear the SetPoint/SetWidth/SetHeight state.
* Added Utility.Event.Create. This can be used to create custom event tables which can be triggered through Lua.
* Added internationalization support for the Addon Manager. See Trion Development Tools for more details.

Embedding and Dependencies:
* Addons can now be embedded easily in other addons. In the .toc file, add the following: "Embed = { TheSubdirectoryOfTheAddonYouWantEmbedded = true }". The nested RiftAddon.toc file will be parsed, and that addon will be included transparently. See the RiftAddon.toc file in Trion Development Tools for more details.
* Multiple addons with the same identifier will only be executed once. This is based on the addon's Version string, which is parsed in an attempt to determine the newest version. See the RiftAddon.toc file in Trion Development Tools for more details.
* Addon dependencies are now supported. See the RiftAddon.toc file in Trion Development Tools for more details.
* Seriously, just go look at the RiftAddon.toc file in Trion Development Tools.

BUGFIXES:

* Ability events will now fire properly even after /reloadui.
* Buff events and ability events will now fire on startup, as if the environment is starting from a blank slate. This also occurs after /reloadui.
* Fix issue causing a small number of abilities (including Flicker) to not be accessible to Inspect.Ability.Detail().

DIFF:

Code:

Utilities:
	Utility.Event.Create
UI:
	Layout:
		Members:
			ReadAll
			ReadHeight
			ReadPoint
			ReadWidth
	Frame:
		Members:
			ClearAll
			ClearHeight
			ClearPoint
			ClearWidth

**ZorbaTHut** · 08-09-2011 12:12 PM

NEW FEATURES:

Mouse input:

* Added new mouse events for multiple buttons: Right, Middle, Mouse4, Mouse5.
* Added Upoutside event for all buttons. After a Down, you are guaranteed to receive an Up or Upoutside eventually. Up will be called if the mouse button was released inside the frame, Upoutside will be called if the mouse button was released outside the frame.
* Added Click events: LeftClick, RightClick, MiddleClick, Mouse4Click, Mouse5Click.
* Added non-button frame mouse events: WheelForward WheelBack MouseIn MouseOut MouseMove. MouseMove includes the mouse's new coordinates as parameters to the event.
* Added Frame:SetMouseMasking/Frame:GetMouseMasking, permitting the developer to gain more control over which events are consumed by the frame.
* Added Inspect.Mouse.

Unit events:

* Added Event.Unit.Available and Event.Unit.Unavailable, which tell you when a unit becomes readable via Inspect.Unit.Detail.
* Added a large number of events under Event.Unit.Detail.*, including Afk, Charge, Combo, ComboUnit, Energy, Guild, Health, HealthMax, HealthCap, Level, Mana, ManaMax, Mark, Name, Offline, Planar, Power, Pvp, TitlePrefix, TitleSuffix, Vitality, and Warfront.

Secure frames:

* Added secure frames. See Frame:SetSecureMode for documentation.
* Added Event.System.Secure.Enter and Event.System.Secure.Leave to inform the addon environment when it is entering and leaving secure mode.
* Added Frame:SetMouseoverUnit/Frame:GetMouseoverUnit. These functions can be called on a "restricted" secure frame, and cause that frame to behave like mouseovering a target.

Other:

* Added Utility.Dispatch, which allows you to call a function and change the current environment ownership. This lets you credit execution time to other addons and display other addons' names in the debug window.
* Added support for .png files.
* Added "begin" member to the result of Inspect.Buff.Detail.
* Added Command.System.Flash, which allows flashing the Rift taskbar icon as an alert.

BREAKING CHANGES:

* Mouse event LeftUp will no longer be guaranteed to be called after LeftDown. Instead, LeftUpoutside may be called.
* The "unavailable" member from Inspect.Unit.Detail has been renamed to "warfront".
* Development.Documentation has been moved to Inspect.Documentation.
* Inspect.System.Time has been split into Inspect.Time.Frame and Inspect.Time.Real.

NONBREAKING CHANGES:

* Error dumps will now display the addon's name, not [Rift].
* Added a new error type to Event.System.Error, "dispatch".
* The results from Inspect.Unit.Detail will now always show the following members, even if they're equal to "Max": health, mana, charge, energy, combo, power, vitality.
* Updated Lua backend to LuaJIT 2.0.0-beta8 hotfix1. Enabled Lua 5.2 compatibility features. For security reasons, string.dump() is still not provided and loadstring()'s ability to accept bytecode has been disabled.
* Utility.Event.Create now returns the created event frame as its second return value.
* Inspect.Unit.Detail can now be called on groupmembers who are offline or in a warfront without you.

BUGFIXES:

* Fixed many issues with mouse button events.
* Fixed an uncommon crash with Inspect.Ability.Detail.
* Fixed an uncommon crash with Inspect.Unit.Detail.
* Fixed a crash caused by embedding an addon that is not in the Addons/ directory.
* Fix documentation typo for Inspect.Unit.Detail.
* Texture:GetTextureWidth() and Texture:GetTextureHeight() now report accurate values immediately. By extension, Texture:ResizeToTexture() also now functions immediately.
* Inspect.Unit.Detail will now include correct "afk", "offline", and "warfront" parameters.

DIFF:

Code:

Basic globals:
  Development.Documentation (removed)
Inspectors:
	Inspect.Documentation
  Inspect.Mouse
  Inspect.Time (removed)
  Inspect.Time.Frame
  Inspect.Time.Real
Commands:
  Command.System.Flash
Utilities:
  Utility.Dispatch
Events:
  Event.System.Secure.Enter
  Event.System.Secure.Leave
	Event.Unit.Available
	Event.Unit.Detail.Afk
	Event.Unit.Detail.Charge
	Event.Unit.Detail.Combo
	Event.Unit.Detail.ComboUnit
	Event.Unit.Detail.Energy
	Event.Unit.Detail.Guild
	Event.Unit.Detail.Health
	Event.Unit.Detail.HealthCap
	Event.Unit.Detail.HealthMax
	Event.Unit.Detail.Level
	Event.Unit.Detail.Mana
	Event.Unit.Detail.ManaMax
	Event.Unit.Detail.Mark
	Event.Unit.Detail.Name
	Event.Unit.Detail.Offline
	Event.Unit.Detail.Planar
	Event.Unit.Detail.Power
	Event.Unit.Detail.Pvp
	Event.Unit.Detail.TitlePrefix
	Event.Unit.Detail.TitleSuffix
	Event.Unit.Detail.Vitality
	Event.Unit.Detail.Warfront
	Event.Unit.Unavailable
UI:
	Frame: Inherits from Layout
		Members:
			GetMouseMasking
			GetMouseoverUnit
			GetSecureMode
			SetMouseMasking
			SetMouseoverUnit
			SetSecureMode
		Events:
			LeftClick
			LeftUpoutside
			MiddleClick
			MiddleDown
			MiddleUp
			MiddleUpoutside
			Mouse4Click
			Mouse4Down
			Mouse4Up
			Mouse4Upoutside
			Mouse5Click
			Mouse5Down
			Mouse5Up
			Mouse5Upoutside
			MouseIn
			MouseMove
			MouseOut
			RightClick
			RightDown
			RightUp
			RightUpoutside
			WheelBack
			WheelForward

**ZorbaTHut** · 09-07-2011 02:59 PM

NEW FEATURES:

* Added currentCooldownBegin member to Inspect.Ability.Detail.
* Added role member to Inspect.Unit.Detail, added Event.Unit.Role.

BREAKING CHANGES:

* The currentCooldown member returned by Inspect.Ability.Detail has been renamed to currentCooldownDuration.

NONBREAKING CHANGES:

* Improved documentation for all frame events.
* Improved documentation for Inspect.Ability/Buff/Unit.Detail.
* Improved documentation for UI.CreateFrame.
* Improved documentation for Frame:SetPoint.
* Tweak documentation for Inspect.Time.Frame.
* SetAllPoints(), if given no parameters, now defaults to the frame's parent.

BUGFIXES:

* Print empty debug lines properly.
* Mouse events will no longer trigger for hidden frames.
* Frequently-updating text will no longer jitter.
* Text:SetFont now works as intended.

DIFF:

Code:

Events:
	Event.Unit.Detail.Role

**ZorbaTHut** · 09-13-2011 08:04 PM

NEW FEATURES:

* Added new Mask frame type. This can be used to crop other renderables to a bounding box.
* Added new RiftButton frame type. This acts and looks like a native Rift button.
* Assigning "true" to a frame event table, instead of a function, is now semantically equivalent to (but somewhat faster than) assigning an empty function.

BREAKING CHANGES:

* The List member in the Event table metatable has been removed.
* Traversing a frame's Event table with pairs() will now list all possible events, not just the ones that are currently hooked.

NONBREAKING CHANGES:

* "1.4" and "1.5" are now valid Environment strings. We strongly recommend using "1.5" for any addons intended to function at the 1.5 addon release.

BUGFIXES:

* The mouse behavior changes caused by clearing a frame event will now be immediately reflected in the UI.
* Overwriting another addon's frame event will now properly credit CPU used in that event to the overwriter.
* Fixed error documentation when improperly setting frame events.
* __pairs and __ipairs metatable methods are now actually working.

DIFF:

Code:

UI:
	Mask: Inherits from Frame
		Members:
			(No extra members)
		Events:
			(No extra events)
	RiftButton: Inherits from Frame
		Members:
			GetDefaultHeight
			GetDefaultWidth
			GetEnabled
			GetText
			ResizeToDefault
			SetEnabled
			SetText
		Events:
			LeftPress

**ZorbaTHut** · 09-21-2011 07:22 AM

NEW FEATURES:

* Added new RiftCheckbox frame type. This acts and looks like a native Rift checkbox.
* Added Event.Chat.Notify and Event.Chat.Npc. Note that this does not provide for player->player communication yet, only npc->player.
* Added Event.Combat.Damage, Event.Combat.Death, Event.Combat.Dodge, Event.Combat.Heal, Event.Combat.Immune, Event.Combat.Miss, Event.Combat.Parry, Event.Combat.Resist.
* Added Inspect.Shard().
* Added Inspect.System.Language().
* Added Inspect.Unit.Castbar() and Event.Unit.Castbar.
* Added planarMax member to the result from Inspect.Unit.Detail(), added Event.Unit.Detail.PlanarMax.
* Added support for keyboard events. See functions Frame:SetKeyFocus/GetKeyFocus, and events Frame.Event:KeyFocusGain/KeyFocusLoss/KeyDown/KeyUp/KeyType.
* Added "shard" and "global" SavedVariables modes. Note that "shard", in addition to being shard-specific, is also account-specific.

NONBREAKING CHANGES:

* Visual improvements to RiftButton.
* MouseMove events will now be sent between MouseDown and MouseUp events, even if the cursor is outside the window. This should make draggable UI elements significantly easier to implement. Note that, in the future, this may suppress MouseMove events sent to the actual element the cursor is over.
* Rift* elements will now default to their appropriate sizes. Textures will now default to the actual size of the texture. This behavior can still be overridden.
* Significantly improved documentation for System.Error.

BUGFIXES:

* Inspect.Unit.List() should no longer ignore offline groupmembers.
* The addon manager will now display the full name of addons even if the name is very long. If the name is very *very* long, it will be truncated appropriately with "...".
* Durationless buffs, most notably Rested, will no longer show incorrect duration/begin/remaining/expired values.

UPCOMING BREAKING CHANGES:

* ResizeToDefault and ResizeToTexture will be removed. With the new default-size behavior, this same functionality can be achieved with ClearSize().

DIFF:

Code:

Basic globals:
	table.unpack
 
Inspectors:
	Inspect.Shard
	Inspect.System.Language
	Inspect.Unit.Castbar
 
Events:
	Event.Chat.Notify
	Event.Chat.Npc
	Event.Combat.Damage
	Event.Combat.Death
	Event.Combat.Dodge
	Event.Combat.Heal
	Event.Combat.Immune
	Event.Combat.Miss
	Event.Combat.Parry
	Event.Combat.Resist
	Event.Unit.Castbar
	Event.Unit.Detail.PlanarMax
 
UI:
	Frame: Inherits from Layout
		Members:
			GetKeyFocus
			SetKeyFocus
		Events:
			KeyDown
			KeyFocusGain
			KeyFocusLoss
			KeyType
			KeyUp
	RiftCheckbox: Inherits from Frame
		Members:
			GetChecked
			GetDefaultHeight
			GetDefaultWidth
			GetEnabled
			ResizeToDefault
			SetChecked
			SetEnabled
		Events:
			CheckboxChange

**ZorbaTHut** · 09-22-2011 11:17 AM

BUGFIXES:

* The "player" member will no longer be missing when getting details for an offline partymember.
* Long messages will now be displayed properly in the console.
* Mouse events should no longer be eaten unpredictably by hidden addon frames.

**ZorbaTHut** · 09-23-2011 12:39 PM

NEW FEATURES:

* Added energyMax result to Inspect.Unit.Detail, added Event.Unit.Detail.EnergyMax.
* In addition to the info table provided as the first parameter to each file in an addon, the "data" table from the info table will now be provided as the second parameter directly, making it somewhat easier to use.

BREAKING CHANGES:

* Event.Chat.Npc will no longer trigger for zone event notifications. We'll be providing those later, through an as-yet-undefined interface.
* The SavedVariable path will now use proper unicode characters, making non-English character, account, and server names readable in your file browser. Unfortunately this also means that if you've been testing with non-English character, account, or server names, your previous SavedVariables will no longer be found and will have to be recreated.

BUGFIXES:

* Inspect.Documentation() will now properly return documentation for events in the case where you refer to the event by string rather than table. It will also list the name of the event properly.

DIFF:

Code:

Events:
	Event.Unit.Detail.EnergyMax

**ZorbaTHut** · 09-26-2011 02:12 PM

NEW FEATURES:

* Added new RiftTextfield frame type. This acts and looks like a native Rift textfield.
* Added new RiftWindow frame type. This acts and looks like a native Rift window.

BUGFIXES:

* Mask changes will now propogate correctly.

DIFF:

Code:

UI:
	RiftTextfield: Inherits from Frame
		Members:
			GetCursor
			GetDefaultHeight
			GetDefaultWidth
			GetSelection
			GetSelectionText
			GetText
			SetCursor
			SetSelection
			SetText
		Events:
			TextfieldChange
			TextfieldSelect
	RiftWindow: Inherits from Frame
		Members:
			GetBorder
			GetContent
			GetController
			GetDefaultHeight
			GetDefaultWidth
			GetTitle
			GetTrimDimensions
			SetController
			SetTitle
		Events:
			(No extra events)

**ZorbaTHut** · 09-28-2011 09:50 AM

This is the last diff that is also included in the 1.5 release. We'll be opening a separate Live Addon Changelog thread for any hotfixes.

NEW FEATURES:

* Added new RiftSlider frame type. This acts and looks like a native Rift slider.

NONBREAKING CHANGES:

* Improve documentation for Frame:SetSecureMode.

DIFF:

Code:

UI:
	RiftSlider: Inherits from Frame
		Members:
			GetDefaultHeight
			GetDefaultWidth
			GetEnabled
			GetPosition
			GetRange
			ResizeToDefault
			SetEnabled
			SetPosition
			SetRange
		Events:
			SliderChange
			SliderGrab
			SliderRelease

Thread: Changelog Discussion

Thread Tools

Search Thread

Display

Changelog Discussion

Bookmarks

Bookmarks

Posting Permissions