api/controls/Controls
PitBull4.Controls.MakeAlpha(parent)
Make an Alpha animation object
Parameters
- parent
- animation group the animation is parented to
Return value
an Alpha object
Usage
local anim = PitBull4.Controls.MakeAlpha(self.ag)
PitBull4.Controls.MakeAnimatedTexture(parent, layer)
Make an animated texture
Parameters
- parent
- frame the animated texture is parented to
- layer
- the art layer of the texture
Return value
a AnimatedTexture object
Usage
local texture = PitBull4.Controls.MakeAnimatedTexture(someFrame, "BACKGROUND")
PitBull4.Controls.MakeAnimation(parent)
Make an Animation object
Parameters
- parent
- animation group the animation is parented to
Return value
an Animation object
Usage
local anim = PitBull4.Controls.MakeAnimation(self.ag)
PitBull4.Controls.MakeButton(parent)
Make a Button
Parameters
- parent
- frame the frame is parented to
Return value
a Button object
Usage
local frame = PitBull4.Controls.MakeButton(someFrame)
PitBull4.Controls.MakeCooldown(parent)
Make a Cooldown
Parameters
- parent
- frame the frame is parented to
Return value
a Cooldown object
Usage
local frame = PitBull4.Controls.MakeCooldown(someFrame)
PitBull4.Controls.MakeDressUpModel(parent)
Make a DressUpModel
Parameters
- parent
- frame the frame is parented to
Return value
a PlayerModel object
Usage
local frame = PitBull4.Controls.MakePlayerModel(someFrame)
PitBull4.Controls.MakeFontString(parent, layer)
Make a font string
Parameters
- parent
- frame the font string is parented to
- layer
- the art layer of the font string
Return value
a FontString object
Usage
local fs = PitBull4.Controls.MakeFontString(someFrame, "BACKGROUND")
PitBull4.Controls.MakeFrame(parent)
Make a frame
Parameters
- parent
- frame the frame is parented to
Return value
a Frame object
Usage
local frame = PitBull4.Controls.MakeFrame(someFrame)
PitBull4.Controls.MakeNewControlType(name, frameType, onCreate, onRetrieve, onDelete, inheritTemplate)
Make a new control type
Parameters
- name
- name of your control type
- frameType
- the real frame type to base upon
- onCreate
- function to call when initially creating the control
- onRetrieve
- function to call every time the control is requested
- onDelete
- function to call when the frame is deleted
- inheritTemplate
- the Blizzard template(s) to inherit from
Usage
PitBull4.Controls.MakeNewControlType("BetterStatusBar", "StatusBar", function(control) end, function(control) end, function(control) end)
PitBull4.Controls.MakePlayerModel(parent)
Make a PlayerModel
Parameters
- parent
- frame the frame is parented to
Return value
a PlayerModel object
Usage
local frame = PitBull4.Controls.MakePlayerModel(someFrame)
PitBull4.Controls.MakeTexture(parent, layer)
Make a texture
Parameters
- parent
- frame the texture is parented to
- layer
- the art layer of the texture
Return value
a Texture object
Usage
local texture = PitBull4.Controls.MakeTexture(someFrame, "BACKGROUND")
control:Delete()
Delete a frame, putting it back in the pool to be recycled.
Don't hold onto a frame after you've deleted it, there could be double-free
issues later
Return value
nil
Usage
control = control:Delete()
Comments