Family Fighter Helper?!

[Flohsakk]

Thanks to Gello's "easy to implement future achievements" description I wanted to update the addon for the upcoming Family Exorcist achievement. Unfortunatley it's only showing a (nearly) blank frame, so 9.0 changes must be covered by Gello.

At least I can help with IDs now:

Code: Select all

ffh.achievementFamilies = { 9696, 12100, 12290, 13279, 14879 }

Code: Select all

	  [5] = { 14874, 14871, 14873, 14877, 14870, 14875, 14872, 14869, 14868, 14876 }, -- Family Exorcist

Code: Select all

   -- Family Exorcist npcIDs
   ["173129"]=5, ["173130"]=5, ["173131"]=5, ["173257"]=5, ["173263"]=5,
   ["173267"]=5, ["173315"]=5, ["173324"]=5, ["173331"]=5, ["173372"]=5,
   ["173377"]=5,

[Gello]

I'll take a look. I confess this slipped past my radar so thanks for pointing it out and putting the data together!

[Gello]

Looks like it was just the Backdrop bit so it was an easy fix. I'll post it Tuesday along with all my other 9.0-ready addons.

But if you want something to test/experiment with today/tomorrow:

Code: Select all

-- To add new family <something> achievements in future patches:
--    1) add the achievementID to ffh.achievementFamilies
--    2) add the 10 pet type achievements to ffh.achievementIDs to a new sub-table
--    3) add the npcIDs to the ffh.notableNPCs table, giving them a value to their achievement family index
-- Unless something weird is added like a new pet type, that should be all that's necessary. The above will
-- add a new tab named after the achievement and going to the new tab will list achievement's NPCs.

-- key binding globals for Bindings.xml
BINDING_HEADER_FAMILYFAMILIARHELPER = "Family Familiar Helper"
BINDING_NAME_FAMILYFAMILIARHELPER_TOGGLE = "Toggle Window"

FamilyFamiliarHelperSettings = {} -- savedvariable

local ffh = CreateFrame("Frame","FamilyFamiliarHelper",UIParent,"BasicFrameTemplateWithInset")
ffh:Hide()
ffh:SetMovable(true)
ffh:SetSize(460,368)
ffh:SetPoint("CENTER")
ffh:SetFrameStrata("HIGH")
ffh:SetFlattensRenderLayers(true) -- makes frame behave like toplevel without click-to-front bit

-- add achievement IDs to the end of this list to add new tabs (tabs are displayed in reverse order)
-- 1=Family Familiar, 2=Family Fighter, 3=Family Brawler, 4=Family Battler
ffh.achievementFamilies = { 9696, 12100, 12290, 13279, 14879 }

-- sub-achievement IDs grouped under their achievement and in the order of PET_TYPE_SUFFIXes
-- 1=humanoid, 2=dragonkin, 3=flying, 4=undead, 5=critter, 6=magic, 7=elemental, 8=beast, 9=aquatic, 10=mechanical
-- add the 10 sub-achievements to this table when a new tab/family achievement is added
ffh.achievementIDs = {
      [1] = { 9692, 9689, 9691, 9695, 9688, 9693, 9690, 9687, 9686, 9694 }, -- Family Familiar
      [2] = { 12096, 12093, 12095, 12099, 12092, 12097, 12094, 12091, 12089, 12098 }, -- Family Fighter
	  [3] = { 12289, 12287, 12286, 12285, 12284, 12283, 12282, 12281, 12280, 12279 }, -- Family Brawler
     [4] = { 13281, 13272, 13274, 13278, 13271, 13275, 13273, 13270, 13280, 13277 }, -- Family Battler
     [5] = { 14874, 14871, 14873, 14877, 14870, 14875, 14872, 14869, 14868, 14876 }, -- Family Exorcist
}

-- lookup table for the npcIDs involved in the achievements; value is the index to the above achievementID group
-- (ex 1=family familiar, 2=family fighter); key is a string since it's pulled out of a GUID string
ffh.notableNPCs = {
   -- Family Familiar npcIDs
   ["98270"]=1, ["99210"]=1, ["105674"]=1, ["97804"]=1, ["99182"]=1,
   ["104970"]=1, ["107489"]=1, ["104553"]=1, ["97709"]=1, ["99150"]=1,
   ["105250"]=1, ["99035"]=1, ["99077"]=1, ["106552"]=1, ["105455"]=1,
   -- Family Fighter npcIDs
   ["128007"]=2, ["128009"]=2, ["128011"]=2, ["128013"]=2, ["128014"]=2,
   ["128017"]=2, ["128019"]=2, ["128021"]=2, ["128023"]=2, ["128008"]=2,
   ["128010"]=2, ["128012"]=2, ["128015"]=2, ["128016"]=2, ["128018"]=2,
   ["128020"]=2, ["128022"]=2, ["128024"]=2,
   -- Family Brawler has no npcIDs; it's "Battle #1" through "Battle #10"
   -- Family Battler npcIDs
   ["139489"]=4, ["140461"]=4, ["140880"]=4, ["141046"]=4, ["141292"]=4,
   ["141529"]=4, ["141814"]=4, ["141945"]=4, ["142096"]=4, ["142234"]=4,
   ["140315"]=4, ["140813"]=4, ["141002"]=4, ["141077"]=4, ["141479"]=4,
   ["141799"]=4, ["141879"]=4, ["142054"]=4, ["142114"]=4,
   -- Family Exorcist npcIDs
   ["173129"]=5, ["173130"]=5, ["173131"]=5, ["173257"]=5, ["173263"]=5,
   ["173267"]=5, ["173315"]=5, ["173324"]=5, ["173331"]=5, ["173372"]=5,
   ["173377"]=5,   
}

ffh.criterias = {} -- numerically indexed list of criteria (npc name) for display sort purposes
ffh.progress = {} -- indexed by criterea (npc name), sub-table of 10 types and whether completed
-- ie ffh.progress[1]["Tiffany Nelson"]={nil,nil,true,nil,true,nil,nil,nil,nil,true}

-- this adds a sub-table for each achievement family to .criterias and .progress, so for 7.3 ffh.criterias will
-- start as {{},{}}, a subgroup for each achievement family
for i=1,#ffh.achievementFamilies do
   tinsert(ffh.criterias,{})
   tinsert(ffh.progress,{})
end

ffh.firstRun = true -- becomes nil after the first setup

-- when the frame is shown, the UI is created if needed, and everything updated
function ffh:OnShow()
   ffh:SetupUI() -- set up the display if it hasn't been set up before
   ffh:UpdateUI() -- update the display's contents
end

-- this updates the ffh.progress table with each achievement's completed criteria
function ffh:UpdateProgress()
   for achievementFamily=1,#ffh.achievementFamilies do
      for petType,achievementID in ipairs(ffh.achievementIDs[achievementFamily]) do
         if achievementFamily==3 then -- for family brawler which doesn't have npc criteria
            local _,_,_,battlesWon = GetAchievementCriteriaInfo(achievementID,1)
            for criteria=1,10 do
               -- instead of npc names, using "Win # 1", "Win # 2", etc for names of criteria
               local name = format("%s #%2d", WIN, criteria)
               if not ffh.progress[achievementFamily][name] then
                  ffh.progress[achievementFamily][name] = {}
                  tinsert(ffh.criterias[achievementFamily],name)
               end
               ffh.progress[achievementFamily][name][petType] = battlesWon>=criteria
            end
         else
            for criteria=1,GetAchievementNumCriteria(achievementID) do
               local name,_,completed = GetAchievementCriteriaInfo(achievementID,criteria)
               if not ffh.progress[achievementFamily][name] then -- name not encountered before, set up its table and add to list
                  ffh.progress[achievementFamily][name] = {}
                  tinsert(ffh.criterias[achievementFamily],name)
               end
               ffh.progress[achievementFamily][name][petType] = completed
            end
         end
      end
   end
end

-- this updates the display depending on the active tab
function ffh:UpdateUI()

   if ffh:IsVisible() then

      local tab = FamilyFamiliarHelperSettings.ActiveTab

      ffh:UpdateProgress() -- update ffh.progress with how far along each achievement is
      ffh:UpdateOptions() -- update checkbutton options and ESCability

      local numCriterias = #ffh.criterias[tab]
      for i=1,numCriterias do
         local button = ffh.ListButtons[i]
         local name = ffh.criterias[tab][i]
         button.Name:SetText(name) -- sets the name label
         button.name = name -- and saves it for comparison to highlight
         for j=1,10 do -- light up pet types in the row that have been completed
            button[j]:SetAlpha(ffh.progress[tab][name][j] and 1 or 0.125)
         end
         button:Show()
      end
      -- hide any remaining rows not visible in this tab
      for i=numCriterias+1,#ffh.ListButtons do
         ffh.ListButtons[i]:Hide()
      end
      ffh:UpdateHighlight() -- update targeted highlight (orange border around row)
      ffh:SetHeight(68+20*numCriterias) -- adjust window height for number of criterias
      -- and total up pet types
      for i=1,10 do
         local total = 0
         for j=1,numCriterias do
            if ffh.progress[tab][ffh.criterias[tab][j]][i] then
               total = total + 1
            end
         end
         -- if achievement has been completed, display a green check instead of a number
         local _,_,_,completed = GetAchievementInfo(ffh.achievementIDs[tab][i])
         ffh.HeaderIcons[i].Total:SetText(completed and "\124TInterface\\RaidFrame\\ReadyCheck-Ready:18\124t" or total)
      end
   end
end

-- mouseover of header will show the achievement's tooltip
local function headerOnEnter(self)
   GameTooltip:SetOwner(self,"ANCHOR_LEFT")
   GameTooltip:SetHyperlink(GetAchievementLink(ffh.achievementIDs[FamilyFamiliarHelperSettings.ActiveTab][self:GetID()]))
   GameTooltip:Show()
   GameTooltip:ClearAllPoints()
   GameTooltip:SetPoint("BOTTOMRIGHT",ffh,"BOTTOMRIGHT",-6,32)
   GameTooltip:SetBackdrop(ffh.newTooltipBackdrop)
   GameTooltip:SetBackdropColor(0.05,0.05,0.05)
end

local function hideTooltip(self)
   GameTooltip:Hide()
   GameTooltip:SetBackdrop(ffh.oldTooltipBackdrop)
   GameTooltip:SetBackdropColor(0.09,0.09,0.2)
end

-- remove any achievements that don't exist (in case running on live client and new achievement added on PTR)
function ffh:RemoveFutureAchievements()
	for i=#ffh.achievementFamilies,1,-1 do
		if not GetAchievementInfo(ffh.achievementFamilies[i]) then
		   tremove(ffh.achievementFamilies,i)
		   if FamilyFamiliarHelperSettings.ActiveTab == i then
				FamilyFamiliarHelperSettings.ActiveTab = 1
		   end
		end
	end
end

-- called during the OnShow: sets up the UI if it hasn't been setup already
function ffh:SetupUI()
   if ffh.firstRun then
      ffh.firstRun = nil
      ffh.TitleText:SetText(format("Family Familiar Helper \124cffa0a0a0v%s",GetAddOnMetadata("FamilyFamiliarHelper","Version")))
      ffh.TitleText:SetPoint("TOP",-6,-5)
      ffh.InsetBg:SetPoint("BOTTOMRIGHT",-6,32)
	  -- first go through and remove any achievements that don't exist (in case running on live client and new achievements added on PTR)
	  ffh:RemoveFutureAchievements()
      -- set up rows
      ffh:UpdateProgress() -- need to gather criterias to know how many rows to make
      -- sort the criterias; also note max number of criterias for each list
      local maxCriterias = 0
      for i=1,#ffh.criterias do
         table.sort(ffh.criterias[i]) -- sort the name of the criteria
         maxCriterias = max(maxCriterias,#ffh.criterias[i])
      end
      ffh.ListButtons = {}
      -- now make each row
      for i=1,maxCriterias do
         ffh.ListButtons[i] = ffh:CreateListButton(i)
         ffh.ListButtons[i]:SetPoint("TOPLEFT",11,-36-i*20+26)
         for j=1,10 do -- 10 type buttons for each row
            ffh.ListButtons[i][j] = ffh.ListButtons[i]:CreateTexture(nil,"ARTWORK")
            ffh.ListButtons[i][j]:SetSize(22,22)
            ffh.ListButtons[i][j]:SetPoint("RIGHT",-(10-j)*28,0)
            ffh.ListButtons[i][j]:SetTexture("Interface\\Icons\\Pet_Type_"..PET_TYPE_SUFFIX[j])
            ffh.ListButtons[i][j]:SetAlpha(0.1)
         end
      end
      -- set up header icons
      ffh.HeaderIcons = {}
      for i=1,10 do -- for 10 pet types
         local button = CreateFrame("Button",nil,ffh)
         ffh.HeaderIcons[i] = button
         button:SetSize(28,28)
         local xoffset = ffh.ListButtons[1][i]:GetCenter() - ffh:GetLeft() -- align with columns but don't anchor to them
         button:SetPoint("BOTTOM",ffh,"BOTTOMLEFT",xoffset,3) -- anchor to bottom of window instead
         button:SetNormalTexture("Interface\\PetBattles\\PetIcon-"..PET_TYPE_SUFFIX[i])
         local normal = button:GetNormalTexture()
         normal:SetTexCoord(0.4921875,0.796875,0.50390625,0.65625)
         normal:SetVertexColor(0.5,0.5,0.5)
         button:SetHighlightTexture("Interface\\PetBattles\\PetBattleHUD")
         local highlight = button:GetHighlightTexture()
         highlight:SetTexCoord(0.884765625,0.943359375,0.681640625,0.798828125)
         button.Total = button:CreateFontString(nil,"OVERLAY","GameFontNormalLargeOutline")
         button.Total:SetPoint("CENTER",ffh.HeaderIcons[i],"CENTER",0,0)
         button.Total:SetTextColor(1,1,1)
         button:SetID(i)
         button:SetScript("OnEnter",headerOnEnter)
         button:SetScript("OnLeave",hideTooltip)
      end
      -- total label to left of headers
      local total = ffh:CreateFontString(nil,"ARTWORK","GameFontNormalLarge")
      total:SetText(TOTAL)
      total:SetPoint("RIGHT",ffh.HeaderIcons[1].Total,"LEFT",-14,0)
      -- option checkboxes
      local lock = ffh:CreateCheck("Locked","Lock Window","While checked, this window cannot be dismissed with the ESCape key, nor can it be dragged around the screen unless [Shift] is held.")
      lock:SetPoint("BOTTOMLEFT",8,4)
      local autoShow = ffh:CreateCheck("AutoShow","Auto Show","While checked, anytime you target one of the Family Familiar tamers, this window will show.\n\nIf this is unchecked you can still summon the window with the \124cffffffff/ffh\124r command or key binding.")
      autoShow:SetPoint("LEFT",lock,"RIGHT",-4,0)
      local justOnce = ffh:CreateCheck("JustOnce","Just Once","While checked, Auto Show will summon the window only the first time you target a Family Familiar tamer, until you've moved on to another tamer.")
      justOnce:SetPoint("LEFT",autoShow,"RIGHT",-4,0)
      -- tabs across bottom of window
      ffh.Tabs = {}
      ffh.maxTabWidth = 128 -- default max width is 88; 128 gives some room for localization
      ffh.numTabs = #ffh.achievementFamilies -- number of tabs is number of Family X achievements (two as of 7.3)
      -- create tabs from most recent family X achievement to oldest (reverse order of their index)
      for i=ffh.numTabs,1,-1 do
         local _,name = GetAchievementInfo(ffh.achievementFamilies[i]) -- used localized name of achievement for tab name
         if name then -- confirm achievement exists
            ffh.Tabs[i] = CreateFrame("Button","FamilyFamiliarHelperTab"..i,ffh,"CharacterFrameTabButtonTemplate")
            ffh.Tabs[i]:SetText(name:gsub("Family ",""))
            ffh.Tabs[i]:SetID(i)
            if i==ffh.numTabs then -- first tab (last in list of tabs) anchored to left
               ffh.Tabs[i]:SetPoint("TOPLEFT",ffh,"BOTTOMLEFT",0,1)
            else -- rest of tabs anchor to the previous tab created (+1 since going backwards)
               ffh.Tabs[i]:SetPoint("LEFT",ffh.Tabs[i+1],"RIGHT",-16,0)
            end
            ffh.Tabs[i]:SetScript("OnClick",ffh.PanelTabOnClick)
            ffh.Tabs[i]:GetScript("OnShow")(ffh.Tabs[i]) -- fake an OnShow to get the tab to resize to fit its text
         else -- achievement doesn't exist; we're likely on live and 7.3 hasn't launched yet (or future PTRs)
            ffh.numTabs = i-1 -- change number of tabs to the last valid achievement
            break -- and stop trying other achievements (if they exist)
         end
      end
      local settings = FamilyFamiliarHelperSettings
      PanelTemplates_SetTab(ffh,settings.ActiveTab) -- start at first tab (unless one saved in settings)
      if ffh.numTabs==1 then -- if a single tab exists (7.2.x client) hide the lone tab
         ffh.Tabs[1]:Hide()
      end
      -- position parent window
      if not settings.XPos then -- if coordinates not saved yet, get BOTTOMLEFT of default position
         settings.XPos = ffh:GetLeft()
         settings.YPos = ffh:GetBottom()
      end
      -- and anchor it to saved position
      ffh:ClearAllPoints()
      ffh:SetPoint("BOTTOMLEFT",settings.XPos,settings.YPos)
      if IsAddOnLoaded("ElvUI") then
         ffh:SkinForElvUI()
      end
   end
end

-- called during SetupUI if ElvUI is loaded
function ffh:SkinForElvUI()
   if ElvUI then
      local E = unpack(ElvUI)
      local S = E:GetModule("Skins")
      ffh:StripTextures()
      ffh:SetTemplate("Transparent")
      S:HandleCloseButton(ffh.CloseButton)
      S:HandleCheckBox(ffh.Locked)
      S:HandleCheckBox(ffh.AutoShow)
      S:HandleCheckBox(ffh.JustOnce)
      local index = 1
      while _G["FamilyFamiliarHelperTab"..index] do
         S:HandleTab(_G["FamilyFamiliarHelperTab"..index])
         index = index + 1
      end
   end
end

function ffh:OnHide()
   ffh:UpdateESCability(true)
end

local function listOnEnter(self) self.Back:Show() end
local function listOnLeave(self) self.Back:Hide() end

-- formerly a template
function ffh:CreateListButton(index)
   local button = CreateFrame("Button",nil,ffh)
   button:SetSize(436,20)
   button.Name = button:CreateFontString(nil,"ARTWORK","GameFontHighlight")
   button.Name:SetSize(162,20)
   button.Name:SetPoint("LEFT",2,0)
   button.Name:SetJustifyH("LEFT")
   button.Back = button:CreateTexture(nil,"BACKGROUND")
   button.Back:SetAllPoints(true)
   button.Back:SetColorTexture(0.25,0.75,1.0,0.15)
   button.Back:Hide()
   -- highlight is a frame with a 1px gold border
   button.Highlight = CreateFrame("Frame",nil,button,"BackdropTemplate")
   button.Highlight:SetBackdrop({edgeFile="Interface\\ChatFrame\\ChatFrameBackground",edgeSize=1})
   button.Highlight:SetBackdropBorderColor(1,0.82,0,0.75)
   button.Highlight:SetPoint("TOPLEFT",-2,2)
   button.Highlight:SetPoint("BOTTOMRIGHT",2,-2)
   button:SetScript("OnEnter",listOnEnter)
   button:SetScript("OnLeave",listOnLeave)
   return button
end

--[[ Handler stuff ]]

-- used by Bindings.xml and LDB button in addition to slash command
function ffh:Toggle()
   ffh:SetShown(not ffh:IsVisible())
end

-- slash handler (/ffh to toggle window)
SlashCmdList["FFH"] = ffh.Toggle
SLASH_FFH1 = "/ffh"

-- event/script handlers
ffh:SetScript("OnShow",ffh.OnShow)
ffh:SetScript("OnHide",ffh.OnHide)
ffh:SetScript("OnMouseDown",function(self)
   if not FamilyFamiliarHelperSettings.Locked or IsShiftKeyDown() then
      self:StartMoving()
   end
end)
ffh:SetScript("OnMouseUp",function(self)
   self:StopMovingOrSizing()
   -- save anchor positions (with frame changing height, want to keep bottom of frame stationary)
   local settings = FamilyFamiliarHelperSettings
   settings.XPos = ffh:GetLeft()
   settings.YPos = ffh:GetBottom()
   ffh:ClearAllPoints()
   ffh:SetPoint("BOTTOMLEFT",settings.XPos,settings.YPos) -- re-anchor from potential "CENTER" imposed by StartMoving()
end)

ffh:SetScript("OnEvent",function(self,event,...)
   ffh[event](self,...)
end)

function ffh:PLAYER_LOGIN()
   -- set up defaults
   for var,default in pairs({AutoShow=true,JustOnce=true,ActiveTab=1}) do
      if FamilyFamiliarHelperSettings[var]==nil then
         FamilyFamiliarHelperSettings[var] = default
      end
   end
   ffh:UpdateOptions()
   ffh.oldTooltipBackdrop = GameTooltip:GetBackdrop()
   if ffh.oldTooltipBackdrop then
     ffh.newTooltipBackdrop = CopyTable(ffh.oldTooltipBackdrop)
     ffh.newTooltipBackdrop.bgFile = "Interface\\ChatFrame\\ChatFrameBackground"
   end
   -- add launcher button for LDB if it exists
	local ldb = LibStub and LibStub:GetLibrary("LibDataBroker-1.1",true)
   if ldb then
	  ldb:NewDataObject("FamilyFamiliarHelper",{ type="launcher", icon="Interface\\Icons\\Icon_PetFamily_Beast", iconCoords={0.075,0.925,0.075,0.925}, tooltiptext="Family Familiar Helper", OnClick=ffh.Toggle })
	end

end
ffh:RegisterEvent("PLAYER_LOGIN")

-- registered if AutoShow enabled; if one of the notableNPCs is targeted then summons window
-- unless it's already been summoned or JustOnce is unchecked.
function ffh:PLAYER_TARGET_CHANGED()
   local npcID
   if UnitExists("target") then
      local guid = UnitGUID("target")
      if guid then
         local settings = FamilyFamiliarHelperSettings
         npcID = guid:match(".-%-%d+%-%d+%-%d+%-%d+%-(%d+)")
		 local npcTab = ffh.notableNPCs[npcID]
		 if npcTab and ffh.firstRun then -- if npc is notable and this is first run, then npc may be involved in an achievement not active
			ffh:RemoveFutureAchievements() -- remove this npc if so
		 end
		 if npcTab then
			if ffh.achievementFamilies[ffh.notableNPCs[npcID]] and (not settings.JustOnce or npcID~=ffh.lastInteracted) then
				ffh.lastInteracted = npcID
				ffh:Show()
			end
			-- if frame is on screen and we're on the wrong tab for the target, switch to the right tab
			if ffh:IsVisible() and settings.ActiveTab~=npcTab then -- this npcID is in a different tab than the one we're presently in
				settings.ActiveTab = npcTab -- switch tab to this npc's tab
				PanelTemplates_SetTab(ffh,npcTab)
				ffh:UpdateUI() -- and update now that we're on right tab
			end
	 	end
      end
   end
   -- if window is up, highlight current target
   if ffh:IsVisible() then
      ffh:UpdateHighlight()
   end
end

-- called when window shown and target changes while window up; to highlight the targeted tamer
function ffh:UpdateHighlight()
   local target = UnitName("target")
   for _,button in ipairs(ffh.ListButtons) do
      button.Highlight:SetShown(button.name==target)
   end
end

-- click of any of the tabs across the bottom. As of 7.3, either Family Familiar or Family Fighter
function ffh:PanelTabOnClick()
   FamilyFamiliarHelperSettings.ActiveTab = self:GetID() -- remember this tab so we return to it in future sessions
   PanelTemplates_SetTab(ffh,self:GetID())
   ffh:UpdateUI()
end

--[[ Options ]]

-- run at PLAYER_LOGIN, OnShow and checkOnClick to update whether PLAYER_TARGET_CHANGED
-- is registered, the on-screen checkbuttons and the ESCability of the window.
-- run at PLAYER_LOGIN and checkOnClick: registers/unregisters for the targeting event based on AutoShow
-- and whether the frame is in UISpecialFrames
function ffh:UpdateOptions()
   local settings = FamilyFamiliarHelperSettings
   local registered = ffh:IsEventRegistered("PLAYER_TARGET_CHANGED")
   if settings.AutoShow and not registered then
      ffh:RegisterEvent("PLAYER_TARGET_CHANGED")
   elseif not settings.AutoShow and registered then
      ffh:UnregisterEvent("PLAYER_TARGET_CHANGED")
   end
   if ffh:IsVisible() then
      ffh.Locked:SetChecked(settings.Locked)
      ffh.AutoShow:SetChecked(settings.AutoShow)
      ffh.JustOnce:SetChecked(settings.JustOnce)
      ffh.JustOnce:SetShown(settings.AutoShow)
      ffh:UpdateESCability()
      ffh:UpdateHighlight()
   end
end

-- OnEnter of one of the checkbuttons shows its tooltip to explain what it does
local function checkOnEnter(self)
   GameTooltip:SetOwner(self,"ANCHOR_RIGHT")
   GameTooltip:AddLine(self.tooltipTitle,1,1,1)
   GameTooltip:AddLine(self.tooltipBody,nil,nil,nil,true)
   GameTooltip:Show()
   GameTooltip:ClearAllPoints()
   GameTooltip:SetPoint("BOTTOMLEFT",ffh,"BOTTOMLEFT",6,32)
   GameTooltip:SetBackdrop(ffh.newTooltipBackdrop)
   GameTooltip:SetBackdropColor(0.05,0.05,0.05)
end

-- OnClick will toggle the settings and update
local function checkOnClick(self)
   FamilyFamiliarHelperSettings[self.var] = self:GetChecked() and true -- make sure it's true/false
   ffh:UpdateOptions()
end

function ffh:CreateCheck(name,title,body)
   ffh[name] = CreateFrame("CheckButton",nil,ffh,"UICheckButtonTemplate")
   ffh[name]:SetSize(26,26)
   ffh[name]:SetScript("OnEnter",checkOnEnter)
   ffh[name]:SetScript("OnLeave",hideTooltip)
   ffh[name]:SetScript("OnClick",checkOnClick)
   ffh[name].tooltipTitle = title
   ffh[name].tooltipBody = body
   ffh[name].var = name
   return ffh[name]
end

-- while Locked is unchecked, the frame only exists in UISpecialFrames while it's on screen
function ffh:UpdateESCability(hide)
   if FamilyFamiliarHelperSettings.Locked or not ffh:IsVisible() or hide then
      for i=#UISpecialFrames,1,-1 do
         if UISpecialFrames[i]=="FamilyFamiliarHelper" then
            tremove(UISpecialFrames,i)
         end
      end
   elseif not tContains(UISpecialFrames,"FamilyFamiliarHelper") then
      tinsert(UISpecialFrames,"FamilyFamiliarHelper")
   end
end

Also as you can imagine adding a new tab has gone beyond the edge of the window. So I've removed "Family " from the tab names. "Family Exorcist", "Family Battler", "Family Brawler", etc. are now "Exorcist", "Battler", "Brawler", etc. Unfortunately this isn't a good solution for non-English clients. I'll need to make that a scrollframe to scroll through tabs. That's something I don't have time for now I'm afraid.

[Flohsakk]

Thank you, will try it. And collecting data is no big support, but at least something...

[Flohsakk]

We have our 10.0 Family Battler achievement. Unfortunately, it's another Battler, so I named the tab "10.0 Battler" in ffh.tabNames

Here's the stuff I changed/added:

Code: Select all

ffh.achievementFamilies = { 9696, 12100, 12290, 13279, 14879, 16512 }

Code: Select all

      [6] = { 16508, 16505, 16507, 16511, 16504, 16509, 16506, 16503, 16501, 16510 }, -- 10.0 Battler

Code: Select all

   -- 10.0 Battler npcIDs
   ["197417"]=6, ["197102"]=6, ["197336"]=6, ["196264"]=6, ["196069"]=6,
   ["197350"]=6, ["197447"]=6, ["189376"]=6,

[Gello]

Thanks again Flohsakk for the updated data. The tabs are not really sustainable so I've reworked the addon to remove the tabs and make a "home" panel like this:



There's an extra click involved from going back and forth through different achievements but hopefully the progress shown will reduce the need to click around (since presumably a person won't be going from continent to continent as they do these.)

From the changelog of the update just posted to wowinterface/curse/wago:

• To allow for future growth and to allow localized names for achievements, the tabs across the bottom are replaced with a separate "home" panel that has a list of family familiar achievements to choose from. Clicking into one of these will bring you to the progress for that achievement. Clicking the Back button in the progress panel will take you back to the list of achievements again.
• Settings have been moved to their own options panel in the default options interface panel. (Esc to game menu then Interface->AddOns (Shadowlands) or Options->AddOns (Dragonflight))
• The Lock Window option has been split into two options: 'Don't dismiss window with Escape key' and 'Don't move window unless Shift held'
• Added option 'Hide achievement list tooltips' to hide the tooltip for the top-level family familiar achievements.
• When the 'Automatically show on achievement targets' option is enabled, the window will not show if the achievement associated with the target has already been completed or if all criteria that matches the target's name is completed. If a criteria doesn't match a target's name, such as Addius the Tormenter/Tormentor, then this behavior will not kick in for that target and the window will be shown.
• Criteria tooltips have a solid dark color again so they're easier to read against the busy backgrounds.
• The tables to update for future expansions' achievements was reorganized and moved to AchievementInfo.lua.
• Family Familiar of Dragon Isles achievement and criteria added (Thanks Flohsakk!) for Dragonflight clients.
• Beta/PTR users will need to load out of date addons for this to work until the update for the Dragonflight pre-patch.

[Flohsakk]

To make FamilyFamiliarHelper work for the 10.1 Family Battler on PTR...
Add this to AchievementInfo.lua (read Gello's info in the file or just find the pattern, you will see were this needs to be added)

Code: Select all

    -- Family Battler of Zaralek Cavern
    {
        achievementID = 17934,
        criteriaIDs = { 17915, 17890, 17905, 17918, 17883, 17916, 17904, 17882, 17881, 17917 },
        npcIDs = { 201004, 204792, 204926, 204934 },
        criteriaNeeded = 4
    }

Change the part that was hiding Family Familiar of Dragon Isles in AchievementInfo.lua

Code: Select all

if select(4,GetBuildInfo())<100100 then -- until Patch 10.1, Family Battler of Zaralek Cavern should be removed
    tremove(ffh.achievementInfo,7)
end

[Flohsakk]

@Gello
Any chance that you might look into the PetViewer you made? Unfortunately, it's no longer working since last week's PTR Build, I personally and other people would really miss this amazing little thing.

[Gello]

Thanks! I'll add those soon, either this coming weekend or weekend after.

On PetViewer, I only vaguely remember that. Do you know where the code is posted?

[Flohsakk]

On PetViewer, I only vaguely remember that. Do you know where the code is posted?

viewtopic.php?f=19&t=18767&p=145002&hil ... er#p145002

[Gello]

They did something with models and I don't know what yet. I don't know if I'll have time to look at it soon, but I'll see if I can carve some time.

[Gello]

Thanks again Flohsakk for the FFH data. I have an update ready to deploy but going to hold off for the May 2 10.1 patch.

PetViewer is also fixed in the other thread.

[Flohsakk]

With the Meta-Achievement finally added in 11.0.5 here's the data for the 11.0 Family Battler. Don't forget to add a comma after the brackets of the Zaralek Cavern part when you add these lines manually in the AchievementInfo.lua

Code: Select all

    -- Family Battler of Khaz Algar
    {
        achievementID = 40980,
        criteriaIDs = { 40162, 40157, 40161, 40165, 40156, 40163, 40158, 40155, 40154, 40164 },
        npcIDs = { 223446, 223444, 223442, 223443 },
        criteriaNeeded = 4
    }

[Flohsakk]

Here's what you can add to the AchievementInfo.lua file to add the upcoming 11.1 Family Battler, don't forget to add a comma after the brackets of the Khaz Algar one.

Code: Select all

    -- Family Battler of Undermine
    {
        achievementID = 41551,
        criteriaIDs = { 41547, 41544, 41546, 41550, 41541, 41548, 41545, 41543, 41542, 41549 },
        npcIDs = { 237701, 237703, 237712, 237718 },
        criteriaNeeded = 4
    }