PitBull Unit Frames 4.0

API / GroupHeader

GroupHeader:ForceUnitFrameCreation()

Force unit frames to be created on the group header, even if those units don't exist.

Usage

header:ForceUnitFrameCreation()


GroupHeader:InitialConfigFunction(frame)

Initialize a member frame.
This should be called once per member frame immediately following the frame's creation.

Parameters

frame

Usage

header:InitializeConfigFunction(frame)


GroupHeader:RefixSizeAndPosition()

Reset the size and position of the group header.
More accurately, the scale and the position since size is set dynamically.

Usage

header:RefixSizeAndPosition()


GroupHeader:RefreshGroup(dont_refresh_children)

Recheck the group-based settings of the group header, including sorting, position, what units are shown.

Parameters

dont_refresh_children
don't call :RefreshLayout on the child frames

Usage

header:RefreshGroup()


GroupHeader:RefreshLayout(dont_refresh_children)

Recheck the layout of the group header, refreshing the layout of all members.

Parameters

dont_refresh_children
don't call :RefreshLayout on the child frames

Usage

header:RefreshLayout()


GroupHeader:Update()

Force an update on the group header.
This is just a wrapper for SecureGroupHeader_Update.

Usage

header:Update()


GroupHeader:UpdateMembers(...)

Send :Update to all member frames.

Parameters

...

Usage

header:UpdateMembers(true, true)


MemberUnitFrame:RefixSizeAndPosition()

Reset the size of the unit frame, not position as that is handled through the group header.

Usage

frame:RefixSizeAndPosition()


PitBull4:ConvertIntoGroupHeader(header, frame)

Add the proper functions and scripts to a SecureGroupHeaderTemplate or SecureGroupPetHeaderTemplate, as well as some initialization.

Parameters

header
frame
a Frame which inherits from SecureGroupHeaderTemplate or SecureGroupPetHeaderTemplate

Usage

PitBull4:ConvertIntoGroupHeader(header)


PitBull4:MakeGroupHeader(group)

Make a group header.

Parameters

group
the name for the group. Also acts as a unique identifier.

Usage

local header = PitBull4:MakeGroupHeader("Monkey")


PitBull4:SwapGroupTemplate(group)

Swap the group from a Normal and Pet Group Header.

Parameters

group
the name for the group.

Usage

PitBull4:SwapGroupTemplate("Monkey")
Note that the use_pet_header setting for the group_db is expected to already
be set to the value you're going to.


You must login to post a comment. Don't have an account? Register to get one!