WOW插件的构成和使用

今天来说一说wow插件是个什么鬼？

插件是魔兽世界开放的第三个接口，有朋友会问，什么是第三方？这个是软件业的一个术语，简单的说，就是游戏当中能让我们自己来定制DIY的部分，比方说对话界面，还有一些数据显示之类的功能。

wow的插件全部保存在World of Warcraft/Interface/AddOns目录下，在这个目录下会有一些暴雪自带的功能插件，它们均是以Blizzard_开头的，我们自己做的插件可以随意命名，不同插件可以分别放在不同的文件夹下面（我们在做插件的过程中，强烈建议用英文命名，避免因为中文导致插件无法被识别的问题）。http://www.townlong-yak.com/framexml/这个网址可以下载暴雪自带插件。

说一下插件的构成，打开插件目录，你会发现大致会有三种类型文件，分别是toc文件，xml文件和lua文件。

toc文件

这个文件是一个必要文件，它的名字与你的插件文件夹名字同名，只不过带了一个后缀toc，如果不同名的话，打开魔兽客户端将会无法识别你的插件；

注意！！！这个文件的每行开头不能有空格，每行仅作一个说明。

用文本工具打开toc文件，内容说明分三种类型：

以##开头的数据

用来进行插件描述，一般会有插件名称，作者名称，功能描述等；它的基本格式是

## 标签名：标签值

标签的名字可以随便写，但是有一些wow自带的标签名我们进行一下解释：

Interface:标记插件可用在的wow游戏版本，当该值小于低于当前游戏版本插件不会被加载；Title:插件名称，这个会被显示在游戏选择人物的插件列表里；Title-zhCN:插件的中文显示，如果想要在其他语言中显示，则修改-后面的就可以了；下面的Notes也是如此；Notes:插件列表中，鼠标移到插件名上时显示的信息；RequiredDeps, Dependencies, 或者任意以 “Dep” 开始的字符串：表示我们当前的插件必须需要加载的其他插件；OptionalDeps:与上面的对照，这里的插件是可选的；LoadOnDemand:值为1时，表示这个插件不会在游戏开始就加载，而是在需要的时候才加载；LoadWith:如果上面的值为1时，本条所描述的插件会随着本插件一起加载；LoadManagers:本条中所描述的插件如果都不存在的话，则会自动加载本插件；如果有一个存在，则按LoadOnDemand值为1处理；SavedVariables:一些以逗号分割的变量名称，这些变量会被保存在硬盘上，下次加载时可以被读取到；SavedVariablesPerCharacter:与上面的标签是相同的作用，不过该标签只用于保存不同角色的不同配置；DefaultState:本插件默认开启状态，值为disabled/enabled；Author:作者名字Version:插件的版本号

另外你可以定义自己的标签，以上中最重要的就是前两个，尽量不要出错；

本插件需要加载的代码文件

列出需要加载的代码类文件，只支持lua和xml两种格式，这里的文件需要给出以当前目录为根目录的文件完整路径，就是说如果你插件目录下有一个myaddon.lua的文件则需要添加：

myaddon.lua

而如果你插件目录下有一个子文件夹MyAddon，而该目录下有一个myaddon2.lua的话，则需要添加：

​MyAddon/myaddon2.lua以#开头的文件

这些是注释文本，在toc中可以随便添加，主要用作插件制作者自己记录，这些不会被插件加载；

XML文件

xml文件主要用于插件的界面制作，以及事件绑定，事件绑定通俗的讲就是你对插件做某些操作（按一个按钮之类的）游戏中会出现的事件，这些事件会以一个方法的形式出现在lua文件中，你可以把你自己想做的事情写在这个方法中，如果你学过些编程，应该知道我们这里说的方法就是lua函数；

在你插件的根目录下会有一个叫做Bindings.xml的文件，这个文件会被游戏客户端自动读取，不必写在toc文件中；

我们来看一个该文件的例子：

if IGAS.UIParent.Cube_Main then IGAS.UIParent.Cube_Main.Visible = not IGAS.UIParent.Cube_Main.Visible end if IGAS.UIParent.Cube_Debug then IGAS.UIParent.Cube_Debug.Visible = not IGAS.UIParent.Cube_Debug.Visible end

我们暂时先不要管这些代码的意思，只需要知道这个文件设置了界面元素与游戏事件的绑定，而绑定的事件是由Lua文件完成的；Bindings.xml文件绑定了一个与插件名同名的lua文件，并且还将界面上的元素与该文件所描述的事件绑定在了一起：

— Binding Text _G.BINDING_HEADER_CUBE = L[“Cube”] _G.BINDING_NAME_CUBE_CODE = L[“Simple Dev Tool”] _G.BINDING_NAME_CUBE_DEBUG = L[“Simple Debug Tool”]

我们现在先不要管他们是怎么联系起来的，具体我们在之后的写代码过程中会慢慢讲到，现在只要理解一点，xml会定义我们的界面，并且还可以设置界面元素与事件的绑定，而绑定的事件会交由lua文件处理；

我们还可以加载其他的xml和lua文件，如下例：

其中这间的就是xml文件的标签，标签的类型会由