API_VERSION

Contents

• Overview
  • Add-On Authors
  • Skin Authors
• Updates

Overview

The API_VERSION indicates the current version of Masque's API. This will increase as Masque receives API updates and may increase with game client updates to keep track of important client-side API changes.

Add-On Authors

As an add-on author, the primary purpose of the API_VERSION is to ensure that users are using a version of Masque that is compatible with your add-on. Like most libraries, the API_VERSION can be retrieved when calling Masque's API through LibStub.

Example

local MSQ, MSQ_Version = LibStub("Masque", true)

Skin Authors

As a skin author, the primary purpose of the API_VERSION is to let Masque know that your skin is compatible with the latest version of the API. In newer versions of Masque, the compatibility level of your skin will be indicated in the "About" panel of Masque's GUI. In a skin, the API_VERSION is declared through the an attribute of the same name, as shown below.

Example

MSQ:AddSkin("MySkin", {
  API_VERSION = 100000,
  -- Skin code
}, true)

Notes

• As of API_VERSION 90002, the Masque_Version attribute has been deprecated in favor of API_VERSION to maintain consistency.

Updates

The latest API_VERSION can be found on the project page, in Masque.lua or in the "About" panel of Masque's GUI. It's also worth noting that any changes to the current API_VERSION will be listed in the CHANGELOG.md file and the History page, along with a list of API changes.