WoWInterface/Interface/AddOns/Neuron/Objects/ZONEABILITYBTN.lua

-- Neuron is a World of Warcraft® user interface addon.
-- Copyright (c) 2017-2021 Britt W. Yazel
-- Copyright (c) 2006-2014 Connor H. Chenoweth
-- This code is licensed under the MIT license (see LICENSE for details)

---@class ZONEABILITYBTN : BUTTON @define class ZONEABILITYBTN inherits from class BUTTON
local ZONEABILITYBTN = setmetatable({}, {__index = Neuron.BUTTON}) --this is the metatable for our button object
Neuron.ZONEABILITYBTN = ZONEABILITYBTN

----------------------------------------------------------

---Constructor: Create a new Neuron BUTTON object (this is the base object for all Neuron button types)
---@param bar BAR @Bar Object this button will be a child of
---@param buttonID number @Button ID that this button will be assigned
---@param defaults table @Default options table to be loaded onto the given button
---@return ZONEABILITYBTN @ A newly created ZONEABILITYBTN object
function ZONEABILITYBTN.new(bar, buttonID, defaults)
	--call the parent object constructor with the provided information specific to this button type
	local newButton = Neuron.BUTTON.new(bar, buttonID, ZONEABILITYBTN, "ZoneAbilityBar", "ZoneActionButton", "NeuronActionButtonTemplate")

	newButton.abilityIndex = buttonID

	if defaults then
		newButton:SetDefaults(defaults)
	end

	return newButton
end

----------------------------------------------------------
function ZONEABILITYBTN:SetType()
	self:RegisterUnitEvent("UNIT_AURA", "player")
	self:RegisterEvent("SPELLS_CHANGED", "OnEvent")
	self:RegisterEvent("ZONE_CHANGED", "OnEvent")
	self:RegisterEvent("PLAYER_ENTERING_WORLD", "OnEvent")
	self:RegisterEvent("SPELL_UPDATE_COOLDOWN", "OnEvent")
	self:RegisterEvent("SPELL_UPDATE_CHARGES", "OnEvent")

	self:SetAttribute("type1", "macro")

	self:SetSize(52,52)
	self.Style:SetPoint("CENTER", -1.5, 1)

	--macro content gets set in UpdateData
	self:UpdateData()

	self:SetScript("OnDragStart", function(self)
		if self.spellID then
			PickupSpell(self.spellID)
		end
	end)

	self:SetScript("PostClick", function() self:SetChecked(false) end)
	self:SetScript("OnEnter", function(self) self:UpdateTooltip() end)
	self:SetScript("OnLeave", GameTooltip_Hide)

	self:SetSkinned()
end

function ZONEABILITYBTN:OnEvent(event, ...)
	self:UpdateData()

	if event == "PLAYER_ENTERING_WORLD" then
		self.Binder:ApplyBindings()
		self:UpdateIcon()
	end
end

---overwrite function in parent class BUTTON
function ZONEABILITYBTN:UpdateData()
	--get table with zone ability info. The table has 5 values, "zoneAbilityID", "uiPriority", "spellID", "textureKit", and "tutorialText"
	local zoneAbilityTable = C_ZoneAbility.GetActiveAbilities()

	--TODO: figure out a way to use the fancy texture style even when having multiple zone abilities at once
	self.disableStyle = #zoneAbilityTable > 1

	table.sort(zoneAbilityTable, function(a, b) return a.uiPriority < b.uiPriority end);

	if zoneAbilityTable[self.abilityIndex] then
		self.spellID = zoneAbilityTable[self.abilityIndex].spellID
		self.textureKit = zoneAbilityTable[self.abilityIndex].textureKit
	else
		self.spellID = nil
		self.textureKit = nil
	end

	if self.spellID then
		self.spell = GetSpellInfo(self.spellID);
		if self.spell and not InCombatLockdown() then
			self:SetAttribute("macrotext1", "/cast " .. self.spell .. "();")
		end
	else
		self.spell = nil
	end

	self.Name:Hide()

	self:UpdateObjectVisibility()
	self:UpdateIcon()
	self:UpdateCooldown()
	--zone ability button charges (I'm not sure if zone abilities have charges, but this is just in case)
	self:UpdateCount()
	--make sure our button gets the correct Normal texture if we're not using a Masque skin
	self:UpdateNormalTexture()
end

function ZONEABILITYBTN:UpdateObjectVisibility()
	if self.spellID then
		self.isShown = true
	else
		self.isShown = false
	end

	Neuron.BUTTON.UpdateObjectVisibility(self) --call parent function
end

--overwrite function in parent class BUTTON
function ZONEABILITYBTN:UpdateIcon()
	local spellTexture = GetSpellTexture(self.spellID)
	self.Icon:SetTexture(spellTexture);

	local texture = self.textureKit or "Interface\\ExtraButton\\GarrZoneAbility-Armory"

	if C_Texture.GetAtlasInfo(texture) then
		self.Style:SetAtlas(texture, true);
	elseif texture then
		self.Style:SetTexture(texture);
	end

	if not self.disableStyle and self.abilityIndex == 1 and self.bar.data.showBorderStyle then
		self.Style:Show()
	else
		self.Style:Hide()
	end
end

function ZONEABILITYBTN:UpdateTooltip()
	if not self.isShown then
		return
	end

	if self.bar then
		if self.tooltipsCombat and InCombatLockdown() then
			return
		end

		if self.tooltips then
			GameTooltip:SetOwner(self, "ANCHOR_RIGHT")
			if self.tooltipsEnhanced and self.spellID then
				GameTooltip:SetSpellByID(self.spellID)
			elseif self.spell then
				GameTooltip:SetText(self.spell)
			end
			GameTooltip:Show()
		end
	end
end