Grid

From WowAce Wiki
Jump to: navigation, search
Summary
Grid
A modular, lightweight and screen-estate saving grid of party/raid unit frames
TOC 2.4 (20400)
Category UnitFrame Addons
Authors Pastamancer, Maia
Details
Version $Rev$
Embeds Ace2, LibBabble-Class-3.0, LibBabble-Spell-3.0, LibBanzai-2.0, CallbackHandler-1.0, DewdropLib, FuBarPlugin-2.0, LibGratuity-3.0, LibHealComm-3.0, RosterLib, LibSharedMedia-3.0, SpecialEventsEmbed, UTF8
OptionalDeps ChatThrottleLib, SpecialEvents-Aura-2.0, Clique, CT_RaidAssist, FuBar, JustClick, oRA2, SharedMedia
Links
Releases WoWI Curse
Betas Ace SVN Zip
Changelog FishEye

Recent Happenings

Grid with lots of status modules turned on
Grid using the 40man raid layout
Configuring the frame settings.
Configuring the layout settings.
Configuring the aura settings.

I re-did GridStatusRange to allow for multiple range checks. If you update to r63429 or newer, you'll need to re-configure your range statuses.

As of r60889, Grid is now using LibHealComm-3.0 instead of CastCommLib for sending and receiving incoming heals.

If you update Grid to a version >= r60889, make sure the rest of your raid group updates too so you can all see incoming heals.

About Grid

Grid is a modular, lightweight and screen-estate saving grid of party/raid unit frames based on Ace2 and various embedded libraries provided by the Ace-community. It's currently in beta.


Read This

Due to its flexible design, Grid has a fairly daunting configuration menu. I suggest taking a few minutes to look through the configuration and familiarize yourself with the options available to you.

Before making a feature request or a bug report, check out our User Guide, frequently asked questions (FAQ), ToDo list and our wish list. You might also want to check the list of Grid modules that other people have written.

If you're interested in writing a status module for Grid, check out the developer documentation.

How to report a bug

Before reporting a bug, check the bugtracker to see if the bug you were going to report has already been reported!

After verifying that your bug hasn't been reported (or resolved!), create a new ticket. When entering the ticket, the project must be 'Grid'.

Please be sure to include the following information in the "description" section of the ticket:

  • Grid version (ex: r16623 from wowace.com/files)
  • WoW version (ex: 1.12 enUS)
  • What you were doing when the bug occured
  • What happened (ie. what the bug is)
  • Any error messages if applicable (Please use BugSack to get a full stack trace for the error message)
  • A complete list of addons you have installed
  • A screenshot if it is a graphical bug


Design overview

Grid is based on the concept of statuses and indicators.

Each indicator can only show one status at a time. This is where the priority system comes into play. The highest priority in-range status will be displayed. Indicators are only updated when a status is gained or lost on the unit. Status setting changes only take effect when a new StatusGained event is sent.

Each status consists of the following:

name
The internal name used by Grid to identify the status.
description
The name displayed in Grid's menus.
priority
A number from 0 (lowest) to 99 (highest).
range (optional)
If specified, the status will only be shown if the unit is within range yards of the player.
color
A color (including alpha) to be used when the status is displayed.
text
A short message to be used when the status is displayed.
value (optional)
If specified, value will be used to set the current value of a statusbar indicator.
maxValue (optional)
If specified, maxValue will be used to set the maximum value of a statusbar indicator.
texture (optional)
If specified, texture will be used to display an image.

The GridFrame module implements several indicators:

Center Text
Grid Frame CenterText.png
Displays the text of the status using the color.
Border
Grid Frame Border.png
Displays the color of the status as a 2px border around the unit frame.
Health Bar
Grid Frame HealthBar.png Grid Frame HealthBar Inverted.png Grid Frame HealthBar Damaged.png
Sets the value of the health bar based on value and maxValue. Sets the color based on the color.
Healing Bar
Grid Frame HealingBar.png Grid Frame HealingBar Horizontal.png
Sets the value of the healing bar based on value and maxValue.
Four Corners (top left, top right, bottom left, bottom right)
Grid Frame TopLeftCorner.png Grid Frame TopRightCorner.png Grid Frame BottomLeftCorner.png Grid Frame BottomRightCorner.png
Displays the color of the status as a small box in the corner of the unit frame.
Center Icon
Grid Frame CenterIcon.png
Displays the texture of the status as an icon in the center of the unit frame.
Frame Alpha
Grid Frame Alpha.png
Sets the alpha (fade) of the frame based on the alpha of the color.


Credits

  • pastamancer: core, complete conversion to OO, modules
  • maia: initial concept, UI design, status modules
  • Mikk: icon
  • kaybe: german localization
  • JoshBorke: API documentation
  • Jerry: Pet support
  • Julith: HealComm usage