Authors CurseForge

Perhaps there whould be a separate thread (or perhaps a wiki page) for this, but I'd like to start talking about how Grid would be modularized and what the API will look like.

I see a few different classes/modules:

GridCore
-- (main addon): manages unit list and basic events (hp, mana, auras)
-- also watches for PLAYER_REGEN_ENABLED/PLAYER_REGEN_DISABLED to queue sorting/positioning if in-combat
--
-- roster events
:UpdateRoster()
-- relay status message from GridStatus instance to appropriate GridFrame instance(s)
:StatusGained(string unitid, string category, string status, number priority, string color, string text or "")
:StatusLost(string unitid, string status)
-- unit attributes for use by GridStatus/GridSort plugins
string name = :GetUnitName(string unitid)
string class = :GetUnitClass(string unitid)
number subGroup = :GetUnitSubgroup(string unitid)
number hp, number hpMax = :GetUnitHealth(string unitid)
number mana, number manaMax = :GetUnitMana(string unitid)
table auras = :GetUnitAuras(string unitid)
boolean hasAura = :UnitHasAura(string unitid, string texture)

GridFrame
-- (class): defines an individual unit frame, tied to a unitid
-- is also responsible for determining how to display a status event
--
:SetUnit(string unitid)
string unitid = :GetUnit()
-- unit status events
:StatusGained(string status, number priority, string color, string text or "")
:StatusLost(string status)
-- frame size
number x = :GetHeight()
number y = :GetWidth()

GridLayout
-- (class): places GridFrames relative to the main anchor
--
:PlaceFrame(GridFrame frame, number group, number member)
-- spacing and scaling
:SetFrameSpacing(number x, number y)
number x, number y = :GetFrameSpacing()
:SetGroupSpacing(number spacing)
number spacing = :GetGroupSpacing()
:SetScale(number scale)
number scale = :GetScale()

GridSort
-- (class): sorts available units and provides a tuple (group, member) for the active GridLayout.
-- it should be possible to cache the sort results and provide instant lookup of unitid to (group, member) tuple.
--
:SortedUnitIterator() -- each call of the function returned by the iterator returns: string unitid, number group, number member
number group, number member = :GetUnitPosition(string unitid)
:UpdateSort()

GridStatus
-- (class): plugins that watch for special events (low health, debuffs, aggro)
--

Categories for status events
DEBUFF (POISON, MAGIC, DISEASE, CURSE, PW:SHIELD, BANDAGED, etc.)
HOT (RENEW, REGROWTH, etc.)
BUFF_MISSING ( PW:FORT, AI, MOTW, etc.)
BUFF_GAINED ( POWER_INFUSION, INNERVATE, SOULSTONE, etc.)
ALERT ( AGGRO, LOW_HEALTH, LOW_MANA, etc.)
OTHER ( ??? )


Alternatively, I could see adding a GridLayoutGroup class with its own GridFilter and GridSort classes/functions so that you could have a group containing just the tanks in addition to your regular raid view by group. I don't know if you'd want to go through the trouble to allow multiple frames for the same unitid though.

That might work something like this:

function classes.prototype.GridLayoutGroup:RosterUpdate()
  local _,unitid

  if Compost then
    self.units = Compost:Erase(self.units)
  else
    self.units = {}
  end

  for unitid in self:GridSortIterator(self:GridFilter(GridCore.units)) do
    tinsert(self.units, unitid)
  end

  self:UpdateFrames()
end

Something you can use for textures =)