魔兽世界插件开发 插件教程 插件编写 Table Of Contents TOC文件介绍
更多信息请关注:鸿石散人
TOC : Table Of Contents . 插件的清单文件。它包含了关于插件的特定信息,如名称,描述,存储,环境,插件文件的加载顺序。
TOC 文件必须存在,否则魔兽客户端不能识别。
TOC 文件名称必须和插件目录名称一致。
TOC 文件格式- TOC文件内容以行为执行单元
- 以“#”开头的行: 注释行 加载时会被忽略
- 以“##”开头的行:标记行 提供有关 AddOn 的元数据
- 非# 和 ## 的行: 文件行 提供顺序加载的文件的名称
- 每行最多读取前 1024 个字符。其他字符将被忽略,不会导致错误。
- 文件行中的文件可使用相对路径,相对路径起始值是TOC文件的路径。
- 文件行引用的是 Lua 文件和 XML 文件。
- LUA和XML文件的编写顺序也是加载的加载顺序,靠前的文件先加载。
#注释行,提供解释和说明
## Interface: 20504
fn.lua
fn.xml
fd.lua
Interface 接口号
指定插件的客户端接口版本。必须与客户端版本匹配,否则提示“加载过期插件”。
## Interface: 20504
TITLE 标题
指定插件显示的名称。可以使用本地化依据客户端进行改变。同时支持 UI转义。
#如果不定义 直接使用插件名称进行显示
#正常设置
## Title: 空插件
#国际化设置
## Title-zhCN: 国际化空插件
#文本支持UI转义改变颜色
## Title: |cFFFF0000空|cFF00FF00插|cFF0000FF件|r|r|r
Notes 描述
鼠标悬停于插件列表的项目上时,显示的插件描述。同TITLE 的设置内容相同。
#正常设置
## Notes: 空插件
#国际化设置
## Notes-zhCN: 国际化空插件
#文本支持UI转义改变颜色
## Notes: |cFFFF0000空|cFF00FF00插|cFF0000FF件|r|r|r
RequiredDeps 或者 "Dep"开头的
依赖插件,依赖插件加载成功才加载本插件,如果有一个依赖未加载本插件也不会加载,依赖的插件可以为多个并且以英文逗号为分隔。
#RequiredDeps
## RequiredDeps: EmAddOns,EmpAddOns
#Dep...开头的任何名字
#Dep 代表 Dependencies
## DepEmap: EmAddOns
OptionalDeps
可选依赖插件,在本插件之前加载,没有加载的情况下本插件也能正常运行。写法同依赖插件一样
## OptionalDeps : EmAddOns
LoadOnDemand
延时加载、动态加载、按需加载,命令加载都可以叫。如果为0则表示直接加载。
如果为1,用户首次登陆时不加载本插件,但是登陆后可由其他插件加载。默认为0直接加载。
## LoadOnDemand: 1
LoadWith
值为插件名称列表,以逗号分割, 当LoadOnDemand=1时列表中的任意一个插件加载完成之后,本插件也会进行加载。
## LoadWith: EmAddOns,Em1AddOns
LoadManagers
值为插件名称列表,以逗号分割。配置的插件都不存在,用户第一次登陆时会加载本插件。如果有一个存在,那么本插件将按照LoadOnDemand设置为1的情况处理。
## LoadWith: EmAddOns,Em1AddOns
SavedVariables
以逗号分割的变量名称列表,变量的值对同一战网账户是通用的。在ADDON_LOADED事件触发之前不可用。
#存储路径:安装目录\_classic_\WTF\Account\战网名称\SavedVariables
## SavedVariables: emptyGVar
SavedVariablesPerCharacter
类似SavedVariables,以每个角色保存各自的变量值,也就是说SavedVariables适合保存通用配置,SavedVariablesPerCharacter适合保存个人配置。
#存储路径:安装目录\_classic_\WTF\Account\战网名称\服务器\角色\SavedVariables
## SavedVariablesPerCharacter: emptyLVar
DefaultState
插件首次安装默认是否开启,如果设置成 “disabled”,那么只有在插件列表中勾选本插件后,才会被加载。默认值 “enabled”。
World of Warcraft\_classic_\WTF\Account\战网账号\服务器\角色名\AddOns.txt
这个文件会保存手动操作插件列表后的状态,如果有值就会忽略DefaultState的配置
## DefaultState: enabled
Secure
如果此标签的值为 1,并且插件由暴雪进行了数字签名,其代码被认为是安全的。
Author
作者名字
Version
插件自身的版本号
元数据标签
插件允许在TOC 文件里增加带有“X-”前缀的元数据。他可以在查询运行时(通过 GetAddOnMetadata 函数)得到
##X-x : 1
##X-y : 10
##X-itme : item
y = GetAddOnMetadata("EmptyAddOns","X-y")
print(y)
#魔兽世界# #魔兽世界插件# #魔兽世界插件开发#
,