combatindicator.lua

--[[
# Element: Combat Indicator

Toggles the visibility of an indicator based on the unit's combat status.

## Widget

CombatIndicator - Any UI widget.

## Notes

A default texture will be applied if the widget is a Texture and doesn't have a texture or a color set.

## Examples

    -- Position and size
    local CombatIndicator = self:CreateTexture(nil, 'OVERLAY')
    CombatIndicator:SetSize(16, 16)
    CombatIndicator:SetPoint('TOP', self)

    -- Register it with oUF
    self.CombatIndicator = CombatIndicator
--]]

local _, ns = ...
local oUF = ns.oUF
local Private = oUF.Private

local function Update(self, event, unit)
	if(not unit or self.unit ~= unit) then return end
	local element = self.CombatIndicator

	--[[ Callback: CombatIndicator:PreUpdate()
	Called before the element has been updated.

	* self - the CombatIndicator element
	--]]
	if(element.PreUpdate) then
		element:PreUpdate()
	end

	local inCombat = UnitAffectingCombat(unit)
	if(inCombat) then
		element:Show()
	else
		element:Hide()
	end

	--[[ Callback: CombatIndicator:PostUpdate(inCombat)
	Called after the element has been updated.

	* self     - the CombatIndicator element
	* inCombat - indicates if the unit is affecting combat (boolean)
	--]]
	if(element.PostUpdate) then
		return element:PostUpdate(inCombat)
	end
end

local function Path(self, ...)
	--[[ Override: CombatIndicator.Override(self, event)
	Used to completely override the internal update function.

	* self  - the parent object
	* event - the event triggering the update (string)
	--]]
	return (self.CombatIndicator.Override or Update) (self, ...)
end

local function ForceUpdate(element)
	return Path(element.__owner, 'ForceUpdate')
end

local function Enable(self, unit)
	local element = self.CombatIndicator
	if(element) then
		element.__owner = self
		element.ForceUpdate = ForceUpdate

		Private.SmartRegisterUnitEvent(self, 'UNIT_FLAGS', self.unit, Path)

		if(element:IsObjectType('Texture') and not element:GetTexture()) then
			element:SetAtlas('UI-HUD-UnitFrame-Player-CombatIcon')
		end

		return true
	end
end

local function Disable(self)
	local element = self.CombatIndicator
	if(element) then
		element:Hide()

		self:UnregisterEvent('UNIT_FLAGS', Path)
	end
end

oUF:AddElement('CombatIndicator', Path, Enable, Disable)