PitBull Unit Frames 4.0

API / ModuleHandling

  • 7 pages found
NameAuthorLast updated byUpdated on
NameAuthorLast updated byUpdated on
CustomModule ckknight ckknight Sep 16, 2013
CustomModule:ClearFrame(frame) Does nothing. This should be implemented by the module. When implementing, this should return whether :UpdateLayout(frame) should be called. Parameters frame the Unit Frame to update Usage local update_layout = MyModule:ClearFrame(frame) CustomModule:OnHide(frame) Handle the frame being hidden Parameters frame the Unit Frame hidden. Usage MyModule:OnHide(frame) CustomModule:UpdateFrame(frame) Does nothing. This should be implemented by the module. When...
CustomTextModule ckknight ckknight Sep 16, 2013
CustomTextModule:ClearFrame(frame) Does nothing. This should be implemented by the module. When implementing, this should return whether :UpdateLayout(frame) should be called. Parameters frame the Unit Frame to update Usage local update_layout = MyModule:ClearFrame(frame) CustomTextModule:GetFont(frame) Return the font and size to use for the given frame. Parameters frame the unit frame Return values the font path the font size Usage local font, size = MyModule:GetFont(some_frame)...
TextProviderModule ckknight ckknight Sep 16, 2013
TextProviderModule:ClearFrame(frame) Clear the texts for the current module if it exists. Parameters frame the Unit Frame to clear Return value whether the update requires :UpdateLayout to be called Usage local update_layout = MyModule:ClearFrame(frame) TextProviderModule:ForceTextUpdate(frame) Forces all texts for the frame to be rebuilt. Parameters frame the Unit Frame to update Usage MyModule:ForceTextUpdate(frame) Used to force all the texts to be cleared and rebulit. Particularly after a...
FaderModule ckknight ckknight Sep 16, 2013
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...
IndicatorModule ckknight ckknight Sep 16, 2013
IndicatorModule:ClearFrame(frame) Clear the indicator for the current module if it exists. Parameters frame the Unit Frame to clear Return value whether the update requires :UpdateLayout to be called Usage local update_layout = MyModule:ClearFrame(frame) IndicatorModule:GetFont(frame) Return the font and size to use for the given frame. Parameters frame the unit frame Return values the font path the font size Usage local font, size = MyModule:GetFont(some_frame)...
BarModules ckknight ckknight Sep 16, 2013
BarModule:ClearFrame(frame) Clear the status bar for the current module if it exists. Parameters frame the Unit Frame to clear Return value whether the update requires :UpdateLayout to be called Usage local update_layout = MyModule:ClearFrame(frame) BarModule:GetTexture(frame) Return the texture path to use for the given frame. Parameters frame the unit frame Return value the texture path Usage local texture = MyModule:GetTexture(some_frame) some_frame.MyModule:SetTexture(texture)...
Module ckknight ckknight Sep 16, 2013
Module:AddFrameScriptHook(script, method, func) Add a script hook for the unit frames. Parameters script name of the script method func function to call or method on the module to call Usage MyModule:AddFrameScriptHook("OnEnter", function(frame) -- do stuff here end) Module:Clear(frame, return_changed) Clear the frame for the current module for the given frame and handle any layout changes. Parameters frame the Unit Frame to clear return_changed whether to return if the clear should change...
  • 7 pages found