api/module-handling/FaderModule

FaderModule:ClearFrame(frame)

Remove any opacity value for this module.

Parameters

frame
the Unit Frame to clear

Return value

false, since :UpdateLayout isn't required for this type of module

Usage

MyModule:ClearFrame(frame)


FaderModule:OnHide(frame)

Handle the frame being hidden

Parameters

frame
the Unit Frame hidden.

Usage

MyModule:OnHide(frame)


FaderModule:UpdateFrame(frame)

Update the opacity value for the current module

Parameters

frame
the Unit Frame to update

Return value

false, since :UpdateLayout isn't required for this type of module

Usage

MyModule:UpdateStatusBar(frame)


PitBull4:GetFinalFrameOpacity(frame)

Return how opaque a frame will be once animation completes.

Parameters

frame
the Unit Frame to check.

Return value

a number within [0, 1]

Usage

local opacity = PitBull4:GetFinalFrameOpacity(frame)


call_opacity_function(self, frame, the)

Call the :GetOpacity function on the fader module regarding the given frame.
The lowest opacity from the highest priority module will be used on the frame.

Parameters

self
frame
the frame to get the opacity of
the
module

Return values

  1. opacity nil or a number within [0, 1]
  2. priority nil (treated as zero) or a number

Usage

local opacity, priority = call_opacity_function(MyModule, someFrame)



Comments

Posts Quoted:
Reply
Clear All Quotes