WOW插件编写快速入手指南

程序员快速入手指南

作者：炽火Zero ℃

原文发表于：猫扑魔兽板块实用资料区

引言

本文将以一般的软件编程的眼光审视魔兽插件。剥去其难解的外皮，让你有个清晰的大致了解。

“一针见血”是技术性教学文章的最高境界——炽火

魔兽插件的架构

插件工程——每个插件就是一个项目(或称为工程)。目录位置：魔兽目录\Interface\Addons\项目名\

工程描述——即后缀名为Toc的文件。描述工程的必要信息，也是项目载入时的总入口。

屏幕布局——布局描述使用XML文件。使用各种标签代表特定对象(控件)，并描述相互位置及各种特征属性。

功能脚本——脚本文件使用LUA语言。使用WoW提供的API函数编写代码实现各种具体操作。

TOC ——工程描述文件

后缀名为toc的文件就是工程文件，包含工程的基本信息。主要包含以下内容：

切换行号显示

1 ##Interface:适用的魔兽版本号

2 ##Title:显示的标题（默认语言）

3 ##Notes:显示的说明（默认语言）

4 ##Title-zhCN:特定语言的标题（简体中文）

5 ##Notes-zhCN:特定语言的说明（简体中文）

6 ## Author: 作者（不显示）

7 ## Version: 版本

8 ## eMail: 如题

9 ## UIType: 插件类型

10 ##Dependencies:依赖的插件

11 ##RequiredDeps:必须依赖的其他插件

12 ##OptionalDeps:可选倚赖

13 ##SavedVariables:统一存放的变量

14 ##SavedVariablesPerCharacter:按角色存放的变量

15 ##LoadOnDemand: 1 （调用时加载）

16 ##LoadWith:当指定插件加载时才加载，前提是调用时加载

17 ##DefaultState: disabled 默认状态

18 ##Secure:安全（功能未知）

19 # 注释1 dklasjfkasdj

20 Script.lua -- 脚本文件

21 % 注释2 dskajfklasdjfklsdaj

22 Layout.xml -- 布局文件

?‘#’和‘%’为行注释符号。

?而以##开头的注释行可就不光是好看的了，这些都是插件的工程描述标记，要是不注意插件根本就不会载入。

?示例中彩色的标记表示标准标记，每个标准标记都有特定功能。其它eMail, Author等为扩展标记，只有注释功能。

?工程标记之后的部分为包含文件列表，脚本文件和布局文件，数量随意，但每种至少要有一个：一个lua或一个xml。

包含文件列表中的顺序对应着载入顺序，非常要紧！！！！

如果要写中文，一定要将toc文件保存为UTF-8格式，否则无法正确识别。方法很简单：用记事本打开，另存为，选择编码就行；文件格式要选所有文件，否则会存成txt文件。

建议你多下几个插件，打开看看，参考一下。

XML ——屏幕布局描述文件

在魔兽插件中使用XML来描述UI的屏幕布局。

?注释符号： 。

?如果要写中文注释，必须在XML文件开头添加一行：

encoding="UTF-8"?>

XML文件主要内容

一个XML文件往往包含以下内容：

Ui标签

是最上级标签。其中的schema用来语法检查，如果你的XML编辑器支持还可以用来代码提示。否则对我们来说用处不大。可以简化为：

或者更加简化，不太规范但是可用：布局内容

Script标签

在Ui标签中最先包含的往往是