Masque API

Contents

• Overview
• Methods

Overview

Masque's API is a library-style interface that provides authors with access to the Group API and other utility methods for interacting with Masque.

Getting Started

In order to access Masque's API, one must first get a reference to the API via LibStub, as shown below. Note that the LibStub call also returns the latest API_VERSION, in the event that an author needs to target a specific version of Masque.

Example

-- Establish a reference to Masque.
local Masque, MSQ_Version = LibStub("Masque", true)

-- Target a specific version.
if Masque and MSQ_Version >= 100002 then
  -- Do stuff.
end

Methods

The following tables list the methods available to Masque's API along with descriptions of their purpose. For more detailed information about a particular method's usage, visit its reference page by clicking the relevant link.

Group Methods

Method	Description
GetGroupByID	Returns a specific group object and provides access to the Group API.
Group	Creates and/or returns a group object that provides access to the Group API.

Skin Methods

Method	Description
AddSkin	Adds skin data to Masque.
GetDefaultSkin	Returns the name and table of the default skin.
GetSkin	Returns skin data for the specified skin.
GetSkins	Returns a table of all skin data.

Utility Methods

Method	Description
AddSpellAlert	Adds a custom spell alert to Masque.
AddType	Adds a custom button type to Masque.
GetBackdrop	Returns the Backdrop region of a button.
GetGloss	Returns the Gloss region of a button.
GetNormal	Returns the Normal region of a button.
GetShadow	Returns the Shadow region of a button.
GetSlotIcon	Returns the SlotIcon region of a button.
GetSpellAlert	Returns the spell alert textures assigned to a shape.
Register	Registers a callback with Masque.
SetEmpty	Sets the empty state of a button.
UpdateCharge	Updates the ChargeCooldown of a button.
UpdateSpellAlert	Updates the SpellAlert for a button.