WoWInterface/Interface/AddOns/Neuron/Objects/PetButton.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)

local _, addonTable = ...
local Neuron = addonTable.Neuron

---@class PetButton : Button @define class PetButton inherits from class Button
local PetButton = setmetatable({}, { __index = Neuron.Button })
Neuron.PetButton = PetButton

local L = LibStub("AceLocale-3.0"):GetLocale("Neuron")

LibStub("AceEvent-3.0"):Embed(PetButton)
LibStub("AceTimer-3.0"):Embed(PetButton)


---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 PetButton @ A newly created PetButton object
function PetButton.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, PetButton, "PetBar", "PetButton", "NeuronActionButtonTemplate")

	if defaults then
		newButton:SetDefaults(defaults)
	end

	return newButton
end

function PetButton:InitializeButton()
	self:RegisterEvent("PLAYER_ENTERING_WORLD")
	self:RegisterEvent("UNIT_PET")
	self:RegisterEvent("PET_BAR_UPDATE", "UpdateData")
	self:RegisterEvent("PET_BAR_UPDATE_COOLDOWN", "UpdateCooldown")
	self:RegisterEvent("PLAYER_CONTROL_LOST", "UpdateData")
	self:RegisterEvent("PLAYER_CONTROL_GAINED", "UpdateData")
	self:RegisterEvent("PLAYER_FARSIGHT_FOCUS_CHANGED", "UpdateData")
	self:RegisterEvent("PET_BAR_HIDEGRID", "UpdateVisibility")
	self:RegisterEvent("PET_BAR_SHOWGRID", "UpdateVisibility", true)

	if Neuron.isWoWRetail then
		self:RegisterEvent("PET_SPECIALIZATION_CHANGED", "PLAYER_ENTERING_WORLD")
	end

	self.actionID = self.id

	self:SetAttribute("type1", "pet")
	self:SetAttribute("type2", "macro")
	self:SetAttribute("*action1", self.actionID)

	self:SetAttribute("hotkeypri", self.keys.hotKeyPri)
	self:SetAttribute("hotkeys", self.keys.hotKeys)

	self:SetScript("PostClick", function() self:UpdateData() self:UpdateStatus() end)
	self:SetScript("OnDragStart", function() self:OnDragStart() end)
	self:SetScript("OnReceiveDrag", function() self:OnReceiveDrag() end)
	self:SetScript("OnEnter", function() self:UpdateTooltip() end)
	self:SetScript("OnLeave", function() GameTooltip:Hide() end)

	self:SetScript("OnAttributeChanged", nil)

	--force grid to show for now, show/hide grid on the Pet bar is glitchy
	self.bar:SetShowGrid(true)

	self:InitializeButtonSettings()
end

function PetButton:InitializeButtonSettings()
	self:SetFrameStrata(Neuron.STRATAS[self.bar:GetStrata()-1])
	self:SetScale(self.bar:GetBarScale())

	if self.bar:GetShowBindText() then
		self.Hotkey:Show()
		self.Hotkey:SetTextColor(self.bar:GetBindColor()[1],self.bar:GetBindColor()[2],self.bar:GetBindColor()[3])
	else
		self.Hotkey:Hide()
	end

	if self.bar:GetShowButtonText() then
		self.Name:Show()
		self.Name:SetTextColor(self.bar:GetMacroColor()[1],self.bar:GetMacroColor()[2],self.bar:GetMacroColor()[3])
	else
		self.Name:Hide()
	end

	--[[
	if self.bar:GetClickMode() == "UpClick" then
		self:RegisterForClicks("AnyUp")
	elseif self.bar:GetClickMode() == "DownClick" then
		self:RegisterForClicks("AnyDown")
	end
	]]
	self:RegisterForClicks("AnyUp")

	self:RegisterForDrag("LeftButton", "RightButton")
	self:SetSkinned()
end

function PetButton:PLAYER_ENTERING_WORLD()
	self:UpdateAll()
	self:ApplyBindings()

	self:ScheduleTimer(function() self:UpdateVisibility() end, 1)
end

function PetButton:UNIT_PET(event, unit)
	if unit ==  "player" then
		self:UpdateData()
	end
end

function PetButton:OnDragStart()
	if InCombatLockdown() then
		return
	end

	local drag

	if not self.bar:GetBarLock() then
		drag = true
	elseif self.bar:GetBarLock() == "alt" and IsAltKeyDown() then
		drag = true
	elseif self.bar:GetBarLock() == "ctrl" and IsControlKeyDown() then
		drag = true
	elseif self.bar:GetBarLock() == "shift" and IsShiftKeyDown() then
		drag = true
	else
		drag = false
	end

	if drag then
		self:SetChecked(0)
		PickupPetAction(self.actionID)
		self:UpdateData()
	end

	for i,bar in pairs(Neuron.bars) do
		bar:ACTIONBAR_SHOWHIDEGRID(true)
	end
end


function PetButton:OnReceiveDrag()
	if InCombatLockdown() then
		return
	end

	if GetCursorInfo() == "petaction" then
		self:SetChecked(0)
		PickupPetAction(self.actionID)
		self:UpdateData()
	else
		ClearCursor()
		Neuron:Print(L["DragDrop_Error_Message"])
	end

	for i,bar in pairs(Neuron.bars) do
		bar:ACTIONBAR_SHOWHIDEGRID()
	end
end

-----------------------------------------------------
--------------------- Overrides ---------------------
-----------------------------------------------------

--overwrite function in parent class Button
function PetButton:UpdateData()
	if not self.actionID then
		return
	end

	local spell = GetPetActionInfo(self.actionID)

	self.spell = spell

	if not InCombatLockdown() then
		if spell then
			self:SetAttribute("*macrotext2", "/petautocasttoggle "..spell)
		end
	end

	self:UpdateIcon()
	self:UpdateCooldown()
	self:UpdateStatus()
end

--overwrite function in parent class Button
function PetButton:UpdateIcon()
	if not self.actionID then
		return
	end

	local _, texture, isToken = GetPetActionInfo(self.actionID)

	self.Name:SetText("")
	self.Count:SetText("")

	if texture then
		if isToken then
			self.Icon:SetTexture(_G[texture])
		else
			self.Icon:SetTexture(texture)
		end

		self.Icon:Show()
	else
		self.Icon:SetTexture("")
		self.Icon:Hide()
	end
	--make sure our button gets the correct Normal texture if we're not using a Masque skin
	self:UpdateNormalTexture()
end

--overwrite function in parent class Button
function PetButton:UpdateStatus()
	if not self.actionID then
		return
	end

	local _, _, _, isActive, allowed, enabled = GetPetActionInfo(self.actionID)

	if isActive then
		if IsPetAttackAction(self.actionID) then
			self:GetCheckedTexture():SetAlpha(0.5)
		else
			self:GetCheckedTexture():SetAlpha(1.0)
		end

		self:SetChecked(true)
	else
		self:GetCheckedTexture():SetAlpha(1.0)
		self:SetChecked(false)
	end

	if allowed then
		self.AutoCastable:Show()
	else
		self.AutoCastable:Hide()
	end

	if enabled then
		self.Shine:Show()
		AutoCastShine_AutoCastStart(self.Shine)
		self.AutoCastable:Hide()
	else
		self.Shine:Hide()
		AutoCastShine_AutoCastStop(self.Shine)

		if allowed then
			self.AutoCastable:Show()
		end
	end

	self:UpdateUsable()
end

--overwrite function in parent class Button
function PetButton:UpdateCooldown()
	if self.actionID and GetPetActionInfo(self.actionID) then
		local start, duration, enable, modrate = GetPetActionCooldown(self.actionID)
		self:SetCooldownTimer(start, duration, enable, modrate, self.bar:GetShowCooldownText(), self.bar:GetCooldownColor1(), self.bar:GetCooldownColor2(), self.bar:GetShowCooldownAlpha())
	end
end

--overwrite function in parent class Button
function PetButton:UpdateUsable()
	if Neuron.buttonEditMode or Neuron.bindingMode then
		self.Icon:SetVertexColor(0.2, 0.2, 0.2)
	elseif self.actionID and GetPetActionSlotUsable(self.actionID) then
		self.Icon:SetVertexColor(1.0, 1.0, 1.0)
	else
		self.Icon:SetVertexColor(0.4, 0.4, 0.4)
	end
end

--overwrite function in parent class Button
function PetButton:UpdateTooltip()
	--if we are in combat and we don't have tooltips enable in-combat, don't go any further
	if InCombatLockdown() and not self.bar:GetTooltipCombat() then
		return
	end

	if self.bar:GetTooltipOption() ~= "off" and GetPetActionInfo(self.actionID) then
		GameTooltip:SetOwner(self, "ANCHOR_RIGHT")
		if self.bar:GetTooltipOption() == "normal" then
			GameTooltip:SetPetAction(self.actionID)
		elseif self.bar:GetTooltipOption() == "minimal" then
			GameTooltip:SetText(self.spell)
		end
		GameTooltip:Show()
	end
end

--overwrite function in parent class Button
function PetButton:UpdateVisibility(show)
	if (self.bar:GetShowGrid() and IsPetActive()) or (self.actionID and GetPetActionInfo(self.actionID) and IsPetActive()) or show then
		self.isShown = true
	else
		self.isShown = false
	end
	Neuron.Button.UpdateVisibility(self) --call parent function
end