查看“Module:Arcaea Data/doc”的源代码

本模块可查询Arcaea数据文件中存在的信息，为元模块，为其他模块提供支持。也提供接口对模块外直接查询。

通过[[模板:Songlist.json]]，[[模板:Songlist NS.json]]，[[模板:Packlist.json]]和[[模板:Unlocks.json]]进行分析以提供数据。

== 面向模块函数 ==
=== singleSongInformation ===
获取一个曲目所有信息，返回值是一个函数。可以通过该函数进行查询。
==== 使用方法 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.singleSongInformation("该曲目的索引值", "索引值的类型，id或name", "查找内容的平台，mobile或ns")
mw.log(query("需要查询的属性的名称"))
</syntaxhighlight>
==== 示例 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.singleSongInformation("ifi", "id", "mobile")
-- 此时query是一个函数，传入需要查询的属性名称返回该属性的值。
mw.log(query("pstChartDesigner"))
-- 输出"夜浪"
</syntaxhighlight>

=== allSongInformation ===
获取任何曲目的任何信息，返回值是一个函数。可以通过该函数进行查询。<br>
和前者比效率略低一点点，查询更不方便（如果只需要查询一个曲目的话）。
==== 使用方法 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.singleSongInformation("索引值的类型，id或name", "查找内容的平台，mobile或ns")
mw.log(query("该曲目的索引值", "需要查询的属性的名称"))
</syntaxhighlight>
==== 示例 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.allSongInformation("id", "mobile")
-- 此时query是一个函数，传入需要查询的属性名称返回该属性的值。
mw.log(query("ifi", "pstChartDesigner"))
-- 输出"夜浪"
</syntaxhighlight>

=== packName===
获传入曲包ID，获得Packlist中的曲包名称，返回值是一个字符串。<br>
果[[Template:Transition.json]]中存在转换，则使用转换后的名称，否则直接传出Packlist中的曲包名称。
==== 使用方法 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.packName
mw.log(query("曲包ID"))
</syntaxhighlight>
==== 示例 ====
<syntaxhighlight lang="lua">
local data = require("Module:Arcaea Data")
local query = data.packName
mw.log(query("vs"))
-- 输出"Black Fate"
</syntaxhighlight>

=== unlockText ===
正在编写中。

== 直接查询函数 ==
已将函数封为[[模板:Arcaea Data]]，可使用封包的模板来查询数据。

=== Song_Query ===
==== 用法 ====
<syntaxhighlight lang="html+handlebars">
{{Arcaea Data|type=Song_Query|索引名称|索引名称类型|属性名称|平台}}
</syntaxhighlight>
==== 示例 ====
<syntaxhighlight lang="html+handlebars">
{{Arcaea Data|type=Song_Query|ifi|id|title|mobile}}
</syntaxhighlight>

=== Pack_Query ===
==== 用法 ====
<syntaxhighlight lang="html+handlebars">
{{Arcaea Data|type=Pack_Query|曲包ID}}
</syntaxhighlight>
==== 示例 ====
<syntaxhighlight lang="html+handlebars">
{{Arcaea Data|type=Pack_Query|vs}}
</syntaxhighlight>

== 属性名列表 ==
* id
* title
* artist
* bpm
* set
* side
* date
* version
* bg
* pstChartDesigner
* pstJacketDesigner
* pstRating
* prsChartDesigner
* prsJacketDesigner
* prsRating
* ftrChartDesigner
* ftrJacketDesigner
* ftrRating
* bydChartDesigner
* bydJacketDesigner
* bydRating
* etrChartDesigner
* etrJacketDesigner
* etrRating
* pstChange
* prsChange
* ftrChange
* bydChange
* etrChange
* bydAudioChange
* bydBPM
* bydArtist
* 新背景参数：如果没有单独指定使用bg
* pstBg
* prsBg
* ftrBg
* bydBg
* etrBg