Move page script: Move page script moved page USERAPI SetAddOnDetail to WoW:USERAPI SetAddOnDetail without leaving a redirect

2023-08-15T04:49:14Z

Move page script moved page USERAPI SetAddOnDetail to USERAPI SetAddOnDetail without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

WoWWiki>Norganna: Creation of the user API function SetAddOnDetail

2008-10-09T23:08:41Z

Creation of the user API function SetAddOnDetail

New page

{{userapi}}

The intent of this page is to provide a simple, consistent API for modular AddOn inclusions to register their details. Currently in WoW, there are functions to query details of loaded AddOns. However for embedded AddOns, they don't appear anywhere. Any addons that are interested in registering their details are asked to call the following function, and any addons that are interested in what addons are loaded are asked to hook the following function:

SetAddOnDetail(name, detail)

== Parameters ==
=== Arguments ===

:;name : String - The name of the AddOn being defined (should be the same as the name would be if running standalone)
:;detail : Table - Contains the detail for the various pieces of detail about the addon.

==== The detail table structure ====
The detail table contains optional pieces of information in the same meaning and sense that they are used in the [[The TOC Format|TOC File]] (except in lowercase), including but not limited to:

:;version : The version of the AddOn.
:;title : This text is what is displayed in the AddOns list located during user selection.
:;notes : The message that appears under the AddOn name when you mouseover the name of the AddOn in the WoW AddOns list.

== Hooking Procedure ==
For addons that want to monitor the submitted details, the following code is the recommended procedure to create the function:

<nowiki>
-- Define a blank stub if the function doesn't exist.
if not _G['SetAddOnDetail'] then
_G['SetAddOnDetail'] = function(name, detail) end
end

-- Define my functions to process the information.
local myRegistry = {}
local function myAddOnDetail(name, detail)
myRegisty[name] = detail
end

-- Post hook the global SetAddOnDetail function.
hooksecurefunc("SetAddOnDetail", myAddOnDetail)</nowiki>

== Example Code ==
The following code snippets illustrate how to register your AddOn's details via the SetAddOnDetail function.

<nowiki>
if SetAddOnDetail then
SetAddOnDetail("myAddOn", {
version = "1.0",
title = "My AddOn",
notes = "An addon to demonstrate the use of the SetAddOnDetail() function",
})
end</nowiki>

== Addons ==

This function is implemented by the following addons:
* Swatter of the [[Auctioneer (AddOn)|Auctioneer]] [[AddOns]] by [http://auctioneeraddon.com/ The Auctioneer AddOns Team].

AddOns using this function:
* All of the [[Auctioneer (AddOn)|Auctioneer]] [[AddOns]] by [http://auctioneeraddon.com/ The Auctioneer AddOns Team].

WoW:USERAPI SetAddOnDetail - Revision history

Move page script: Move page script moved page USERAPI SetAddOnDetail to WoW:USERAPI SetAddOnDetail without leaving a redirect

WoWWiki>Norganna: Creation of the user API function SetAddOnDetail