听风的插件DIY-04-集成到设置中

在魔兽世界主菜单里有一个界面设置,我们平时在用插件的时候会在里面发一些自定义的插件设置,可能你不是太明白我的意思,Ok!给你一张图就明白了:


Ace工具库

工具源址先放出了,如果你觉得本文内容不足以满足个人学习,那请跳级自行研究。

ACE3

Ace3使用了一个叫做“嵌入式库”的概念,它允许模块开发者在其他模块加载了相同库的时候不需要再复制一份代码。在之后的插件里,我们会重复使用这个概念。

在此,本文所使用的ACE3库的所有代码将全部托管到本人github帐号下的World-Of-Warcraft库中https://github.com/usiege/World-Of-Warcraft.git,读者可自行下载。

本文插件内容请到https://github.com/usiege/Addons.git获取,如有疑问请到公众号留言交流。

我们要开始了

仍旧我们先要编辑.toc文件,这次我们除了一些基本的插件信息,还加入了依赖库。

## Interface: 20300
## Version: 0.1
## Title: 04-集成到系统中
## Author: 听风
## Notes: 整合到ESC插件设置中的内容
## OptionalDeps: Ace3
## X-Embeds: Ace3

embeds.xml
core.lua

这里我们新添加了两个字段:

  • OptionalDeps
    此项为可选的依赖项,也就是说我们的插件可能会用到这些库。可选依赖是当前插件为了实现某些附加功能而依赖的外部库或插件,但如果依赖的东西不存在,那么当前插件也可以正常工作,注意使用可选依赖的插件必须写明当依赖不存在的时候也可以工作。

  • X-Embeds
    这一项是一个说明项,可选标签,如注释掉不会影响插件正常运行。

引入Ace库

接下来我们引入从外部添加进来的Ace库,我们需要从embeds.xml处加载,从上节中的.toc处我们可以看到,它是先于后面的core.lua加载的。
本文的代码我们组织在了core.lua文件中,下节配合图片我们会详细说明。

我们在插件目录下新建embeds.xml文件,以此来加载所需要的库:

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
..\FrameXML\UI.xsd">
    <Script file="Libs\LibStub\LibStub.lua"/>
    <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
    <Include file="Libs\AceAddon-3.0\AceAddon-3.0.xml"/>
    <Include file="Libs\AceEvent-3.0\AceEvent-3.0.xml"/>
    <Include file="Libs\AceDB-3.0\AceDB-3.0.xml"/>
    <Include file="Libs\AceConsole-3.0\AceConsole-3.0.xml"/>
    <Include file="Libs\AceGUI-3.0\AceGUI-3.0.xml"/>
    <Include file="Libs\AceConfig-3.0\AceConfig-3.0.xml"/>
</Ui>

我们会看到又是熟悉的<Ui> </Ui>对,

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
..\FrameXML\UI.xsd">
    <!-- 在这个部分的代码会按顺序加载 -->
</Ui>

这里有一个关于.xml的注释,如上:
``

注释都知道是什么吧?我怕是又要拿出“程序员到餐厅点单子”的梗了:

餐厅中, 程序员A: “我吃鱼香肉丝盖饭, 你吃什么?”
程序员B: “宫保鸡丁盖饭.”
程序员A 在点菜单写上:
鱼香肉丝盖饭 1
宫保鸡丁盖饭 1
程序员B: “我还是要牛肉面吧!”
程序员A 更正点菜单:
鱼香肉丝盖饭 1
// 宫保鸡丁盖饭 1
牛肉面 1

继续上面说的,Script标签表示需要引入的lua文件,Include标签表示要引入的xml文件。需要注意的是LibStub必须先加载,因为其他库都依赖它。其他文件也需要注意使用顺序,原则就是被依赖的库需要先加载。

又要写代码了

外部库加载完之后,接下来我们就要利用这些外部库搞点事情了。我们在插件目录下新建core.lua文件,用以编写本文所有的事件代码。在core.lua之前引入embeds.xml文件,以保证在core.lua执行之前所有的库已被加载并可以使用。

所以我们的文件结构是:

├── 04_InterfaceOptions.toc
├── Libs
│   ├── AceAddon-3.0
│   ├── AceConfig-3.0
│   ├── AceConsole-3.0
│   ├── AceDB-3.0
│   ├── AceEvent-3.0
│   ├── AceGUI-3.0
│   ├── CallbackHandler-1.0
│   └── LibStub
├── README.md
├── core.lua
└── embeds.xml

LibStub有它独有的事件触发机制,我们来逐个说明:

WelcomeHome = LibStub("AceAddon-3.0"):NewAddon("WH", "AceConsole-3.0")

首先这一行构成了本节插件的最基本语句,它是由LibStub这个类加载AceAddon-3.0库文件,来初始化出新的插件的。

新加载的插件被我们命名为了WH,我们使用NewAddon方法创建一个AceAddon类的实例,因为我们会用到聊天窗口和斜杠命令,我们还混入了AceConsole类。

新产生的变量WelcomeHome是一个luatable变量,它构成了一个类,该类的三个方法分别会在不同情况下调用。OnInitialize只会在UI加载的时候执行一次,后面两个分别在插件被启用和禁用的时候执行。

function WelcomeHome:OnInitialize()
    -- Called when the addon is loaded
    self.Print("这里是插件初始化 等待完成")
end

OnInitialize方法在插件加载时调用,由于该函数只会调用一次,所以我们一般会在这个方法内做一些插件初始化的工作。

function WelcomeHome:OnEnable()
    -- Called when the addon is enabled
    self:Print("04_InterfaceOptions 启用")
end

OnEnable方法在加载时,我们想要通过一句打印来知道插件的确是在运行状态,上代码,我们会输出一串提示文字。

注意OnInitialize是要先于OnEnable的。

function WelcomeHome:OnDisable()
    -- Called when the addon is disabled
    -- 这个我们暂时还用不上
end

本文的重点来了

所以我们是如何在系统设置里面加上一项新的设置的呢?

毫无疑问是我们的代码增加了这一项,所以我们之前是这个亚子的:

但是当我们在OnInitialize中添加了:

self.optionsFrame = LibStub("AceConfigDialog-3.0"):AddToBlizOptions("WH", "Welcome Home")

上面这一句,插件设置出现了:

我们为新创建的叫做WH的插件添加了一个叫做Welcome Home的设置项,且它的名称显示在了设置项的上方,如上图。

总结

有了这个我们就了解到了插件设置只是更直观的使我们使用插件提供的功能,我们在自己DIY插件的时候可以把系统代码转化为可视化的内容,这样就可以使插件功能与代码分离,减少对修改代码的依赖。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容

  • 指令集 lua_capture_error_log lua_use_default_type lua_malloc...
    吃瓜的东阅读 11,971评论 0 2
  • 当你是一炉炭火,又旺又热的时候,人都聚到你旁边取暖,炭火燃烬时,都拍拍屁股,走人了。 你混得好了,看到的都是热情、...
    行者小鹤阅读 797评论 1 1
  • 大家好 初次见面 就来个自我介绍吧 我叫 sanita 香港人 人目前在意大利 今天要回巴黎了 现在机场打发打发时...
    sanita阅读 213评论 3 1
  • 侄女今年高考,成绩不理想,没有选到合适的专业,最终决定走复读这条路。 复读对于很多刚高三毕业的孩子来说,有很多的无...
    ccjl西西阅读 208评论 0 0
  • 问心无愧,方能无愧于心。 无愧于心,方能无惧于世。 无惧于世,方能勇往直前。 勇往直前,方能有始有终, 有始有终,...
    安白丿阅读 153评论 0 0