Skip to content
xconstruct edited this page Aug 29, 2010 · 7 revisions

cargBags 2

cargBags is a modular inventory framework for the popular MMORPG 'World of Warcraft'. It was created with one simple thing in mind: Taking the boring work away for you, so that you can start right-away with the important things: Layout and categories! You don't have to care anymore about fetchting item-data, updating at the right time or creating a sophisticated filtering system - cargBags does this all for you!

From a simple all-in-one inventory over multiple category-based bags to your own needs:

Just start with the user-friendly and commented example xconstruct/cargBags_Simplicity, build upon it and implement your own features. Create and release your own individual bag addon by embedding cargBags!

Read the rest of the README

HowTo's and Explanations

Glossary

  • Core: Provides the "cargBags"-global and underlying class-system
  • Implementation: The base of your own bag-addon, manages updating of containers/buttons
  • Container: A single "bag" holding multiple ItemButtons
  • ItemButton: An item in your inventory, has functions for updating icon/text/border etc.
  • Source: The "window on the world", has functions for connecting to the Blizz API and handles events
  • Sieve: Controls which item goes into which container (eg. by bagID or a set of filters)
  • ItemKey: Provides additional data for the ItemTable
  • Mixins: All the other often-used lowlevel-functions - optional, but useful

Okay, that was the important core stuff - now the optional parts!

  • Plugin: Some object/frame placed on your container, like a Money-display
  • Layout: Positions your items/buttons, e.g. in a grid
  • Sort: Different functions to sort your items before they are positioned, e.g. by quality or bag-position

Ah, and did I mention the internal variable types cargBags has?

  • ItemTable: Holds all info related to a single item
  • BagType: Multiple ways to define a range of bags
  • FilterSet: A set of filter functions for the Filter-sieve

Function and property lists

I still need to write a parser for the documentation, because I'm to lazy to update it manually. In the meantime, please look into the cargBags-files for a complete API-listing.