[v1.0.4-1.0.5] Item Notes

[Zizzo]

I've sometimes wanted to be able to add a short note to an object (for instance, to remind myself which amulet I was wearing before I swapped in the water-breathing one to do Nur). In T2 I could have used object inscriptions for this; for T4, I've put together a quickie Item Notes addon. To add a note to an item in your inventory or equipment, just select "Add note" from the use-item dialog. The note will show up at the top of the object's description tooltip (or near the top if any of your other addons do any fiddling in the same area). If the object already has a note, you'll get "Edit note" and "Remove note" options instead, which should be self-explanatory.

As always, I'm putting this out for testing and feedback before possible merging into ZOmnibus.

[edit 2013-10-31 10:37pm] Technical info:

Code: Select all

Hooks:
  UseItemMenu:generate [to add our 'Add/Edit/Remove note' action(s)]
  UseItemMenu:use [to implement our 'Add/Edit/Remove note' action(s)]
Superload:
  mod.class.Object:
    getDesc() [to add the item note to the description]
  mod.class.Store:
    onSell() [to remove notes from items you sell]

[Zizzo]

And already a bugfix release. Turns out my anti-namespace-collision naming convention of putting addon data in game.player.addon.<addon-short-name> or world.addon.<addon-short-name> doesn't work for objects, because some object egos apparently have a boolean addon field. Easy enough to fix, though; we just put addon-related data associated with objects in obj.addon_data.<addon-short-name>. Just pushed out that fix as v1a. We Apologize for the Inconvenience(TM).

[Zizzo]

Pushing out v1b with a tweak to go with my recent changes to Inventory Keys that adds quick-access mnemonic keys to the item actions on the use-item dialog. Since this addon adds actions to that dialog, we assign them the following mnemonic keys:

Code: Select all

  N   Add note/Edit note
  R   Remove note

And pursuant to DarkGod's subtle hint, I've gone back and added technical info to the original release post.

[Zizzo]

Migrating to v1.0.5.

[Zizzo]

Pushing out v1d with a small tweak to add an inventory display marker to items with notes.

[Zizzo]

Pushing out v1e, with a fix for compatibility with object description changes in v1.1.0.

[Zizzo]

Pushing out v1g, with a bugfix that was clobbering Alchemists' Interact with Golem talent. Also increased the allowed note length to 999 characters. And since people apparently still find it useful, I've officially brought it back out of deprecation.

[Zizzo]

Small tweaks in release v1i, just pushed out, to get proper coloring of the inventory marker for items with notes. Should be no changes in functionality.

[Zizzo]

v1i.1 is a compatibility release with ZOmnibus v15, mostly to avoid having the game option listed twice. If you have any characters using this addon together with ZOmnibus, you should upgrade both together, and future characters should only use one or the other (if you forget, the character creation dialog will warn you).

[Zizzo]

v1j.1 fixes a bug reported on the Steam page: the call signature of ShowStore:init() has apparently changed significantly since last I worked in this general area, and while I had updated all my other addons to use the new signature, I'd missed this one, which broke store interaction badly. We Apologize for the Error.™