UnitAffectingCombat

[Kendian]

Is there any way to show/hide a panel based on whether target is in combat? I've looked around, but am not sure UnitAffectingCombat is the function I'm looking for. My thanks, for any/all help. in advance~

[zork]

local addon = CreateFrame("Frame")
 
local function checkStatus()
  local f = _G["NameOfFrameToTrack"]
  if InCombatLockdown() then
    f:Hide() --hide in combat  
  else
    f:Show() --show out of combat
  end
end
 
--out of combat
function addon:PLAYER_REGEN_ENABLED(...)
  checkStatus()
end
 
--in combat
function addon:PLAYER_REGEN_DISABLED(...)
  checkStatus()
end
 
--call func based on event
addon:SetScript("OnEvent", function(self, event, ...)
  self[event](...)
end)
 
--register events
addon:RegisterEvent("PLAYER_REGEN_ENABLED")
addon:RegisterEvent("PLAYER_REGEN_DISABLED")

[Kendian]

Simply brilliant, Zork. My thanks~

[Phanx]

InCombatLockdown() does not return true immediately when PLAYER_REGEN_DISABLED fires; this is intentional, so that addons have time to do stuff with secure frames when the player enters or exits combat, so your code may not always work as desired. UnitAffectingCombat("player") would be a more reliable check.

There's also no reason to do a _G lookup when you already have the frame's global name. Just run NameOfFrameToTrack:Show() instead of _G["NameOfFrameToTrack"]:Show(), and save the extra lookup.

You may also want to register PLAYER_ENTERING_WORLD.

I'd change/simplify the whole thing to:

local addon = CreateFrame("Frame")

--register events
addon:RegisterEvent("PLAYER_ENTERING_WORLD")
addon:RegisterEvent("PLAYER_REGEN_DISABLED")
addon:RegisterEvent("PLAYER_REGEN_ENABLED")

-- call func based on event
addon:SetScript("OnEvent", function(self, event, ...)
	if UnitAffectingCombat("player") then
		-- in combat combat
		NameOfFrameToTrack:Hide()
	else
		-- not in combat combat
		NameOfFrameToTrack:Show()
	end
end)

If you're using this in kgPanels, change "addon" to "self", put the RegisterEvent lines in the OnLoad section for the panel, and everything inside the OnEvent script function in the OnEvent section for the panel.

[zork]

InCombatLockdown() does not return true immediately when PLAYER_REGEN_DISABLED fires; this is intentional, so that addons have time to do stuff with secure frames when the player enters or exits combat, so your code may not always work as desired. UnitAffectingCombat("player") would be a more reliable check.

Good to know that.

[Haleth]

Is it at all necessary to use UnitAffectingCombat()? I just do this, normally

local addon = CreateFrame("Frame")

--register events
addon:RegisterEvent("PLAYER_REGEN_DISABLED")
addon:RegisterEvent("PLAYER_REGEN_ENABLED")

-- call func based on event
addon:SetScript("OnEvent", function(self, event, ...)
	if event == "PLAYER_REGEN_DISABLED" then
		-- in combat
		NameOfFrameToTrack:Hide()
	else
		-- not in combat
		NameOfFrameToTrack:Show()
	end
end)

[oomp]

Originally Posted by Haleth Is it at all necessary to use UnitAffectingCombat()? I just do this, normally local addon = CreateFrame("Frame") --register events addon:RegisterEvent("PLAYER_ENTERING_WORLD") addon:RegisterEvent("PLAYER_REGEN_DISABLED") addon:RegisterEvent("PLAYER_REGEN_ENABLED") -- call func based on event addon:SetScript("OnEvent", function(self, event, ...) if event == "PLAYER_REGEN_DISABLED" then -- in combat NameOfFrameToTrack:Hide() else -- not in combat NameOfFrameToTrack:Show() end end)

I assume you simply forgot to omit the addon:RegisterEvent("PLAYER_ENTERING_WORLD") line? Otherwise, the frame will be shown when PLAYER_ENTERING_WORLD fires, as well as PLAYER_REGEN_ENABLED.

[Haleth]

That line isn't needed in this example yes, unless you do other things with your frame and require it to show on PLAYER_ENTERING_WORLD anyway. My question is if UnitAffectingCombat() is needed when the event fired already tells you whether you're in or out of combat.

[Phanx]

If you are only registering for PLAYER_REGEN_DISNABLED and PLAYER_REGEN_ENABLED, then no, you do not need to check UnitAffectingCombat.