GBBroadcast addon
By Durthos of Proudmoore.
Version 1.0.16 - Update Nov 27, 2007
(Renamed from GuildBank - due to name conflicts with Blizzards own Guildbank)
OVERVIEW
GBBroadcast is an add on which makes guild bank inventory management a little easier. It has two main features, storing the age of items that you are carrying so that you know which items you have had for the longest and an easy way for you to display your inventory, and broadcast it out to the rest of the guild.
DEPENDANCIES
GBBroadcast has two dependencies EnhTooltips and Stubby. You can either get them as part of the auctioneer package, or download them directly from the links below.
EnhTooltip : http://auctioneeraddon.com/dl/EnhTooltip/
The Add-on is configured by default not to load automatically for all of your characters. (In order to save memory). When you first run gbbroadcast on your bank character you should type /gbbroadcast load always so that GBBroadcast will now always load when you log into your character.
UI
GBBroadcast has alternately a GUI and a command driven interface. The GUI is the preferred method as it allows access to better filtering information. To make the gui appear just type /gbbroadcast, or /gb.
On the GUI there's a combo box where you can specify how you want the items sorted, various filters for the age of items, rarity and bag number.
There are also 4 buttons.
- Broadcast - sends your inventory to your target - either your guild, a channel, or a player
- Display - shows the item list locally.
- Refresh - updates the local cache -- in case the auto updates aren't fast enough for you.
- Mailbox Helper - displays items that are both in your mailbox and in your bags - I use this when my mailbox is full, and I want to grab the items that will stack first.
The target radio buttons allow you to specify who you want the message to go to.
-Guild sends the messages to guild chat
-Channel sends the messages to the channel specified in the channel text (use the channel number)
-Player sends the message to the specified player.
When you display your item list, GBBroadcast outputs some information locally to your main console window. If you create a window called "gbbroadcast" then the output will be sent there instead. This is configurable by editing gbbroadcast.lua in your saved variables folder. The information contains the (bag number, slot number) for each item, the item, and the amount of time you have had the item.
When you display the items in the item list gbbroadcast automatically splits the items into pages. The default page size is 12 items. If you want to change it you need to edit the gbbroadcast.lua in your saved variables folder. After the first page has been displayed press the broadcast button again to continue from where you left off.
USER GUIDE
Here's how I configure and use gbbroadcast.
1. I create a window called gbbroadcast, and drag it off from the main window to make it nice and big - when I'm broadcasting I want to be able to see which bags items are in so that I can find them quickly.
2. When I log in my bank character I check my bank to make sure that its full, and sorted, and check to make sure my own inventory is sorted. I use the Mr. Plow add-on for this.
3. I check my mail to see if anyone has sent me any item requests by mail. If my mailbox is full then I use the "mailbox helper" button to look for items I can clear out of the mail.
4. Once my inventory is 90% full and sorted, and I have cleared out the mail I check to make sure that the filter options are set the way I like them. Personally I set the days old to five which filters the inventory to only items I have had for more than five days, everything else I leave at the defaults. (I use a five day holding period because we use www.rpgoutfitter.com as our offline bank information and I want to encourage people to look there first).
5. Next I push the broadcast button, and wait for people to request items. I repeat this until I have finished the entire item list.
6. After I'm done broadcasting if I still have too much inventory I look for items that I've been holding onto for too long. I set to filter by age - newest first, and push the display button. Anything older than 45 days I advertise specially in guild before selling.
6. Finally I make sure that my inventory is sorted and stacked, and log out.
COMMAND LINE OPTIONS
The following are valid commands.
/gbbroadcast
- manually refresh the inventory list useful if you have been handing out items.
(Note that you can also use /gb)
- also displays rudimentary UI - which allows you to broadcast by type.
/gbbroadcast load
- load the GBBroadcast add-on.
/gbbroadcast load always
- force the GBBroadcast add-on to load always for this character
/gbbroadcast load never
- stop auto-loading the GBBroadcast add-on for this character
/gbbroadcast display [sort] [spam] [bagnum]
- displays your item list locally. Sort can be one of the following
name - sort by name
age - sort by how long you have have been carrying items
agerev - sort by how long you have had something starting with newest items first
type - sort by the item category
spam is an optional argument which is used to broadcast your list to your guild. You can configure how many items are displayed at a time by editing the constants at the top of the GBBroadcast.lua file.
bagnum allows you to whisper only items from a specific bag.
/gbbroadcast whisper [sort] [target] [bagnum]
- whispers your item list to your <target>. Sort can be one of the following
name - sort by name
age - sort by how long you have have been carrying items
agerev - sort by how long you have had something starting with newest items first
type - sort by the item category
target - the name of the person you are whispering to.
bagnum - allows you to whisper only items from a specific bag.
If you choose not to use the pre-made UI, then I recommended that you create the following macros for you gbbroadcast character.
/gbbroadcast
use this until I get the event hooks in place. If you're in the middle of sending your inventory list to the guild, and you mail out something that hasn't been seen yet this will force an update.
Also it displays handy UI that you can use to spam from.
/gbbroadcast display age
display the items in age order locally. This is great for figuring out what to sell when you run out of inventory space.
/gbbroadcast display type
this one is still experimental, but if you like the way that it works then make sure to add it as a spam option. Items are sorted by the type of item and its level, but since my bank doesn't usually get items I don't know how well it really works in practice. The function GBBroadcast_typesort in GBBroadcast.lua is where this function is implemented. Feel free to tweak it if you can find a better way to sort.
/gbbroadcast display name
display your list of items locally sorted by name..
/gbbroadcast display name spam
display your list of items in sorted order to the guild in 'pages' as defined at top of the GBBroadcast.lua file. Pushing the button repeatedly will print out the next page until the entire list is complete. Usually I give about a minute between pages so that people can reply that they are interested in an item.
BUG FIX HISTORY
If you find any errors in this program please send an email to dbeleznay@shaw.ca. Please include the line number, and any error text you see.
1.0.16
- Upgraded to support the new in game guildbank - you can now broadcast and track how long things have been in the guildbank
- renamed the add-on because it was conflicting with the name blizzard had given their guildbank
- Because I renamed the add on, if you want to keep your saved data you need to rename your World of Warcraft/WTF/Account/Accountname/Saved Variables/Guildbank.lua to GBBroadcast.lua
1.0.15
- I broke filtering by rarity in version 1.0.9, re-enabling it
1.0.14
- Changed TOC for patch 2.2
- fixed an error when the player manually loaded guild bank, where the slash command used to load gbbroadcast would continue to ask the player to load.
1.0.13
- fixed an exception when you recieve a letter with no items attached in the mail
1.0.12
- fixed a problem where item suffixes like 'of the whale' were not showing up
- added the mailbox helper button, which displays items that are in your mailbox and will stack with items in your bags.
1.0.11
- added a checkbox to optionally suppress the 'skipped item' messages sent to the local display
1.0.10
- added support for the two new bank bags that were added
- changed to use the 'GetMailItemLink' api.
1.0.9
- changed the layout of the saved information to make it smaller, and to no longer store item links (to avoid the disconnect bug when Blizzard changes item links)
- added support for reading items from the mail
- added the ability to broadcast to different channels
- changed the bag display messages to be more friendly
- refactored the code in order to make it more maintainable and localizable
1.0.8
- updated for the 2.0.0 patch
1.0.7
- Added a combo box to the UI to allow the user to filter by an items rarity
- Added a multi-select combo box to the UI to allow the user to filter by bags
1.0.6
- Fixed a bug in the UI where it would keep spamming with only the first page
- Added the display (locally) button and the refresh button to the ui
- refactored the code a bit, to make it easy to add more filters in the future
1.0.5
- Added ruidmentary UI
- fixed a bunch of bugs in the time keeping (for how long items had been around)
- fixed a bug where it would only load if you typed /gb (and not /gbbroadcast)
- added incoming rate for new items
1.0.4
- Added the ability to whisper to someone
- Added the ability to filter by bags
- Fixed a bug where item positions were not getting update correctly
- Started working on mail, but haven't got it hooked up yet.
- Added /gb as a command line option.
1.0.3
fixed a bug in the loading code for stubby where the /gbbroadcast command wasn't loaded correctly
1.0.2
fixed a bug for first time users running into an unitialized variable on going to the bank.
1.0.1
- Fixed output so that it goes to a properly named window
- changing spam type now resets the counter
- hitting the end of the spam list now resets the counter
- added colours to local item display for increased visibility
REFERENCES
In writing this add-on I reffered to several other World of Warcraft Addons including
- Auctioneer by Norgana
- InvList
- Character Profiler by calvin of RPGOutfitters
- EngInventory by Engival of Shadowsong
ADDON LICENSE
You are free to copy, distribute, display, and perform these addons and to make derivative addons under the following conditions: --Attribution. You must attribute all add ons in the manner specified by Durthos of Proudmoore.
--Noncommercial. You may not use these add ons for commercial purposes.
--Share Alike. If you alter, transform, or build upon these add ons, you may distribute the resulting add on only under a license identical to this one.
--For any reuse or distribution, you must make clear to others the license terms of these add ons. Any of these conditions can be waived if you get permission from Durthos of Proudmoore. Your fair use and other rights are in no way affected by the above.
COPYRIGHT
All World or Warcraft game related content and images are the property of Blizzard Entertainment, Inc. and protected by U.S. and international copyright laws. The Addon (code and supporting files) is property of Durthos of Proudmoore and protected by U.S. and international copyright laws.
1.0.16
- Upgraded to support the new in game guildbank - you can now broadcast and track how long things have been in the guildbank
- renamed the add-on because it was conflicting with the name blizzard had given their guildbank
1.0.15
- I broke filtering by rarity in version 1.0.9, re-enabling it
1.0.14
- Changed TOC for patch 2.2
- fixed an error when the player manually loaded guild bank, where the slash command used to load gbbroadcast would continue to ask the player to load.
1.0.13
- fixed an exception when you recieve a letter with no items attached in the mail
1.0.12
- fixed a problem where item suffixes like 'of the whale' were not showing up
- added the mailbox helper button, which displays items that are in your mailbox and will stack with items in your bags.
1.0.11
- added a checkbox to optionally suppress the 'skipped item' messages sent to the local display
1.0.10
- added support for the two new bank bags that were added
- changed to use the 'GetMailItemLink' api.
1.0.9
- changed the layout of the saved information to make it smaller, and to no longer store item links (to avoid the disconnect bug when Blizzard changes item links)
- added support for reading items from the mail
- added the ability to broadcast to different channels
- changed the bag display messages to be more friendly
- refactored the code in order to make it more maintainable and localizable
1.0.8
- updated for the 2.0.0 patch
1.0.7
- Added a combo box to the UI to allow the user to filter by an items rarity
- Added a multi-select combo box to the UI to allow the user to filter by bags
1.0.6
- Fixed a bug in the UI where it would keep spamming with only the first page
- Added the display (locally) button and the refresh button to the ui
- refactored the code a bit, to make it easy to add more filters in the future
1.0.5
- Added ruidmentary UI
- fixed a bunch of bugs in the time keeping (for how long items had been around)
- fixed a bug where it would only load if you typed /gb (and not /gbbroadcast)
- added incoming rate for new items
1.0.4
- Added the ability to whisper to someone
- Added the ability to filter by bags
- Fixed a bug where item positions were not getting update correctly
- Started working on mail, but haven't got it hooked up yet.
- Added /gb as a command line option.
1.0.3
fixed a bug in the loading code for stubby where the /gbbroadcast command wasn't loaded correctly
1.0.2
fixed a bug for first time users running into an unitialized variable on going to the bank.
1.0.1
- Fixed output so that it goes to a properly named window
- changing spam type now resets the counter
- hitting the end of the spam list now resets the counter
- added colours to local item display for increased visibility