FreeKill/docs/api/core/package.rst
notify a1ae83c562
Sphinx doc (#86)
将文档系统改成Sphinx,并增加了新CI
2023-03-26 17:32:45 +08:00

25 lines
944 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Package
==============
.. lua:autoclass:: Package
详细信息
~~~~~~~~~~~~~~
.. _extension name:
``extensionName`` 指的是这个Package所属的mod的名称。
一般来说一个mod即packages/下面的一个文件夹只含有一个拓展包典型的例子就是fk自带的几个拓展包。FreeKill在寻找武将的图片、配音等素材的时候就会根据这个mod的名字去寻找。
在大多数情况下Package的名字和mod的名字都是一致的默认情况下也是如此但有时候一个mod可能会含有好几个拓展包比如神话再临mod里面就含有不少拓展包这时候就要手动把extensionName设为mod的名字。以下是定义风包的代码
.. highlight:: lua
::
local extension = Package:new("wind")
extension.extensionName = "shzl"
这段代码定义了名为wind的拓展包但是他所属的mod文件夹名是shzl所以需要手动指定。